npm install gulp-eslint-through
const {src, task} = require('gulp');
const eslint = require('gulp-eslint-through');
task('default', () => {
return src(['scripts/*.js'])
// eslint() attaches the lint output to the "eslint" property
// of the file object so it can be used by other modules.
.pipe(eslint())
});
Or use the plugin API to do things like:
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint({
rules: {
'my-custom-rule': 1,
'strict': 2
},
globals: [
'jQuery',
'$'
],
envs: [
'browser'
]
}))
No explicit configuration. A .eslintrc
file may be resolved relative to each linted file.
Type: Object
Set configuration of rules.
{
"rules":{
"camelcase": 1,
"comma-dangle": 2,
"quotes": 0
}
}
Type: Array
Specify global variables to declare.
{
"globals":[
"jQuery",
"$"
]
}
Type: Boolean
This option instructs ESLint to try to fix as many issues as possible. The fixes are applied to the gulp stream. The fixed content can be saved to file using gulp.dest
(See example/fix.js). Rules that are fixable can be found in ESLint's rules list.
When fixes are applied, a "fixed" property is set to true
on the fixed file's ESLint result.
Type: Boolean
When true
, this option will filter warning messages from ESLint results. This mimics the ESLint CLI quiet option.
Type: function (message, index, list) { return Boolean(); }
When provided a function, it will be used to filter ESLint result messages, removing any messages that do not return a true
(or truthy) value.
Type: Array
Specify a list of environments to be applied.
Type: Array
This option allows you to specify additional directories from which to load rules files. This is useful when you have custom rules that aren't suitable for being bundled with ESLint. This option works much like the ESLint CLI's rulesdir option.
Type: String
Path to the ESLint rules configuration file. For more information, see the ESLint CLI config option and Using Configuration Files.
Type: Boolean
When true
, add a result warning when ESLint ignores a file. This can be used to file files that are needlessly being loaded by gulp.src
. For example, since ESLint automatically ignores "node_modules" file paths and gulp.src does not, a gulp task may take seconds longer just reading files from the "node_modules" directory.
Type: Boolean
When false
, ESLint will not load .eslintrc files.
Type: String
Shorthand for defining options.configFile
.
Type: function (result) {}
Call a function for each ESLint file result. No returned value is expected. If an error is thrown, it will be wrapped in a Gulp PluginError and emitted from the stream.
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint({
results: (data) => {
console.log(data)
}
}))
Type: function (result) { }
Call an asynchronous function for each ESLint file results. The callback must be called for the stream to finish. If a value is passed to the callback, it will be wrapped in a Gulp PluginError and emitted from the stream.
ESLint may be configured explicity by using any of the following plugin options: config
, rules
, globals
, or env
. If the useEslintrc option is not set to false
, ESLint will attempt to resolve a file by the name of .eslintrc
within the same directory as the file to be linted. If not found there, parent directories will be searched until .eslintrc
is found or the directory root is reached.
ESLint will ignore files that do not have a .js
file extension at the point of linting (some plugins may change file extensions mid-stream). This avoids unintentional linting of non-JavaScript files.
ESLint will also detect an .eslintignore
file at the cwd or a parent directory. See the ESLint docs to learn how to construct this file.
ESLint results are attached as an "eslint" property to the vinyl files that pass through a Gulp.js stream pipeline. This is available to streams that follow the initial eslint
stream. The eslint.result and eslint.results methods are made available to support extensions and custom handling of ESLint results.