| 1 | [](http://travis-ci.org/eslint/eslint)
|
| 2 |
|
| 3 | # ESLint
|
| 4 |
|
| 5 | 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:
|
| 6 |
|
| 7 | * ESLint uses Esprima for JavaScript parsing.
|
| 8 | * ESLint uses an AST to evaluate patterns in code.
|
| 9 | * ESLint is completely pluggable, every single rule is a plugin and you can add more at runtime.
|
| 10 |
|
| 11 | ## Alpha Version
|
| 12 |
|
| 13 | ESLint, as of v0.1.0, is in alpha, meaning that there is some stability but you shouldn't be depending on it as your only means of code verification at this time. The alpha version is intended to gather feedback from the community, catch bugs, and determine general direction for the project.
|
| 14 |
|
| 15 | When ESLint v0.5.0 is released, it will be in beta and will have more stability in terms of interface and API.
|
| 16 |
|
| 17 | ## Installation
|
| 18 |
|
| 19 | You can install ESLint using npm:
|
| 20 |
|
| 21 | npm i -g eslint
|
| 22 |
|
| 23 | ## Usage
|
| 24 |
|
| 25 | eslint test.js test2.js
|
| 26 |
|
| 27 | ## Frequently Asked Questions
|
| 28 | ### Why don't you like JSHint???
|
| 29 |
|
| 30 | I do like JSHint. And I like Anton. 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.
|
| 31 |
|
| 32 | ### I'm not giving up JSHint for this!
|
| 33 |
|
| 34 | 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.
|
| 35 |
|
| 36 | ### What are the plans for ESLint?
|
| 37 |
|
| 38 | Our first goal for ESLint is to hit rule and stability parity with JSHint so that developers can start using ESLint as part of their production toolchain. The master list of JSHint features to be implemented is maintained in this [Google Docs spreadsheet](https://docs.google.com/spreadsheet/lv?key=0Ap5QGaRT4AJ_dGV6VXBlMEw3NHhVRl9vQ0lIX2FnVlE&usp=sharing). To read about plans beyond parity with JSHint, check out the [ESLint Roadmap](https://github.com/eslint/eslint/wiki/Release-goals).
|
| 39 |
|
| 40 | ### What about ECMAScript 6 support?
|
| 41 |
|
| 42 | 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 after v0.5.0.
|
| 43 |
|
| 44 | ### Where to ask for help?
|
| 45 |
|
| 46 | Join our [Mailing List](https://groups.google.com/group/eslint)
|