Validate files with ESLint.
This project has been made to avoid breaking errors caused by an update to ESLint by locking the dependency version. It has been forked from the original eslint-grunt project by Ian Christian Myers, apart from locking the dependency there are no other differences.
It's essentially a quick fix solution to updating the original project, which if it is then this project could be safely depreciated.
- ESLint uses an AST to evaluate patterns in code.
- ESLint is completely pluggable, every single rule is a plugin and you can add more at runtime.
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install eslint-grunt --save-dev
The eslint Task
The eslint task can be run with the
grunt eslint command. Files to run through ESLint and options may be specified according to the grunt configuring tasks guide. There are a few options that you may pass to the eslint task, all of which are optional:
config String: This should be a path to your ESLint config JSON file. This must be a valid ESLint config JSON. Note that
eslint-gruntwill respect the reporting level in your ESLint config JSON (1 is warn, 2 is error). Warn will let the task exit successfully. Error will fail the task. If a config is not specified, the default JSON file will be used. Take a look at the default ESLint config JSON and the ESLint rules documentation.
rulesDir String: The path to the directory containing your custom rules. These rules will be made available in addition to the rules that ship with ESLint core. You can take a look at the source for the ESLint core rules as an example for how to write your own, or read the ESLint working with rules guide. You must enable custom rules in your config file in the same way that ESLint core rules are enabled. The rule key will be the same as your rule filename.
formatter String: The name of a built-in formatter or the path to a custom ESLint formatter. By default a variation on ESLint's default formatter will be used.
force Boolean: When set to
true, this option will force the task to pass, even if ESLint encounters errors (rules set to 2). This is useful if you'd like to use the same config for development and testing.
eslint-grunt will also respect options set in your
conf/eslint.json and the custom rules in the
Load custom rules from
ESLint Configuration JSON
All rules below that are set to
2 will report an error, meaning the
eslint grunt task will fail. All rules that are set to
1 will report a warning, but will not cause the task to fail. All rules that are set to
0 are off.
If you do not want to ever fail the task, set all the rules you want on to
1. Similarly, if you'd like to always fail the task when encountering a problem, set all the rules you want on to
"rules":"no-alert": 2"no-caller": 2"no-bitwise": 0"no-console": 2"no-dangle": 1"no-debugger": 2"no-empty": 2"no-eval": 1"no-ex-assign": 2"no-floating-decimal": 0"no-implied-eval": 2"no-with": 2"no-fallthrough": 2"no-unreachable": 2"no-undef-init": 2"no-octal": 2"no-obj-calls": 2"no-new-wrappers": 2"no-new": 2"no-new-func": 2"no-native-reassign": 2"no-plusplus": 0"no-delete-var": 2"no-return-assign": 2"no-new-array": 2"no-new-object": 2"no-label-var": 2"no-ternary": 0"no-self-compare": 0"smarter-eqeqeq": 0"brace-style": 1"camelcase": 2"curly": 2"dot-notation": 1"eqeqeq": 1"new-parens": 2"guard-for-in": 0"radix": 0"new-cap": 2"quote-props": 0"semi": 2"use-isnan": 2"quotes": 1 "double""max-params": 0 3"max-statements": 0 10"regex-spaces": 2"complexity": 0 11"wrap-iife": 1"no-multi-str": 2