Class Prettier

Hierarchy

  • Prettier
    • Prettier

Constructors

constructor

Properties

ignoreFile? project settings defaultOptions

Accessors

overrides

Methods

addIgnorePattern addOverride postSynthesize preSynthesize synthesize of

Constructors

constructor

Properties

Optional Readonly ignoreFile

ignoreFile?: IgnoreFile

The .prettierIgnore file.

project

project: GitHooksEnabledProject

Readonly settings

settings: PrettierSettings

Direct access to the prettier settings

Static defaultOptions

defaultOptions: {
    overrides: {
        files: string[];
        options: {
            printWidth: number;
            proseWrap: ProseWrap;
            quoteProps: QuoteProps;
            semi: boolean;
            singleQuote: boolean;
        };
    }[];
    settings: {
        bracketSpacing: boolean;
        printWidth: number;
        semi: boolean;
        tabWidth: number;
        trailingComma: TrailingComma;
        useTabs: boolean;
    };
} = ...

Type declaration

  • overrides: {
        files: string[];
        options: {
            printWidth: number;
            proseWrap: ProseWrap;
            quoteProps: QuoteProps;
            semi: boolean;
            singleQuote: boolean;
        };
    }[]
  • settings: {
        bracketSpacing: boolean;
        printWidth: number;
        semi: boolean;
        tabWidth: number;
        trailingComma: TrailingComma;
        useTabs: boolean;
    }
    • bracketSpacing: boolean
    • printWidth: number
    • semi: boolean
    • tabWidth: number
    • trailingComma: TrailingComma
    • useTabs: boolean

Accessors

overrides

  • get overrides(): PrettierOverride[]

  • Returns all Prettier overrides

    Returns PrettierOverride[]

Methods

addIgnorePattern

  • Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore

    Parameters

    • pattern: string

      filepatterns so exclude from prettier formatting

    Returns void

addOverride

postSynthesize

  • Called after synthesis. Order is not guaranteed.

    Returns void

preSynthesize

  • Returns void

synthesize

  • Synthesizes files to the project output directory.

    Returns void

Static of

  • Parameters

    • project: Project

    Returns undefined | Prettier

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc