runt18 / jshint

JSHint is a tool that helps to detect errors and potential problems in your JavaScript code

JSHint, A Static Code Analysis Tool for JavaScript

[ Use it online • Docs • FAQ • Install • Contribute • Blog • Twitter ]

JSHint is a community-driven tool to detect errors and potential problems in JavaScript code and to enforce your team's coding conventions. It is very flexible so you can easily adjust it to your particular coding guidelines and the environment you expect your code to execute in. JSHint is open source and will always stay this way.

Our goal

The goal of this project is to help JavaScript developers write complex programs without worrying about typos and language gotchas.

Any code base eventually becomes huge at some point, and simple mistakes—that would not show themselves when written—can become show stoppers and waste hours of debugging. And this is when static code analysis tools come into play and help developers to spot such problems. JSHint scans a program written in JavaScript and reports about commonly made mistakes and potential bugs. The potential problem could be a syntax error, a bug due to implicit type conversion, a leaking variable or something else.

Only 15% of all programs linted on jshint.com pass the JSHint checks. In all other cases, JSHint finds some red flags that could've been bugs or potential problems.

Please note, that while static code analysis tools can spot many different kind of mistakes, it can't detect if your program is correct, fast or has memory leaks. You should always combine tools like JSHint with unit and functional tests as well as with code reviews.

Reporting a bug

To report a bug simply create a new GitHub Issue and describe your problem or suggestion. We welcome all kinds of feedback regarding JSHint including but not limited to:

• When JSHint doesn't work as expected
• When JSHint complains about valid JavaScript code that works in all browsers
• When you simply want a new option or feature

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.

Who uses JSHint?

Engineers from these companies and projects use JSHint:

• Mozilla
• Wikipedia
• Facebook
• Twitter
• Bootstrap
• Disqus
• Medium
• Yahoo!
• SmugMug
• jQuery
• PDF.js
• Coursera
• Adobe Brackets
• Apache Cordova
• RedHat
• SoundCloud
• Nodejitsu
• Yelp
• Voxer
• EnyoJS
• QuickenLoans
• oDesk
• Cloud9
• CodeClimate
• Pandoo TEK
• Zendesk
• Apache CouchDB

And many more!

License

Most files are published using the standard MIT Expat license. One file, however, is provided under a slightly modified version of that license. The so-called JSON license is a non-free license, and unfortunately, we can't change it due to historical reasons. This license is included as an in-line within the file it concerns.

The JSHint Team

JSHint is currently maintained by Rick Waldron, Caitlin Potter, Mike Sherov, Mike Pennisi, and Luke Page.

Thank you!

We really appreciate all kinds of feedback and contributions. Thanks for using and supporting JSHint!