Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gyandeeps/gruntify-eslint
Grunt plugin for Eslint
https://github.com/gyandeeps/gruntify-eslint
Last synced: 11 days ago
JSON representation
Grunt plugin for Eslint
- Host: GitHub
- URL: https://github.com/gyandeeps/gruntify-eslint
- Owner: gyandeeps
- License: mit
- Created: 2014-07-08T02:19:59.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-09-11T04:54:32.000Z (about 3 years ago)
- Last Synced: 2024-10-25T14:38:27.938Z (14 days ago)
- Language: JavaScript
- Size: 33.2 KB
- Stars: 14
- Watchers: 3
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://badge.fury.io/js/gruntify-eslint)
gruntify-eslint
====================
Grunt plugin for Eslint
## Getting Started
If you haven't used [grunt][] before, be sure to check out the [Getting Started][] guide, as it explains how to create a [gruntfile][Getting Started] as well as install and use grunt plugins. Once you're familiar with that process, install this plugin with this command:
```bash
$ npm install --save-dev gruntify-eslint
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks("gruntify-eslint");
```
[grunt]: http://gruntjs.com
[Getting Started]: https://github.com/gruntjs/grunt/wiki/Getting-started
## Documentation
See the grunt [docs](https://gruntjs.com/getting-started) on how to [configure tasks](https://gruntjs.com/configuring-tasks) and more advanced usage.
### Example
```js
grunt.initConfig({
eslint: {
src: ["app.js"]
}
});
grunt.loadNpmTasks("gruntify-eslint");
grunt.registerTask("default", ["eslint"]);
```
### Example with custom config and rules
```js
grunt.initConfig({
eslint: {
options: {
configFile: "conf/eslint.json",
rulePaths: ["conf/rules"]
},
src: ["app.js"]
}
});
grunt.loadNpmTasks("gruntify-eslint");
grunt.registerTask("default", ["eslint"]);
```
### Example with custom rules for node and browser files
```js
grunt.config.init({
eslint: {
nodeFiles: {
src: ["server/**/*.js"],
options: {
configFile: "conf/eslint-node.json"
}
},
browserFiles: {
src: ["client/**/*.js"]
options: {
configFile: "conf/eslint-browser.json"
}
}
}
});
grunt.loadNpmTasks("gruntify-eslint");
grunt.registerTask("default", ["eslint"]);
```
### Example with silent option
```js
grunt.initConfig({
eslint: {
options: {
silent: true
},
src: ["app.js"]
}
});
grunt.loadNpmTasks("gruntify-eslint");
grunt.registerTask("default", ["eslint"]);
```
### [Options](http://eslint.org/docs/developer-guide/nodejs-api#cliengine)
#### configFile
Type: `path::String`
#### format
Type: `String`
Default: `'stylish'`
Name of a [built-in formatter](https://github.com/nzakas/eslint/tree/master/lib/formatters) or path to a custom one.
#### silent
Type: `Boolean`
Whether the grunt task would fail on error or will it always pass irrespective of the results.
i.e. to supress the failure.
This option is not passed to the eslint api.
#### maxWarnings
Type: `Number`
Default: `-1`
Specifies a warning threshold, which will cause the task to fail if there are too many warning-level rule violations.
This option is not passed to the eslint api.
#### callback
Type: `Function`
You can specify a call back function which would be called when eslint is done processing the files. The first argument passed in would be the results object.
This option is not passed to the eslint api.
#### terminateOnCallback
Type: `Boolean`
Default: `true`
When specifying a callback gruntify-eslint will by default not output results, but instead return the return of the callback.
You may set `terminateOnCallback` to `false` in order to allow usual report output as long as your callback returns `undefined` or `results`.
If you wish to modify results, have `callback` return modified `results`.
This option is not passed to the eslint api.
#### outputFile
Type: `path::String`
Specify a file path to write the test results to. This option is not passed to the eslint api.
** More information about options: [Eslint options]
[Eslint options]: http://eslint.org/docs/developer-guide/nodejs-api#cliengine