Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
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.
A Gulp plugin for identifying and reporting on patterns found in ECMAScript/JavaScript code.
First, install gulp-eslint
as a development dependency:
npm install --save-dev gulp-eslint
Then, add it to your gulpfile.js
:
var eslint = require('gulp-eslint');
gulp.task('lint', function () {
gulp.src(['js/**/*.js'])
.pipe(eslint())
.pipe(eslint.format());
});
Or use the plugin API to do things like:
gulp.src('js/**/*.js')
.pipe(eslint({
rulesdir:'custom-rules/',
rules:{
'my-custom-rule': 1,
'strict': 2
},
globals: {
'jQuery':false,
'$':true
},
env:{
browser:true
}
}))
.pipe(eslint.formatEach('compact', process.stderr));
No explicit configuration. A .eslintrc
file my be resolved relative to each linted file.
Type: String
Load additional rules from this directory. For more information, see the eslint CLI readdir option.
Type: String
Path to the eslint rules configuration file. For more information, see the eslint CLI config option and config file info. Note: This file must have a “.json” file extension.
Type: Object
Inline rules configuration. The rule configuration keys must match available validation rules. The associated values should be:
{
"rules":{
"camelcase": 1,
"no-comma-dangle": 2,
"quotes": 0
}
}
For a list of available rule IDs, see the eslint rules wiki.
Type: Object
Inline globals
configuration. The keys will be considered global variables, and the value determines whether the variable may be reassigned (true) or not (false). For example:
{
"globals":{
"jQuery": false,
"$": true
}
}
Type: Object
Inline env configuration. An env is a preset of rule configurations associated with an JavaScript environment (e.g., node
, browser
). Each key must match an existing env definition, and the key determines whether the env’s rules are applied (true) or not (false).
Type: String
Shorthand for defining options.config
.
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 “compact” formatter will be resolved. A Function
will be called with an Array
of file linting results to format.
// use the default "compact" 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('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
.
##Configuration
Eslint may be configured explicity by using any of the following plugin options: config
, rules
, globals
, or env
. When not configured in this way, 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. Any configuration will expand upon the default eslint configuration.
0.1.1
FAQs
A gulp plugin for processing files with ESLint
The npm package gulp-eslint receives a total of 94,649 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 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.