JSHint is a static code analysis tool used in software development for checking if JavaScript source code complies with coding rules. It helps developers identify potential errors and enforce coding standards.
Basic Linting
This feature allows you to perform basic linting on a piece of JavaScript code. The code sample demonstrates how to use JSHint to check a simple JavaScript snippet for errors.
const jshint = require('jshint').JSHINT;
const code = 'var a = 1;';
const options = { esversion: 6 };
jshint(code, options);
console.log(jshint.errors);Custom Configuration
JSHint allows you to customize the linting process with various options. This example shows how to enable the 'undef' option to check for the use of undefined variables.
const jshint = require('jshint').JSHINT;
const code = 'var a = 1;';
const options = { esversion: 6, undef: true };
jshint(code, options);
console.log(jshint.errors);Using JSHint with Configuration File
You can use a configuration file (e.g., .jshintrc) to define your linting rules. This example demonstrates how to read a JavaScript file and a JSHint configuration file, then lint the code using the specified rules.
const fs = require('fs');
const jshint = require('jshint').JSHINT;
const code = fs.readFileSync('path/to/your/file.js', 'utf8');
const config = JSON.parse(fs.readFileSync('.jshintrc', 'utf8'));
jshint(code, config);
console.log(jshint.errors);ESLint is another popular JavaScript linting tool that is highly configurable and supports custom rules. It provides more flexibility and a larger ecosystem of plugins compared to JSHint.
JSCS (JavaScript Code Style) is a code style linter for JavaScript. It focuses more on enforcing coding style conventions rather than finding potential errors. It has been merged with ESLint, but older versions are still in use.
TSLint is a linter for TypeScript, which is a superset of JavaScript. It provides similar functionality to JSHint but is specifically designed for TypeScript code. TSLint is now deprecated in favor of ESLint with TypeScript support.
JSHint is a community-driven tool to detect errors and potential problems in JavaScript code and to enforce your team's coding conventions. We made JSHint very flexible so you can easily adjust it to your particular coding guidelines and the environment you expect your code to execute in.
Our goal is to help JavaScript developers write complex programs without worrying about typos and language gotchas.
We believe that static code analysis programs—as well as other code quality tools—are important and beneficial to the JavaScript community and, thus, should not alienate their users.
For general usage and hacking information, visit our website: http://jshint.com/.
Some bugs are so important to us, we will pay you if you fix them! Go to our page on BountySource to see which bugs have bounties behind them.
Really want to have something fixed but don't have time? You can add your own bounty to any JSHint bug and make it more attractive for potential contributors!
Rule: A bug is considered fixed only after it has been merged into the master branch of the main JSHint repository.
To report a bug simply create a new GitHub Issue and describe your problem or suggestion. We welcome all kind of feedback regarding JSHint including but not limited to:
Before reporting a bug look around to see if there are any open or closed tickets that cover your issue. And remember the wisdom: pull request > bug report > tweet.
If you're using so-called smart tabs
then we have an option smarttabs for you. Otherwise, your solution is to
run JSHint with a custom reporter that discards any warnings you don't like.
For example, this example reporter
discards all warnings about mixed tabs and spaces.
Look for a file named CONTRIBUTING.md in this repository. It contains our
contributing guidelines. We also have
a mailing list.
JSHint is distributed under the MIT License. One file and one file only (src/stable/jshint.js) is distributed under the slightly modified MIT License.
Core Team members:
Maintainer: Anton Kovalyov
We really appreciate all kind of feedback and contributions. Thanks for using and supporting JSHint!
2.1.6 (2013-07-29)
UPDATE: We just published another version, 2.1.7, which contains only one bugfix: #1199.
In this release we added two new arguments to our CLI program: exclude which
allows you to exclude directories from linting and prereq which allows you to
specify a file containing declarations of the global variables used throughout
your project. In addition to that, we added support for stdin. JSHint now
follows a UNIX convention where if a given file path is a dash (-) the the
program reads from stdin.
We also extended our ES6 coverage by adding support for yield statements and
import/export declarations. JSHint is still the only linter that can
parse most ES6 and Mozilla-specific JavaScript code.
For more changes, see the patch summary below.
--exclude argThanks to Terry Roe, Sindre Sorhus, Thomas Boyt, Nikolay S. Frantsev, XhmikosR, Jacob Rask, Kevin Chu, Tim Ruffles, Stephen Mathieson, Lukas Domnick, usrbincc for sending patches!
<a name="2.1.5"></a>
FAQs
Static analysis tool for JavaScript
The npm package jshint receives a total of 657,966 weekly downloads. As such, jshint popularity was classified as popular.
We found that jshint demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 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."