1[](https://www.npmjs.com/package/eslint) 2[](https://www.npmjs.com/package/eslint) 3[](https://github.com/eslint/eslint/actions) 4[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint?ref=badge_shield) 5<br /> 6[](https://opencollective.com/eslint) 7[](https://opencollective.com/eslint) 8[](https://twitter.com/intent/user?screen_name=geteslint) 9 10# ESLint 11 12[Website](https://eslint.org) | 13[Configuring](https://eslint.org/docs/user-guide/configuring) | 14[Rules](https://eslint.org/docs/rules/) | 15[Contributing](https://eslint.org/docs/developer-guide/contributing) | 16[Reporting Bugs](https://eslint.org/docs/developer-guide/contributing/reporting-bugs) | 17[Code of Conduct](https://js.foundation/community/code-of-conduct) | 18[Twitter](https://twitter.com/geteslint) | 19[Mailing List](https://groups.google.com/group/eslint) | 20[Chat Room](https://eslint.org/chat) 21 22ESLint 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: 23 24* ESLint uses [Espree](https://github.com/eslint/espree) for JavaScript parsing. 25* ESLint uses an AST to evaluate patterns in code. 26* ESLint is completely pluggable, every single rule is a plugin and you can add more at runtime. 27 28## Table of Contents 29 301. [Installation and Usage](#installation-and-usage) 312. [Configuration](#configuration) 323. [Code of Conduct](#code-of-conduct) 334. [Filing Issues](#filing-issues) 345. [Frequently Asked Questions](#faq) 356. [Releases](#releases) 367. [Semantic Versioning Policy](#semantic-versioning-policy) 378. [License](#license) 389. [Team](#team) 3910. [Sponsors](#sponsors) 4011. [Technology Sponsors](#technology-sponsors) 41 42## <a name="installation-and-usage"></a>Installation and Usage 43 44Prerequisites: [Node.js](https://nodejs.org/) (`^10.12.0`, or `>=12.0.0`) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.) 45 46You can install ESLint using npm: 47 48``` 49$ npm install eslint --save-dev 50``` 51 52You should then set up a configuration file: 53 54``` 55$ ./node_modules/.bin/eslint --init 56``` 57 58After that, you can run ESLint on any file or directory like this: 59 60``` 61$ ./node_modules/.bin/eslint yourfile.js 62``` 63 64## <a name="configuration"></a>Configuration 65 66After running `eslint --init`, you'll have a `.eslintrc` file in your directory. In it, you'll see some rules configured like this: 67 68```json 69{ 70 "rules": { 71 "semi": ["error", "always"], 72 "quotes": ["error", "double"] 73 } 74} 75``` 76 77The names `"semi"` and `"quotes"` are the names of [rules](https://eslint.org/docs/rules) in ESLint. The first value is the error level of the rule and can be one of these values: 78 79* `"off"` or `0` - turn the rule off 80* `"warn"` or `1` - turn the rule on as a warning (doesn't affect exit code) 81* `"error"` or `2` - turn the rule on as an error (exit code will be 1) 82 83The three error levels allow you fine-grained control over how ESLint applies rules (for more configuration options and details, see the [configuration docs](https://eslint.org/docs/user-guide/configuring)). 84 85## <a name="code-of-conduct"></a>Code of Conduct 86 87ESLint adheres to the [JS Foundation Code of Conduct](https://js.foundation/community/code-of-conduct). 88 89## <a name="filing-issues"></a>Filing Issues 90 91Before filing an issue, please be sure to read the guidelines for what you're reporting: 92 93* [Bug Report](https://eslint.org/docs/developer-guide/contributing/reporting-bugs) 94* [Propose a New Rule](https://eslint.org/docs/developer-guide/contributing/new-rules) 95* [Proposing a Rule Change](https://eslint.org/docs/developer-guide/contributing/rule-changes) 96* [Request a Change](https://eslint.org/docs/developer-guide/contributing/changes) 97 98## <a name="faq"></a>Frequently Asked Questions 99 100### I'm using JSCS, should I migrate to ESLint? 101 102Yes. [JSCS has reached end of life](https://eslint.org/blog/2016/07/jscs-end-of-life) and is no longer supported. 103 104We have prepared a [migration guide](https://eslint.org/docs/user-guide/migrating-from-jscs) to help you convert your JSCS settings to an ESLint configuration. 105 106We are now at or near 100% compatibility with JSCS. If you try ESLint and believe we are not yet compatible with a JSCS rule/configuration, please create an issue (mentioning that it is a JSCS compatibility issue) and we will evaluate it as per our normal process. 107 108### Does Prettier replace ESLint? 109 110No, ESLint does both traditional linting (looking for problematic patterns) and style checking (enforcement of conventions). You can use ESLint for everything, or you can combine both using Prettier to format your code and ESLint to catch possible errors. 111 112### Why can't ESLint find my plugins? 113 114* Make sure your plugins (and ESLint) are both in your project's `package.json` as devDependencies (or dependencies, if your project uses ESLint at runtime). 115* Make sure you have run `npm install` and all your dependencies are installed. 116* Make sure your plugins' peerDependencies have been installed as well. You can use `npm view eslint-plugin-myplugin peerDependencies` to see what peer dependencies `eslint-plugin-myplugin` has. 117 118### Does ESLint support JSX? 119 120Yes, ESLint natively supports parsing JSX syntax (this must be enabled in [configuration](https://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. 121 122### What ECMAScript versions does ESLint support? 123 124ESLint has full support for ECMAScript 3, 5 (default), 2015, 2016, 2017, 2018, 2019, and 2020. You can set your desired ECMAScript syntax (and other settings, like global variables or your target environments) through [configuration](https://eslint.org/docs/user-guide/configuring). 125 126### What about experimental features? 127 128ESLint's parser only officially supports the latest final ECMAScript standard. We will make changes to core rules in order to avoid crashes on stage 3 ECMAScript syntax proposals (as long as they are implemented using the correct experimental ESTree syntax). We may make changes to core rules to better work with language extensions (such as JSX, Flow, and TypeScript) on a case-by-case basis. 129 130In other cases (including if rules need to warn on more or fewer cases due to new syntax, rather than just not crashing), we recommend you use other parsers and/or rule plugins. If you are using Babel, you can use the [babel-eslint](https://github.com/babel/babel-eslint) parser and [eslint-plugin-babel](https://github.com/babel/eslint-plugin-babel) to use any option available in Babel. 131 132Once a language feature has been adopted into the ECMAScript standard (stage 4 according to the [TC39 process](https://tc39.github.io/process-document/)), we will accept issues and pull requests related to the new feature, subject to our [contributing guidelines](https://eslint.org/docs/developer-guide/contributing). Until then, please use the appropriate parser and plugin(s) for your experimental feature. 133 134### Where to ask for help? 135 136Join our [Mailing List](https://groups.google.com/group/eslint) or [Chatroom](https://eslint.org/chat). 137 138## <a name="releases"></a>Releases 139 140We have scheduled releases every two weeks on Friday or Saturday. You can follow a [release issue](https://github.com/eslint/eslint/issues?q=is%3Aopen+is%3Aissue+label%3Arelease) for updates about the scheduling of any particular release. 141 142## <a name="semantic-versioning-policy"></a>Semantic Versioning Policy 143 144ESLint follows [semantic versioning](https://semver.org). However, due to the nature of ESLint as a code quality tool, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, we've defined the following semantic versioning policy for ESLint: 145 146* Patch release (intended to not break your lint build) 147 * A bug fix in a rule that results in ESLint reporting fewer errors. 148 * A bug fix to the CLI or core (including formatters). 149 * Improvements to documentation. 150 * Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage. 151 * Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone). 152* Minor release (might break your lint build) 153 * A bug fix in a rule that results in ESLint reporting more errors. 154 * A new rule is created. 155 * A new option to an existing rule that does not result in ESLint reporting more errors by default. 156 * An existing rule is deprecated. 157 * A new CLI capability is created. 158 * New capabilities to the public API are added (new classes, new methods, new arguments to existing methods, etc.). 159 * A new formatter is created. 160 * `eslint:recommended` is updated and will result in strictly fewer errors (e.g., rule removals). 161* Major release (likely to break your lint build) 162 * `eslint:recommended` is updated and may result in new errors (e.g., rule additions, most rule option updates). 163 * A new option to an existing rule that results in ESLint reporting more errors by default. 164 * An existing formatter is removed. 165 * Part of the public API is removed or changed in an incompatible way. 166 167According to our policy, any minor update may report more errors than the previous release (ex: from a bug fix). As such, we recommend using the tilde (`~`) in `package.json` e.g. `"eslint": "~3.1.0"` to guarantee the results of your builds. 168 169## <a name="license"></a>License 170 171[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint?ref=badge_large) 172 173## <a name="team"></a>Team 174 175These folks keep the project moving and are resources for help. 176 177<!-- NOTE: This section is autogenerated. Do not manually edit.--> 178<!--teamstart--> 179 180### Technical Steering Committee (TSC) 181 182The people who manage releases, review feature requests, and meet regularly to ensure ESLint is properly maintained. 183 184<table><tbody><tr><td align="center" valign="top" width="11%"> 185<a href="https://github.com/nzakas"> 186<img src="https://github.com/nzakas.png?s=75" width="75" height="75"><br /> 187Nicholas C. Zakas 188</a> 189</td><td align="center" valign="top" width="11%"> 190<a href="https://github.com/btmills"> 191<img src="https://github.com/btmills.png?s=75" width="75" height="75"><br /> 192Brandon Mills 193</a> 194</td><td align="center" valign="top" width="11%"> 195<a href="https://github.com/mysticatea"> 196<img src="https://github.com/mysticatea.png?s=75" width="75" height="75"><br /> 197Toru Nagashima 198</a> 199</td><td align="center" valign="top" width="11%"> 200<a href="https://github.com/kaicataldo"> 201<img src="https://github.com/kaicataldo.png?s=75" width="75" height="75"><br /> 202Kai Cataldo 203</a> 204</td></tr></tbody></table> 205 206 207### Reviewers 208 209The people who review and implement new features. 210 211<table><tbody><tr><td align="center" valign="top" width="11%"> 212<a href="https://github.com/aladdin-add"> 213<img src="https://github.com/aladdin-add.png?s=75" width="75" height="75"><br /> 214薛定谔的猫 215</a> 216</td><td align="center" valign="top" width="11%"> 217<a href="https://github.com/mdjermanovic"> 218<img src="https://github.com/mdjermanovic.png?s=75" width="75" height="75"><br /> 219Milos Djermanovic 220</a> 221</td></tr></tbody></table> 222 223 224 225 226### Committers 227 228The people who review and fix bugs and help triage issues. 229 230<table><tbody><tr><td align="center" valign="top" width="11%"> 231<a href="https://github.com/g-plane"> 232<img src="https://github.com/g-plane.png?s=75" width="75" height="75"><br /> 233Pig Fang 234</a> 235</td><td align="center" valign="top" width="11%"> 236<a href="https://github.com/yeonjuan"> 237<img src="https://github.com/yeonjuan.png?s=75" width="75" height="75"><br /> 238YeonJuan 239</a> 240</td></tr></tbody></table> 241 242 243<!--teamend--> 244 245## <a name="sponsors"></a>Sponsors 246 247The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://opencollective.com/eslint) to get your logo on our README and website. 248 249<!-- NOTE: This section is autogenerated. Do not manually edit.--> 250<!--sponsorsstart--> 251<h3>Gold Sponsors</h3> 252<p><a href="https://www.salesforce.com"><img src="https://images.opencollective.com/salesforce/ca8f997/logo.png" alt="Salesforce" height="96"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="96"></a> <a href="https://aka.ms/microsoftfossfund"><img src="https://avatars1.githubusercontent.com/u/67931232?u=7fddc652a464d7151b97e8f108392af7d54fa3e8&v=4" alt="Microsoft FOSS Fund Sponsorships" height="96"></a></p><h3>Silver Sponsors</h3> 253<p><a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a> <a href="https://www.ampproject.org/"><img src="https://images.opencollective.com/amp/c8a3b25/logo.png" alt="AMP Project" height="64"></a></p><h3>Bronze Sponsors</h3> 254<p><a href="https://www.betacalendars.com/printable-calendar"><img src="https://images.opencollective.com/betacalendars/9334b33/logo.png" alt="2021 calendar" height="32"></a> <a href="https://buy.fineproxy.org/eng/"><img src="https://images.opencollective.com/buy-fineproxy-org/2002c40/logo.png" alt="Buy.Fineproxy.Org" height="32"></a> <a href="https://www.veikkaajat.com"><img src="https://images.opencollective.com/veikkaajat/b92b427/logo.png" alt="Veikkaajat.com" height="32"></a> <a href="https://www.nettikasinot.media/"><img src="https://images.opencollective.com/nettikasinot-media/2dba7da/logo.png" alt="Nettikasinot.media" height="32"></a> <a href="https://mytruemedia.com/"><img src="https://images.opencollective.com/my-true-media/03e2168/logo.png" alt="My True Media" height="32"></a> <a href="https://www.norgekasino.com"><img src="https://images.opencollective.com/norgekasino/ecfd57a/logo.png" alt="Norgekasino" height="32"></a> <a href="https://www.japanesecasino.com/"><img src="https://images.opencollective.com/japanesecasino/b0ffe3c/logo.png" alt="Japanesecasino" height="32"></a> <a href="https://www.casinotop.com/"><img src="https://images.opencollective.com/casinotop-com/10fd95b/logo.png" alt="CasinoTop.com" height="32"></a> <a href="https://www.casinotopp.net/"><img src="https://images.opencollective.com/casino-topp/1dd399a/logo.png" alt="Casino Topp" height="32"></a> <a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://www.kasinot.fi"><img src="https://images.opencollective.com/kasinot-fi/e09aa2e/logo.png" alt="Kasinot.fi" height="32"></a> <a href="https://www.pelisivut.com"><img src="https://images.opencollective.com/pelisivut/04f08f2/logo.png" alt="Pelisivut" height="32"></a> <a href="https://www.nettikasinot.org"><img src="https://images.opencollective.com/nettikasinot-org/53a4b44/logo.png" alt="Nettikasinot.org" height="32"></a> <a href="https://www.bonus.com.de/freispiele"><img src="https://images.opencollective.com/bonusfinder-deutschland/646169e/logo.png" alt="BonusFinder Deutschland" height="32"></a> <a href="null"><img src="https://images.opencollective.com/bugsnag-stability-monitoring/c2cef36/logo.png" alt="Bugsnag Stability Monitoring" height="32"></a> <a href="https://mixpanel.com"><img src="https://images.opencollective.com/mixpanel/cd682f7/logo.png" alt="Mixpanel" height="32"></a> <a href="https://www.vpsserver.com"><img src="https://images.opencollective.com/vpsservercom/logo.png" alt="VPS Server" height="32"></a> <a href="https://icons8.com"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8: free icons, photos, illustrations, and music" height="32"></a> <a href="https://discordapp.com"><img src="https://images.opencollective.com/discordapp/7e3d9a9/logo.png" alt="Discord" height="32"></a> <a href="https://themeisle.com"><img src="https://images.opencollective.com/themeisle/d5592fe/logo.png" alt="ThemeIsle" height="32"></a> <a href="https://www.marfeel.com/"><img src="https://images.opencollective.com/marfeel/4b88e30/logo.png" alt="Marfeel" height="32"></a> <a href="https://www.firesticktricks.com"><img src="https://images.opencollective.com/fire-stick-tricks/b8fbe2c/logo.png" alt="Fire Stick Tricks" height="32"></a></p> 255<!--sponsorsend--> 256 257## <a name="technology-sponsors"></a>Technology Sponsors 258 259* Site search ([eslint.org](https://eslint.org)) is sponsored by [Algolia](https://www.algolia.com) 260* Hosting for ([eslint.org](https://eslint.org)) is sponsored by [Netlify](https://www.netlify.com) 261* Password management is sponsored by [1Password](https://www.1password.com) 262