~webapps/unity-js-scopes/node.js

« back to all changes in this revision

Viewing changes to tools/eslint/README.md

  • Committer: Marcus Tomlinson
  • Date: 2015-11-13 07:59:04 UTC
  • Revision ID: marcus.tomlinson@canonical.com-20151113075904-h0swczmoq1rvstfc
Node v4 (stable)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
[![NPM version][npm-image]][npm-url]
 
2
[![build status][travis-image]][travis-url]
 
3
[![Test coverage][coveralls-image]][coveralls-url]
 
4
[![Downloads][downloads-image]][downloads-url]
 
5
[![Bountysource](https://www.bountysource.com/badge/tracker?tracker_id=282608)](https://www.bountysource.com/trackers/282608-eslint?utm_source=282608&utm_medium=shield&utm_campaign=TRACKER_BADGE)
 
6
[![Join the chat at https://gitter.im/eslint/eslint](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/eslint/eslint?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
7
 
 
8
# ESLint
 
9
 
 
10
[Website](http://eslint.org) | [Configuring](http://eslint.org/docs/user-guide/configuring) | [Rules](http://eslint.org/docs/rules/) | [Contributing](http://eslint.org/docs/developer-guide/contributing) | [Twitter](https://twitter.com/geteslint) | [Mailing List](https://groups.google.com/group/eslint)
 
11
 
 
12
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:
 
13
 
 
14
* ESLint uses [Espree](https://github.com/eslint/espree) for JavaScript parsing.
 
15
* ESLint uses an AST to evaluate patterns in code.
 
16
* ESLint is completely pluggable, every single rule is a plugin and you can add more at runtime.
 
17
 
 
18
## Installation
 
19
 
 
20
You can install ESLint using npm:
 
21
 
 
22
    npm install -g eslint
 
23
 
 
24
## Usage
 
25
 
 
26
If it's your first time using ESLint, you should set up a config file using `--init`:
 
27
 
 
28
    eslint --init
 
29
 
 
30
After that, you can run ESLint on any JavaScript file:
 
31
 
 
32
    eslint test.js test2.js
 
33
 
 
34
## Team
 
35
 
 
36
These folks keep the project moving and are resources for help:
 
37
 
 
38
* Nicholas C. Zakas ([@nzakas](https://github.com/nzakas)) - project lead
 
39
* Ilya Volodin ([@ilyavolodin](https://github.com/ilyavolodin)) - reviewer
 
40
* Brandon Mills ([@btmills](https://github.com/btmills)) - reviewer
 
41
* Mathias Schreck ([@lo1tuma](https://github.com/lo1tuma)) - committer
 
42
* Gyandeep Singh ([@gyandeeps](https://github.com/gyandeeps)) - committer
 
43
* Jamund Ferguson ([@xjamundx](https://github.com/xjamundx)) - committer
 
44
 
 
45
 
 
46
## Frequently Asked Questions
 
47
 
 
48
### Why don't you like JSHint???
 
49
 
 
50
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.
 
51
 
 
52
### I'm not giving up JSHint for this!
 
53
 
 
54
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.
 
55
 
 
56
### How does ESLint performance compare to JSHint and JSCS?
 
57
 
 
58
ESLint is slower than JSHint, usually 2-3x slower on a single file. This is because ESLint uses Espree 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.
 
59
 
 
60
Despite being slower, we believe that ESLint is fast enough to replace JSHint without causing significant pain.
 
61
 
 
62
ESLint is faster than JSCS, as ESLint uses a single-pass traversal for analysis whereas JSCS using a querying model.
 
63
 
 
64
If you are using both JSHint and JSCS on your files, then using just ESLint will be faster.
 
65
 
 
66
### Is ESLint just linting or does it also check style?
 
67
 
 
68
ESLint does both traditional linting (looking for problematic patterns) and style checking (enforcement of conventions). You can use it for both.
 
69
 
 
70
### Who is using ESLint?
 
71
 
 
72
The following projects are using ESLint to validate their JavaScript:
 
73
 
 
74
* [Drupal](https://www.drupal.org/node/2274223)
 
75
* [Esprima](https://github.com/ariya/esprima)
 
76
* [io.js](https://github.com/iojs/io.js/commit/f9dd34d301ab385ae316769b85ef916f9b70b6f6)
 
77
* [WebKit](https://bugs.webkit.org/show_bug.cgi?id=125048)
 
78
 
 
79
In addition, the following companies are using ESLint internally to validate their JavaScript:
 
80
 
 
81
* [Box](https://box.com)
 
82
* [CustomInk](https://customink.com)
 
83
* [Fitbit](http://www.fitbit.com)
 
84
* [HolidayCheck](http://holidaycheck.de)
 
85
* [the native web](http://www.thenativeweb.io)
 
86
 
 
87
### What about ECMAScript 6 support?
 
88
 
 
89
ESLint has full support for ECMAScript 6. By default, this support is off. You can enable ECMAScript 6 support through [configuration](http://eslint.org/docs/user-guide/configuring).
 
90
 
 
91
### Does ESLint support JSX?
 
92
 
 
93
Yes, ESLint natively supports parsing JSX syntax (this must be enabled in [configuration](http://eslint.org/docs/user-guide/configuring).). Please note that supporting JSX syntax *is not* the same as supporting React. React applies specific semantics to JSX syntax that ESLint doesn't recognize. We recommend using [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) if you are using React and want React semantics.
 
94
 
 
95
### What about ECMAScript 7/2016 and experimental features?
 
96
 
 
97
ESLint doesn't natively support experimental ECMAScript language features. You can use [babel-eslint](https://github.com/babel/babel-eslint) to use any option available in Babel.
 
98
 
 
99
### Where to ask for help?
 
100
 
 
101
Join our [Mailing List](https://groups.google.com/group/eslint) or [Chatroom](https://gitter.im/eslint/eslint)
 
102
 
 
103
 
 
104
[npm-image]: https://img.shields.io/npm/v/eslint.svg?style=flat-square
 
105
[npm-url]: https://npmjs.org/package/eslint
 
106
[travis-image]: https://img.shields.io/travis/eslint/eslint/master.svg?style=flat-square
 
107
[travis-url]: https://travis-ci.org/eslint/eslint
 
108
[coveralls-image]: https://img.shields.io/coveralls/eslint/eslint/master.svg?style=flat-square
 
109
[coveralls-url]: https://coveralls.io/r/eslint/eslint?branch=master
 
110
[downloads-image]: http://img.shields.io/npm/dm/eslint.svg?style=flat-square
 
111
[downloads-url]: https://npmjs.org/package/eslint