@dotcom-tool-kit/prettier v3.2.0

prettier Tool Kit plugin

This plugin is for adding prettier onto your apps.

Installation

Install @dotcom-tool-kit/prettier as a devDependency in your app:

npm install --save-dev @dotcom-tool-kit/prettier

Add the plugin to your Tool Kit configuration:

plugins:
	- '@dotcom-tool-kit/prettier'

And install this plugin's hooks:

npx dotcom-tool-kit --install

This will modify your package.json. You should commit this change.

Options

files

A required Array of strings of filepath(s) or filepath pattern(s) to be formatted. Defaults to `'{,!(node_modules)/*/}.js'.

configOptions

An optional prettier configuration object. Defaults to:

{
    singleQuote: true,
    useTabs: true,
    bracketSpacing: true,
    arrowParens: 'always',
    trailingComma: 'none'
}

configFile

An optional String that specifies the prettier configuration file (.prettierrc.json). The configuration file will be resolved starting from the location of the file being formatted, and searching up the file tree until a config file is (or isn’t) found. If the configFile is not found the prettier plugin will default to configOptions.

For more information on prettier configuration, visit the Prettier docs.