Package io.github.cdklabs.projen.javascript

Interface PrettierSettings

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    PrettierSettings.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.200Z")
@Stability(Experimental)
public interface PrettierSettings
extends software.amazon.jsii.JsiiSerializable
    (experimental) Options to set in Prettier directly or through overrides.

    See Also:
    https://prettier.io/docs/en/options.html

    • Method Detail

      • getArrowParens

        @Stability(Experimental)
@Nullable
default ArrowParens getArrowParens()
        (experimental) Include parentheses around a sole arrow function parameter.

        Default: ArrowParens.ALWAYS

      • getBracketSameLine

        @Stability(Experimental)
@Nullable
default Boolean getBracketSameLine()
        (experimental) Put > of opening tags on the last line instead of on a new line.

        Default: false

      • getBracketSpacing

        @Stability(Experimental)
@Nullable
default Boolean getBracketSpacing()
        (experimental) Print spaces between brackets.

        Default: true

      • getCursorOffset

        @Stability(Experimental)
@Nullable
default Number getCursorOffset()
        (experimental) Print (to stderr) where a cursor at the given position would move to after formatting.

        This option cannot be used with --range-start and --range-end.

        Default: -1

      • getEmbeddedLanguageFormatting

        @Stability(Experimental)
@Nullable
default EmbeddedLanguageFormatting getEmbeddedLanguageFormatting()
        (experimental) Control how Prettier formats quoted code embedded in the file.

        Default: EmbeddedLanguageFormatting.AUTO

      • getEndOfLine

        @Stability(Experimental)
@Nullable
default EndOfLine getEndOfLine()
        (experimental) Which end of line characters to apply.

        Default: EndOfLine.LF

      • getFilepath

        @Stability(Experimental)
@Nullable
default String getFilepath()
        (experimental) Specify the input filepath.

        This will be used to do parser inference.

        Default: none

      • getHtmlWhitespaceSensitivity

        @Stability(Experimental)
@Nullable
default HTMLWhitespaceSensitivity getHtmlWhitespaceSensitivity()
        (experimental) How to handle whitespaces in HTML.

        Default: HTMLWhitespaceSensitivity.CSS

      • getInsertPragma

        @Stability(Experimental)
@Nullable
default Boolean getInsertPragma()
        (experimental) Insert.

        Default: false

      • getJsxSingleQuote

        @Stability(Experimental)
@Nullable
default Boolean getJsxSingleQuote()
        (experimental) Use single quotes in JSX.

        Default: false

      • getParser

        @Stability(Experimental)
@Nullable
default String getParser()
        (experimental) Which parser to use.

        Default: - Prettier automatically infers the parser from the input file path, so you shouldn’t have to change this setting.

      • getPlugins

        @Stability(Experimental)
@Nullable
default List<String> getPlugins()
        (experimental) Add a plugin.

        Multiple plugins can be passed as separate --plugins.

        Default: []

      • getPluginSearchDirs

        @Stability(Experimental)
@Nullable
default List<String> getPluginSearchDirs()
        (experimental) Custom directory that contains prettier plugins in node_modules subdirectory.

        Overrides default behavior when plugins are searched relatively to the location of Prettier. Multiple values are accepted.

        Default: []

      • getPrintWidth

        @Stability(Experimental)
@Nullable
default Number getPrintWidth()
        (experimental) The line length where Prettier will try wrap.

        Default: 80

      • getProseWrap

        @Stability(Experimental)
@Nullable
default ProseWrap getProseWrap()
        (experimental) How to wrap prose.

        Default: ProseWrap.PRESERVE

      • getQuoteProps

        @Stability(Experimental)
@Nullable
default QuoteProps getQuoteProps()
        (experimental) Change when properties in objects are quoted.

        Default: QuoteProps.ASNEEDED

      • getRangeEnd

        @Stability(Experimental)
@Nullable
default Number getRangeEnd()
        (experimental) Format code ending at a given character offset (exclusive).

        The range will extend forwards to the end of the selected statement. This option cannot be used with --cursor-offset.

        Default: null

      • getRangeStart

        @Stability(Experimental)
@Nullable
default Number getRangeStart()
        (experimental) Format code starting at a given character offset.

        The range will extend backwards to the start of the first line containing the selected statement. This option cannot be used with --cursor-offset.

        Default: 0

      • getRequirePragma

        @Stability(Experimental)
@Nullable
default Boolean getRequirePragma()
        (experimental) Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted.

        Default: false

      • getSemi

        @Stability(Experimental)
@Nullable
default Boolean getSemi()
        (experimental) Print semicolons.

        Default: true

      • getSingleQuote

        @Stability(Experimental)
@Nullable
default Boolean getSingleQuote()
        (experimental) Use single quotes instead of double quotes.

        Default: false

      • getTabWidth

        @Stability(Experimental)
@Nullable
default Number getTabWidth()
        (experimental) Number of spaces per indentation level.

        Default: 2

      • getTrailingComma

        @Stability(Experimental)
@Nullable
default TrailingComma getTrailingComma()
        (experimental) Print trailing commas wherever possible when multi-line.

        Default: TrailingComma.ES5

      • getUseTabs

        @Stability(Experimental)
@Nullable
default Boolean getUseTabs()
        (experimental) Indent with tabs instead of spaces.

        Default: false

      • getVueIndentScriptAndStyle

        @Stability(Experimental)
@Nullable
default Boolean getVueIndentScriptAndStyle()
        (experimental) Indent script and style tags in Vue files.

        Default: false