102 lines
1.6 KiB
Markdown
102 lines
1.6 KiB
Markdown
# grunt-eslint [](https://travis-ci.org/sindresorhus/grunt-eslint)
|
|
|
|
> Validate files with [ESLint](https://eslint.org)
|
|
|
|
|
|
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install --save-dev grunt-eslint
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
```js
|
|
require('load-grunt-tasks')(grunt);
|
|
|
|
grunt.initConfig({
|
|
eslint: {
|
|
target: ['file.js']
|
|
}
|
|
});
|
|
|
|
grunt.registerTask('default', ['eslint']);
|
|
```
|
|
|
|
|
|
## Examples
|
|
|
|
### Custom config and rules
|
|
|
|
```js
|
|
grunt.initConfig({
|
|
eslint: {
|
|
options: {
|
|
configFile: 'conf/eslint.json',
|
|
rulePaths: ['conf/rules']
|
|
},
|
|
target: ['file.js']
|
|
}
|
|
});
|
|
```
|
|
|
|
### Custom formatter
|
|
|
|
```js
|
|
grunt.initConfig({
|
|
eslint: {
|
|
options: {
|
|
format: require('eslint-tap')
|
|
},
|
|
target: ['file.js']
|
|
}
|
|
});
|
|
```
|
|
|
|
|
|
## Options
|
|
|
|
See the [ESLint options](https://eslint.org/docs/developer-guide/nodejs-api#cliengine).
|
|
|
|
In addition the following options are supported:
|
|
|
|
### format
|
|
|
|
Type: `string`<br>
|
|
Default: `'stylish'`
|
|
|
|
Name of a [built-in formatter](https://github.com/nzakas/eslint/tree/master/lib/formatters) or path to a custom one.
|
|
|
|
Some formatters you might find useful: [eslint-json](https://github.com/sindresorhus/eslint-json), [eslint-tap](https://github.com/sindresorhus/eslint-tap).
|
|
|
|
### outputFile
|
|
|
|
Type: `string`<br>
|
|
Default: `''`
|
|
|
|
Output the report to a file.
|
|
|
|
### quiet
|
|
|
|
Type: `boolean`<br>
|
|
Default: `false`
|
|
|
|
Report errors only.
|
|
|
|
### maxWarnings
|
|
|
|
Type: `number`<br>
|
|
Default: `-1` *(Means no limit)*
|
|
|
|
Number of warnings to trigger non-zero exit code.
|
|
|
|
### failOnError
|
|
|
|
Type: `boolean`<br>
|
|
Default: `true`
|
|
|
|
Fail the build if ESLint found any errors.
|