A command line interface and npm package for jshint.
To use jshint from any location (for npm v1.x) you need to install using the global (-g) flag.
npm install -g jshint
The command line interface looks like this.
jshint path path2 [options]
You can also require JSHint itself as a module.
var jshint = require('jshint');
Note: If you are using npm v1.x be sure to install jshint locally (without the -g flag) or link it globally.
Text Editor Plugins
- gedit-node-jshint - Simply use CTRL+J in gedit to run JSHint using
- vim syntastic - Run node-jshint at each file save.
- sublime-jshint -
command-Bon any .js file.
F4next error line,column.
shift-F4previous error line,column.
Specify a custom reporter module (see example/reporter.js).
Use a jslint compatible xml reporter.
Show additional non-error data generated by jshint (unused globals etc).
Note: This behavior described below is very different from versions prior to
The CLI uses the default options that come with JSHint. To have your own configuration apply, there are several methods you can use:
--config=/path/to/your/config command line option to specify your own configuration file outside of the directory tree for your project.
Within your Project's Directory Tree
When the CLI is called, and a configuration file isn't specified already,
node-jshint will attempt to locate one for you starting in
pwd. (or "present working directory") If this does not yield a
.jshintrc file, it will move one level up (
..) the directory tree all the way up to the filesystem root. If a file is found, it stops immediately and uses that set of configuration.
This setup allows you to set up one configuration file for your entire project. (place it in the root folder) As long as you run
jshint from anywhere within your project directory tree, the same configuration file will be used.
If all the methods above do not yield a
.jshintrc to use, the last place that will be checked is your user's
Default extension for files is ".js". If you want to use JSHint with other file extensions (.json), you need to pass this extra extension as an option :
Ignoring Files and Directories
If there is a .jshintignore file in your project's directory tree, (also provided you run
jshint from within your project's directory true) then any directories or files specified will be skipped over. (behaves just like a
Note: Pattern matching uses minimatch, with the nocase option. When there is no match, it performs a left side match (when no forward slashes present and path is a directory).
Installing dependencies for development
- All tests are passing.
- No (new) JSHint errors are introduced.