gulp-eslint
Advanced tools
gulp-eslint is a Gulp plugin for ESLint, a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It helps developers maintain code quality by enforcing coding standards and detecting potential errors.
Linting JavaScript files
This feature allows you to lint JavaScript files in your project. The code sample demonstrates how to set up a Gulp task that lints all JavaScript files except those in the node_modules directory, formats the linting results, and fails the task if any errors are found.
const gulp = require('gulp');
const eslint = require('gulp-eslint');
gulp.task('lint', () => {
return gulp.src(['**/*.js', '!node_modules/**'])
.pipe(eslint())
.pipe(eslint.format())
.pipe(eslint.failAfterError());
});Custom ESLint configuration
This feature allows you to specify custom ESLint rules and environments directly within the Gulp task. The code sample shows how to configure ESLint to enforce single quotes and semicolons, and to recognize browser and Node.js environments.
const gulp = require('gulp');
const eslint = require('gulp-eslint');
gulp.task('lint', () => {
return gulp.src(['**/*.js', '!node_modules/**'])
.pipe(eslint({
rules: {
'quotes': ['error', 'single'],
'semi': ['error', 'always']
},
envs: ['browser', 'node']
}))
.pipe(eslint.format())
.pipe(eslint.failAfterError());
});Linting specific files
This feature allows you to lint specific sets of files. The code sample demonstrates how to set up a Gulp task that only lints JavaScript files in the 'src/scripts' directory.
const gulp = require('gulp');
const eslint = require('gulp-eslint');
gulp.task('lint-scripts', () => {
return gulp.src('src/scripts/**/*.js')
.pipe(eslint())
.pipe(eslint.format())
.pipe(eslint.failAfterError());
});ESLint is the core tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It is highly configurable and can be used directly without Gulp. Compared to gulp-eslint, it provides more flexibility and can be integrated into various build systems and editors.
gulp-jshint is a Gulp plugin for JSHint, another popular JavaScript code quality tool. While JSHint is similar to ESLint, it is less configurable and has fewer rules. gulp-jshint is a good alternative if you prefer JSHint over ESLint.
gulp-standard is a Gulp plugin for Standard, a JavaScript style guide, linter, and formatter. It enforces a specific set of coding standards without the need for configuration. Compared to gulp-eslint, it is less flexible but easier to set up for projects that follow the Standard style guide.
npm install gulp-eslint
const {src, task} = require('gulp');
const eslint = require('gulp-eslint');
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())
// eslint.format() outputs the lint results to the console.
// Alternatively use eslint.formatEach() (see Docs).
.pipe(eslint.format())
// To have the process exit with an error code (1) on
// lint error, return the stream and pipe to failAfterError last.
.pipe(eslint.failAfterError());
});
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'
]
}))
.pipe(eslint.formatEach('compact', process.stderr));
For additional examples, look through the example directory.
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())
.pipe(eslint.result(result => {
// Called for each ESLint result.
console.log(`ESLint result: ${result.filePath}`);
console.log(`# Messages: ${result.messages.length}`);
console.log(`# Warnings: ${result.warningCount}`);
console.log(`# Errors: ${result.errorCount}`);
}));
Type: function (result, callback) { callback(error); }
Call an asynchronous function for each ESLint file result. 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.
Type: function (results) {}
Call a function once for all ESLint file results before a stream finishes. No returned value is expected. If an error is thrown, it will be wrapped in a Gulp PluginError and emitted from the stream.
The results list has a "warningCount" property that is the sum of warnings in all results; likewise, an "errorCount" property is set to the sum of errors in all results.
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint())
.pipe(eslint.results(results => {
// Called once for all ESLint results.
console.log(`Total Results: ${results.length}`);
console.log(`Total Warnings: ${results.warningCount}`);
console.log(`Total Errors: ${results.errorCount}`);
}));
Type: function (results, callback) { callback(error); }
Call an asynchronous function once for all ESLint file results before a stream finishes. 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.
Stop a task/stream if an ESLint error has been reported for any file.
// Cause the stream to stop(/fail) before copying an invalid JS file to the output directory
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint())
.pipe(eslint.failOnError());
Stop a task/stream if an ESLint error has been reported for any file, but wait for all of them to be processed first.
// Cause the stream to stop(/fail) when the stream ends if any ESLint error(s) occurred.
gulp.src(['**/*.js','!node_modules/**'])
.pipe(eslint())
.pipe(eslint.failAfterError());
Format all linted files once. This should be used in the stream after piping through eslint; otherwise, this will find no ESLint results to format.
The formatter argument may be a String, Function, or undefined. As a String, a formatter module by that name or path will be resolved as a module, relative to process.cwd(), or as one of the ESLint-provided formatters. If undefined, the ESLint “stylish” formatter will be resolved. A Function will be called with an Array of file linting results to format.
// use the default "stylish" ESLint formatter
eslint.format()
// use the "checkstyle" ESLint formatter
eslint.format('checkstyle')
// use the "eslint-path-formatter" module formatter
// (@see https://github.com/Bartvds/eslint-path-formatter)
eslint.format('node_modules/eslint-path-formatter')
The output argument may be a WritableStream, Function, or undefined. As a WritableStream, the formatter results will be written to the stream. If undefined, the formatter results will be written to gulp’s log. A Function will be called with the formatter results as the only parameter.
// write to gulp's log (default)
eslint.format();
// write messages to stdout
eslint.format('junit', process.stdout)
Format each linted file individually. This should be used in the stream after piping through eslint; otherwise, this will find no ESLint results to format.
The arguments for formatEach are the same as the arguments for format.
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.
6.0.0
eslint dependency to ^6.0.0 https://eslint.org/blog/2019/06/eslint-v6.0.0-releasedFAQs
A gulp plugin for processing files with ESLint
The npm package gulp-eslint receives a total of 135,277 weekly downloads. As such, gulp-eslint popularity was classified as popular.
We found that gulp-eslint demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.