grunt-contrib-jshint
Advanced tools
grunt-contrib-jshint is a Grunt plugin for running JSHint, a tool that helps to detect errors and potential problems in JavaScript code. It allows you to integrate JSHint into your Grunt build process, enabling automated code quality checks.
Basic JSHint Task
This feature allows you to define a basic JSHint task in your Gruntfile. It specifies the files to be linted and sets JSHint options, such as ECMAScript version.
{
"grunt.initConfig": {
"jshint": {
"files": ['Gruntfile.js', 'src/**/*.js', 'test/**/*.js'],
"options": {
"esversion": 6
}
}
},
"grunt.loadNpmTasks": "grunt-contrib-jshint",
"grunt.registerTask": ["default", ["jshint"]]
}Custom JSHint Reporter
This feature allows you to use a custom reporter for JSHint, such as 'jshint-stylish', to format the output of linting results in a more readable manner.
{
"grunt.initConfig": {
"jshint": {
"files": ['Gruntfile.js', 'src/**/*.js', 'test/**/*.js'],
"options": {
"reporter": require('jshint-stylish')
}
}
},
"grunt.loadNpmTasks": "grunt-contrib-jshint",
"grunt.registerTask": ["default", ["jshint"]]
}JSHint with Custom Configuration File
This feature allows you to specify a custom JSHint configuration file (.jshintrc) to define your linting rules and options.
{
"grunt.initConfig": {
"jshint": {
"files": ['Gruntfile.js', 'src/**/*.js', 'test/**/*.js'],
"options": {
"jshintrc": '.jshintrc'
}
}
},
"grunt.loadNpmTasks": "grunt-contrib-jshint",
"grunt.registerTask": ["default", ["jshint"]]
}ESLint is a popular linting tool for JavaScript and TypeScript. It is highly configurable and supports a wide range of plugins and rules. Compared to grunt-contrib-jshint, ESLint offers more flexibility and a larger ecosystem of plugins.
JSCS (JavaScript Code Style) is a code style linter for JavaScript. It focuses on enforcing coding conventions and style guidelines. While JSHint checks for potential errors and code quality, JSCS is more focused on code style.
TSLint is a linter for TypeScript code. It helps to enforce coding standards and catch potential errors in TypeScript projects. While grunt-contrib-jshint is for JavaScript, TSLint is specifically designed for TypeScript.
Validate files with JSHint.
This plugin requires Grunt ~0.4.0
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 grunt-contrib-jshint --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-contrib-jshint');
Run this task with the grunt jshint command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
For more explanations of the lint errors JSHint will throw at you please visit jslinterrors.com.
Any specified option will be passed through directly to JSHint, thus you can specify any option that JSHint supports. See the JSHint documentation for a list of supported options.
A few additional options are supported:
Type: Object
Default value: null
A map of global variables, with keys as names and a boolean value to determine if they are assignable. This is not a standard JSHint option, but is passed into the JSHINT function as its third argument. See the JSHint documentation for more information.
Type: String
Default value: null
If this filename is specified, options and globals defined therein will be used. The jshintrc file must be valid JSON and looks something like this:
{
"curly": true,
"eqnull": true,
"eqeqeq": true,
"undef": true,
"globals": {
"jQuery": true
}
}
Be aware that jshintrc settings are not merged with your Grunt options.
Type: String
Default value: ''
A list of non-dot-js extensions to check.
Type: Array
Default value: null
A list of files and dirs to ignore. This will override your .jshintignore file if set and does not merge.
Type: Boolean
Default value: false
Set force to true to report JSHint errors but not fail the task.
Type: String
Default value: null
Allows you to modify this plugins output. By default it will use a built-in Grunt reporter. Set the path to your own custom reporter or to one of the built-in JSHint reporters: jslint or checkstyle.
See also: Writing your own JSHint reporter.
Type: String
Default value: null
Specify a filepath to output the results of a reporter. If reporterOutput is specified then all output will be written to the given filepath instead of printed to stdout.
In this example, running grunt jshint:all (or grunt jshint because jshint is a [multi task][]) will lint the project's Gruntfile as well as all JavaScript files in the lib and test directories and their subdirectores, using the default JSHint options.
// Project configuration.
grunt.initConfig({
jshint: {
all: ['Gruntfile.js', 'lib/**/*.js', 'test/**/*.js']
}
});
In this example, running grunt jshint will lint both the "beforeconcat" set and "afterconcat" sets of files. This is not ideal, because dist/output.js may get linted before it gets created via the grunt-contrib-concat plugin concat task.
In this case, you should lint the "beforeconcat" files first, then concat, then lint the "afterconcat" files, by running grunt jshint:beforeconcat concat jshint:afterconcat.
// Project configuration.
grunt.initConfig({
concat: {
dist: {
src: ['src/foo.js', 'src/bar.js'],
dest: 'dist/output.js'
}
},
jshint: {
beforeconcat: ['src/foo.js', 'src/bar.js'],
afterconcat: ['dist/output.js']
}
});
In this example, custom JSHint options are specified. Note that when grunt jshint:uses_defaults is run, those files are linted using the default options, but when grunt jshint:with_overrides is run, those files are linted using merged task/target options.
// Project configuration.
grunt.initConfig({
jshint: {
options: {
curly: true,
eqeqeq: true,
eqnull: true,
browser: true,
globals: {
jQuery: true
},
},
uses_defaults: ['dir1/**/*.js', 'dir2/**/*.js'],
with_overrides: {
options: {
curly: false,
undef: true,
},
files: {
src: ['dir3/**/*.js', 'dir4/**/*.js']
},
}
},
});
Task submitted by "Cowboy" Ben Alman
This file was generated on Fri May 17 2013 15:04:14.
FAQs
Validate files with JSHint
We found that grunt-contrib-jshint demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 6 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
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."