diff --git a/plugins/prettier/readme.md b/plugins/prettier/readme.md index 6b23ad977..ac7a217f8 100644 --- a/plugins/prettier/readme.md +++ b/plugins/prettier/readme.md @@ -27,26 +27,10 @@ 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: - -```js -{ - 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. +| Key | Description | Default value | +|-|-|-| +| `files` | A required Array of strings of filepath(s) or filepath pattern(s) to be formatted | `['{,!(node_modules)/**/}*.js']` | +| `configOptions` | An optional prettier configuration object |
`{`
` 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. | `configOptions` value | For more information on prettier configuration, visit the [Prettier docs](https://prettier.io/docs/en/configuration.html). diff --git a/plugins/webpack/readme.md b/plugins/webpack/readme.md index 183cf8c9c..54951014b 100644 --- a/plugins/webpack/readme.md +++ b/plugins/webpack/readme.md @@ -38,6 +38,12 @@ hooks: 'test:local': WebpackDevelopment ``` +## Options + +| Key | Description | Default value | +|-|-|-| +| `configPath` | An optional path to your Webpack config file | none | + ## Tasks | Task | Description | Default hooks |