NPM Build Utilities @ 0.3.0-alpha.9
    Preparing search index...

    Interface ArgsInternal

    Optional configuration for FileSystemType.prettier method.

    0.1.0-alpha

    interface Args {
        __embeddedInHtml: boolean;
        arrowParens: "always" | "avoid";
        bracketSameLine: boolean;
        bracketSpacing: boolean;
        checkIgnorePragma: boolean;
        embeddedLanguageFormatting: "auto" | "off";
        endOfLine: "auto" | "lf" | "crlf" | "cr";
        experimentalOperatorPosition: "start" | "end";
        experimentalTernaries: boolean;
        filepath: string;
        glob: Partial<FileSystemType.Glob.Args>;
        htmlWhitespaceSensitivity: "css" | "ignore" | "strict";
        insertPragma: boolean;
        jsxBracketSameLine: boolean;
        jsxSingleQuote: boolean;
        objectWrap: "preserve" | "collapse";
        parentParser: string;
        parser: LiteralUnion<BuiltInParserName>;
        plugins: (string | URL | Plugin<any>)[];
        printWidth: number;
        proseWrap: "preserve" | "always" | "never";
        quoteProps: "preserve" | "as-needed" | "consistent";
        rangeEnd: number;
        rangeStart: number;
        requirePragma: boolean;
        semi: boolean;
        singleAttributePerLine: boolean;
        singleQuote: boolean;
        tabWidth: number;
        trailingComma: "none" | "es5" | "all";
        useTabs: boolean;
        vueIndentScriptAndStyle: boolean;
        [key: string]: unknown;
    }

    Hierarchy

    Indexable

    • [key: string]: unknown
    Index

    Properties

    __embeddedInHtml arrowParens bracketSameLine bracketSpacing checkIgnorePragma embeddedLanguageFormatting endOfLine experimentalOperatorPosition experimentalTernaries filepath glob htmlWhitespaceSensitivity insertPragma jsxBracketSameLine jsxSingleQuote objectWrap parentParser parser plugins printWidth proseWrap quoteProps rangeEnd rangeStart requirePragma semi singleAttributePerLine singleQuote tabWidth trailingComma useTabs vueIndentScriptAndStyle

    Properties

    Internal__embeddedInHtml

    __embeddedInHtml: boolean
    arrowParens: "always" | "avoid"

    Include parentheses around a sole arrow function parameter.

    "always"
    bracketSameLine: boolean

    Put the > of a multi-line HTML (HTML, JSX, Vue, Angular) element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).

    false
    bracketSpacing: boolean

    Print spaces between brackets in object literals.

    true
    checkIgnorePragma: boolean

    Prettier can allow individual files to opt out of formatting if they contain a special comment, called a pragma, at the top of the file.

    false
    embeddedLanguageFormatting: "auto" | "off"

    Control whether Prettier formats quoted code embedded in the file.

    "auto"
    endOfLine: "auto" | "lf" | "crlf" | "cr"

    Which end of line characters to apply.

    "lf"
    experimentalOperatorPosition: "start" | "end"

    Where to print operators when binary expressions wrap lines.

    "end"
    experimentalTernaries: boolean

    Use curious ternaries, with the question mark after the condition, instead of on the same line as the consequent.

    false
    filepath: string

    Specify the input filepath. This will be used to do parser inference.

    glob: Partial<FileSystemType.Glob.Args>
    htmlWhitespaceSensitivity: "css" | "ignore" | "strict"

    How to handle whitespaces in HTML.

    "css"
    insertPragma: boolean

    Prettier can insert a special

    marker at the top of files specifying that the file has been formatted with prettier. This works well when used in tandem with the --require-pragma option. If there is already a docblock at the top of the file then this option will add a newline to it with the

    marker.

    false
    jsxBracketSameLine: boolean

    Put the > of a multi-line JSX element at the end of the last line instead of being alone on the next line.

    false

    use bracketSameLine instead

    jsxSingleQuote: boolean

    Use single quotes in JSX.

    false
    objectWrap: "preserve" | "collapse"

    How to wrap object literals.

    "preserve"
    parentParser: string
    parser: LiteralUnion<BuiltInParserName>

    Specify which parser to use.

    plugins: (string | URL | Plugin<any>)[]

    Provide ability to support new languages to prettier.

    printWidth: number

    Specify the line length that the printer will wrap on.

    80
    proseWrap: "preserve" | "always" | "never"

    By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer. In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out.

    "preserve"
    quoteProps: "preserve" | "as-needed" | "consistent"

    Change when properties in objects are quoted.

    "as-needed"
    rangeEnd: number

    Format only a segment of a file.

    Number.POSITIVE_INFINITY
    rangeStart: number

    Format only a segment of a file.

    0
    requirePragma: boolean

    Prettier can restrict itself to only format files that contain a special comment, called a pragma, at the top of the file. This is very useful when gradually transitioning large, unformatted codebases to prettier.

    false
    semi: boolean

    Print semicolons at the ends of statements.

    true
    singleAttributePerLine: boolean

    Enforce single attribute per line in HTML, Vue and JSX.

    false
    singleQuote: boolean

    Use single quotes instead of double quotes.

    false
    tabWidth: number

    Specify the number of spaces per indentation-level.

    2
    trailingComma: "none" | "es5" | "all"

    Print trailing commas wherever possible.

    "all"
    useTabs: boolean

    Indent lines with tabs instead of spaces

    false
    vueIndentScriptAndStyle: boolean

    Whether or not to indent the code inside