| 1 | [](http://travis-ci.org/eslint/eslint)
|
| 2 | [](http://badge.fury.io/js/eslint)
|
| 3 |
|
| 4 | # ESLint
|
| 5 |
|
| 6 | [Website](http://eslint.org) | [Documentation](http://eslint.org/docs) | [Contributing](http://eslint.org/docs/developer-guide/contributing.html) | [Twitter](https://twitter.com/geteslint) | [Mailing List](https://groups.google.com/group/eslint)
|
| 7 |
|
| 8 | ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. In many ways, it is similar to JSLint and JSHint with a few exceptions:
|
| 9 |
|
| 10 | * ESLint uses Esprima for JavaScript parsing.
|
| 11 | * ESLint uses an AST to evaluate patterns in code.
|
| 12 | * ESLint is completely pluggable, every single rule is a plugin and you can add more at runtime.
|
| 13 |
|
| 14 | ## Installation
|
| 15 |
|
| 16 | You can install ESLint using npm:
|
| 17 |
|
| 18 | npm install -g eslint
|
| 19 |
|
| 20 | ## Usage
|
| 21 |
|
| 22 | eslint test.js test2.js
|
| 23 |
|
| 24 | ## Frequently Asked Questions
|
| 25 |
|
| 26 | ### Why don't you like JSHint???
|
| 27 |
|
| 28 | I do like JSHint. And I like Anton and Rick. Neither of those were deciding factors in creating this tool. The fact is that I've had a dire need for a JavaScript tool with pluggable linting rules. I had hoped JSHint would be able to do this, however after chatting with Anton, I found that the planned plugin infrastructure wasn't going to suit my purpose.
|
| 29 |
|
| 30 | ### I'm not giving up JSHint for this!
|
| 31 |
|
| 32 | That's not really a question, but I got it. I'm not trying to convince you that ESLint is better than JSHint. The only thing I know is that ESLint is better than JSHint for what I'm doing. In the off chance you're doing something similar, it might be better for you. Otherwise, keep using JSHint, I'm certainly not going to tell you to stop using it.
|
| 33 |
|
| 34 | ### How does ESLint performance compare to JSHint?
|
| 35 |
|
| 36 | ESLint is slower than JSHint, usually 2-3x slower on a single file. This is because ESLint uses Esprima to construct an AST before it can evaluate your code whereas JSHint evaluates your code as it's being parsed. The speed is also based on the number of rules you enable; the more rules you enable, the slower the process.
|
| 37 |
|
| 38 | Despite being slower, we believe that ESLint is fast enough to replace JSHint without causing significant pain.
|
| 39 |
|
| 40 | ### Who is using ESLint?
|
| 41 |
|
| 42 | The following projects are using ESLint to validate their JavaScript:
|
| 43 |
|
| 44 | * [WebKit](https://bugs.webkit.org/show_bug.cgi?id=125048)
|
| 45 | * [Drupal](https://www.drupal.org/node/2264205)
|
| 46 | * [Esprima](https://github.com/ariya/esprima)
|
| 47 |
|
| 48 | In addition, the following companies are using ESLint internally to validate their JavaScript:
|
| 49 |
|
| 50 | * [Box](https://box.com)
|
| 51 |
|
| 52 | ### What are the plans for ESLint?
|
| 53 |
|
| 54 | Check out the [ESLint Roadmap](https://github.com/eslint/eslint/wiki/Release-goals).
|
| 55 |
|
| 56 | ### What about ECMAScript 6 support?
|
| 57 |
|
| 58 | At the moment, ES6 support is turned off due to the experimental nature of the support in Esprima. There is basic support for `let` and `const`, but aside from that, the rest of the features are unsupported. We will re-evaluate ES6 support for v0.9.0.
|
| 59 |
|
| 60 | ### Where to ask for help?
|
| 61 |
|
| 62 | Join our [Mailing List](https://groups.google.com/group/eslint)
|