James Henry e22f9370f5
feat(linter): new eslint builder (#3834)
* feat(linter): new eslint builder

* chore(linter): move migration to linter, add implementation

Co-authored-by: Jason Jean <jasonjean1993@gmail.com>
2020-09-29 20:52:10 -04:00

95 lines
1.2 KiB
Markdown

# eslint
Run ESLint on a project
Builder properties can be configured in workspace.json when defining the builder, or when invoking it.
Read more about how to use builders and the CLI here: https://nx.dev/react/guides/cli.
## Properties
### cache
Default: `false`
Type: `boolean`
Only check changed files.
### cacheLocation
Type: `string`
Path to the cache file or directory.
### eslintConfig
Type: `string`
The name of the ESLint configuration file.
### fix
Default: `false`
Type: `boolean`
Fixes linting errors (may overwrite linted files).
### force
Default: `false`
Type: `boolean`
Succeeds even if there was linting errors.
### format
Default: `stylish`
Type: `string`
ESLint Output formatter (https://eslint.org/docs/user-guide/formatters).
### ignorePath
Type: `string`
The path of the .eslintignore file.
### lintFilePatterns
Type: `array`
One or more files/dirs/globs to pass directly to ESLint's lintFiles() method.
### maxWarnings
Default: `-1`
Type: `number`
Number of warnings to trigger nonzero exit code - default: -1
### outputFile
Type: `string`
File to write report to.
### quiet
Default: `false`
Type: `boolean`
Report errors only - default: false
### silent
Default: `false`
Type: `boolean`
Hide output text.