grunt-contrib-jshint v3.2.0
Validate files with JSHint
Getting Started
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');
Jshint task
Run this task with the grunt jshint
command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
Options
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:
globals
Type: Object
Default: 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.
jshintrc
Type: String
or true
Default: null
If set to true
, no config will be sent to JSHint and JSHint will search for .jshintrc
files relative to the files being linted.
If a 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.
extensions
Type: String
Default: ''
A list of non-dot-js extensions to check.
ignores
Type: Array
Default: null
A list of files and dirs to ignore. This will override your .jshintignore
file if set and does not merge.
force
Type: Boolean
Default: false
Set force
to true
to report JSHint errors but not fail the task.
reporter
Type: String
Default: 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.
You can also use an external reporter. For example jshint-stylish:
$ npm install --save-dev jshint-stylish
options: {
reporter: require('jshint-stylish')
}
reporterOutput
Type: String
Default: 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.
reporterOutputRelative
Type: Boolean
Default: true
Results of a reporter will use a relative filepath to reporterOutput
. If set to false
then filepaths will appear relative to the current folder. Unless reporterOutput
is not set this option will not have any effect.
Usage examples
Wildcards
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 subdirectories, using the default JSHint options.
// Project configuration.
grunt.initConfig({
jshint: {
all: ['Gruntfile.js', 'lib/**/*.js', 'test/**/*.js']
}
});
Linting before and after concatenating
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']
}
});
Specifying JSHint options and globals
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']
},
}
},
});
Ignoring specific warnings
If you would like to ignore a specific warning:
[L24:C9] W015: Expected '}' to have an indentation at 11 instead at 9.
You can toggle it by prepending -
to the warning id as an option:
grunt.initConfig({
jshint: {
ignore_warning: {
options: {
'-W015': true,
},
src: ['**/*.js'],
},
},
});
Release History
- 2022-02-17βββv3.2.0βββBump dependencies, including jshint.
- 2020-10-20βββv3.0.0βββBump dependencies. Switch to GitHub actions. Ensures errors in stdoutEqual callback are logged. Requires Node 10+.
- 2019-03-18βββv2.1.0βββBump dependencies. Update to latest JSHint
- 2018-09-22βββv2.0.0βββBump devDependencies. Drop Node.js < 6 support.
- 2016-11-23βββv1.1.0βββFix relative output Bump minor version
- 2016-02-16βββv1.0.0βββReplace String prototype colors with chalk. Update Grunt peerDep to
>=0.4.0
. - 2016-01-17βββv0.12.0βββUpdate to JSHint ~2.9.0.
- 2015-09-03βββv0.11.3βββUpdate to JSHint ~2.8.0.
- 2015-04-16βββv0.11.2βββFix default value of the
reporter
option. - 2015-03-20βββv0.11.1βββFix io.js compatibility issues. Other fixes to pathing.
- 2015-01-22βββv0.11.0βββUpdate to JSHint ~2.6.0.
- 2014-04-02βββv0.10.0βββUpdate to JSHint 2.5.0.
- 2014-03-12βββv0.9.2βββFixes a bug where
reporterOutput
was still passed to JSHint. - 2014-03-12βββv0.9.1βββDon't pass
reporterOutput
option to JSHint. - 2014-03-12βββv0.9.0βββReplace deprecated
grunt.util._.clone
withObject.create()
. Replace deprecatedgrunt.util.hooker
with hooker lib. Enhancing the readability of the output. Reporter output is relative to the output file. Pass JSHint options to the external reporter. - 2013-12-25βββv0.8.0βββUpdate to JSHint 2.4.0.
- 2013-11-16βββv0.7.2βββOnly print file name once per error.
- 2013-10-31βββv0.7.1βββAbility to set jshintrc option to true to use JSHint's native ability for finding .jshintrc files relative to the linted files.
- 2013-10-23βββv0.7.0βββUpdate to JSHint 2.3.0.
- 2013-10-23βββv0.6.5βββFix output when
maxerr
is low. - 2013-08-29βββv0.6.4βββjshintrc now loaded by JSHint allowing comments.
- 2013-08-15βββv0.6.3βββFix module location for JSHint 2.1.10.
- 2013-07-29βββv0.6.2βββUpdate to JSHint 2.1.7.
- 2013-07-27βββv0.6.1βββPeg JSHint to 2.1.4 until breaking changes in 2.1.5 are fixed.
- 2013-06-02βββv0.6.0βββDon't always succeed the task when using a custom reporter. Bump JSHint to 2.1.3.
- 2013-05-22βββv0.5.4βββFix default reporter to show offending file.
- 2013-05-19βββv0.5.3βββPerformance: Execute the reporter once rather than per file.
- 2013-05-18βββv0.5.2βββFix printing too many erroneous ignored file errors.
- 2013-05-17βββv0.5.1βββFix for when only 1 file is lint free.
- 2013-05-17βββv0.5.0βββBump to JSHint 2.0. Add support for .jshintignore files and ignores option. Add support for
extensions
option. Add support for custom reporters and output report to a file. - 2013-04-08βββv0.4.3βββFix evaluation of
predef
option when it's an object. - 2013-04-08βββv0.4.2βββAvoid wiping
force
option when jshintrc is used. - 2013-04-06βββv0.4.1βββFix to allow object type for deprecated predef.
- 2013-04-04βββv0.4.0βββRevert task level options to override jshintrc files.
- 2013-03-13βββv0.3.0βββBump to JSHint 1.1.0. Add force option to report JSHint errors but not fail the task. Add error/warning code to message. Allow task level options to override jshintrc file.
- 2013-02-26βββv0.2.0βββBump to JSHint 1.0.
- 2013-02-15βββv0.1.1βββFirst official release for Grunt 0.4.0.
- 2013-01-18βββv0.1.1rc6βββUpdating grunt/gruntplugin dependencies to rc6. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
- 2013-01-09βββv0.1.1rc5βββUpdating to work with grunt v0.4.0rc5. Switching to
this.filesSrc
API. - 2012-10-18βββv0.1.0βββWork in progress, not yet officially released.
Task submitted by "Cowboy" Ben Alman
This file was generated on Thu Feb 17 2022 21:24:56.