diff --git a/tools/node_modules/eslint/README.md b/tools/node_modules/eslint/README.md index 1f42b791c7a1a8..34fd0ef3612476 100644 --- a/tools/node_modules/eslint/README.md +++ b/tools/node_modules/eslint/README.md @@ -1,7 +1,6 @@ [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] -[![Test coverage][coveralls-image]][coveralls-url] [![Downloads][downloads-image]][downloads-url] [![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) [![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) @@ -27,7 +26,7 @@ ESLint is a tool for identifying and reporting on patterns found in ECMAScript/J ## Installation and Usage -Prerequisites: [Node.js](https://nodejs.org/en/) (>=4.x), npm version 2+. +Prerequisites: [Node.js](https://nodejs.org/en/) (>=6.14), npm version 3+. There are two ways to install ESLint: globally and locally. @@ -98,61 +97,67 @@ The names `"semi"` and `"quotes"` are the names of [rules](https://eslint.org/do The 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)). -## Sponsors +## Code of Conduct -* Site search ([eslint.org](https://eslint.org)) is sponsored by [Algolia](https://www.algolia.com) +ESLint adheres to the [JS Foundation Code of Conduct](https://js.foundation/community/code-of-conduct). -## Team +## Filing Issues -These folks keep the project moving and are resources for help. +Before filing an issue, please be sure to read the guidelines for what you're reporting: -### Technical Steering Committee (TSC) +* [Bug Report](https://eslint.org/docs/developer-guide/contributing/reporting-bugs) +* [Propose a New Rule](https://eslint.org/docs/developer-guide/contributing/new-rules) +* [Proposing a Rule Change](https://eslint.org/docs/developer-guide/contributing/rule-changes) +* [Request a Change](https://eslint.org/docs/developer-guide/contributing/changes) -* Nicholas C. Zakas ([@nzakas](https://github.com/nzakas)) -* Ilya Volodin ([@ilyavolodin](https://github.com/ilyavolodin)) -* Brandon Mills ([@btmills](https://github.com/btmills)) -* Gyandeep Singh ([@gyandeeps](https://github.com/gyandeeps)) -* Toru Nagashima ([@mysticatea](https://github.com/mysticatea)) -* Alberto Rodríguez ([@alberto](https://github.com/alberto)) -* Kai Cataldo ([@kaicataldo](https://github.com/kaicataldo)) -* Teddy Katz ([@not-an-aardvark](https://github.com/not-an-aardvark)) -* Kevin Partington ([@platinumazure](https://github.com/platinumazure)) +## Frequently Asked Questions -### Development Team +### I'm using JSCS, should I migrate to ESLint? -* Mathias Schreck ([@lo1tuma](https://github.com/lo1tuma)) -* Jamund Ferguson ([@xjamundx](https://github.com/xjamundx)) -* Ian VanSchooten ([@ianvs](https://github.com/ianvs)) -* Burak Yiğit Kaya ([@byk](https://github.com/byk)) -* Michael Ficarra ([@michaelficarra](https://github.com/michaelficarra)) -* Mark Pedrotti ([@pedrottimark](https://github.com/pedrottimark)) -* Oleg Gaidarenko ([@markelog](https://github.com/markelog)) -* Mike Sherov ([@mikesherov](https://github.com/mikesherov)) -* Henry Zhu ([@hzoo](https://github.com/hzoo)) -* Marat Dulin ([@mdevils](https://github.com/mdevils)) -* Alexej Yaroshevich ([@zxqfox](https://github.com/zxqfox)) -* Vitor Balocco ([@vitorbal](https://github.com/vitorbal)) -* James Henry ([@JamesHenry](https://github.com/JamesHenry)) -* Reyad Attiyat ([@soda0289](https://github.com/soda0289)) -* 薛定谔的猫 ([@Aladdin-ADD](https://github.com/Aladdin-ADD)) -* Victor Hom ([@VictorHom](https://github.com/VictorHom)) +Maybe, depending on how much you need it. [JSCS has reached end of life](https://eslint.org/blog/2016/07/jscs-end-of-life), but if it is working for you then there is no reason to move yet. There are still [a few issues](https://github.com/eslint/eslint/milestones/JSCS%20Compatibility) pending. We’ll announce when all of the changes necessary to support JSCS users in ESLint are complete and will start encouraging JSCS users to switch to ESLint at that time. -## Releases +If you are having issues with JSCS, you can try to move to ESLint. Have a look at our [migration guide](https://eslint.org/docs/user-guide/migrating-from-jscs). -We have scheduled releases every two weeks on Friday or Saturday. +### Does Prettier replace ESLint? -## Code of Conduct +No, 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. -ESLint adheres to the [JS Foundation Code of Conduct](https://js.foundation/community/code-of-conduct). +### Why can't ESLint find my plugins? -## Filing Issues +ESLint can be [globally or locally installed](#installation-and-usage). If you install ESLint globally, your plugins must also be installed globally; if you install ESLint locally, your plugins must also be installed locally. -Before filing an issue, please be sure to read the guidelines for what you're reporting: +If you are trying to run globally, make sure your plugins are installed globally (use `npm ls -g`). -* [Bug Report](https://eslint.org/docs/developer-guide/contributing/reporting-bugs) -* [Propose a New Rule](https://eslint.org/docs/developer-guide/contributing/new-rules) -* [Proposing a Rule Change](https://eslint.org/docs/developer-guide/contributing/rule-changes) -* [Request a Change](https://eslint.org/docs/developer-guide/contributing/changes) +If you are trying to run locally: + +* 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). +* Make sure you have run `npm install` and all your dependencies are installed. + +In all cases, make sure your plugins' peerDependencies have been installed as well. You can use `npm view eslint-plugin-myplugin peerDepencies` to see what peer dependencies `eslint-plugin-myplugin` has. + +### Does ESLint support JSX? + +Yes, 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. + +### What ECMAScript versions does ESLint support? + +ESLint has full support for ECMAScript 3, 5 (default), 2015, 2016, 2017, and 2018. 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). + +### What about experimental features? + +ESLint'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. + +In 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. + +Once 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. + +### Where to ask for help? + +Join our [Mailing List](https://groups.google.com/group/eslint) or [Chatroom](https://gitter.im/eslint/eslint). + +## Releases + +We have scheduled releases every two weeks on Friday or Saturday. ## Semantic Versioning Policy @@ -184,62 +189,158 @@ According to our policy, any minor update may report more errors than the previo [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint?ref=badge_large) -## Frequently Asked Questions - -### How is ESLint different from JSHint? - -The most significant difference is that ESLint has pluggable linting rules. That means you can use the rules it comes with, or you can extend it with rules created by others or by yourself! - -### How does ESLint performance compare to JSHint? - -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. - -Despite being slower, we believe that ESLint is fast enough to replace JSHint without causing significant pain. - -### I heard ESLint is going to replace JSCS? - -Yes. Since we are solving the same problems, ESLint and JSCS teams have decided to join forces and work together in the development of ESLint instead of competing with each other. You can read more about this in both [ESLint](https://eslint.org/blog/2016/04/welcoming-jscs-to-eslint) and [JSCS](https://medium.com/@markelog/jscs-end-of-the-line-bc9bf0b3fdb2#.u76sx334n) announcements. - -### So, should I stop using JSCS and start using ESLint? - -Maybe, depending on how much you need it. [JSCS has reached end of life](https://eslint.org/blog/2016/07/jscs-end-of-life), but if it is working for you then there is no reason to move yet. We are still working to smooth the transition. You can see our progress [here](https://github.com/eslint/eslint/milestones/JSCS%20Compatibility). We’ll announce when all of the changes necessary to support JSCS users in ESLint are complete and will start encouraging JSCS users to switch to ESLint at that time. - -If you are having issues with JSCS, you can try to move to ESLint. We are focusing our time and energy on JSCS compatibility issues. - -### Is ESLint just linting or does it also check style? - -ESLint does both traditional linting (looking for problematic patterns) and style checking (enforcement of conventions). You can use it for both. - -### Why can't ESLint find my plugins? - -ESLint can be [globally or locally installed](#installation-and-usage). If you install ESLint globally, your plugins must also be installed globally; if you install ESLint locally, your plugins must also be installed locally. - -If you are trying to run globally, make sure your plugins are installed globally (use `npm ls -g`). - -If you are trying to run locally: - -* 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). -* Make sure you have run `npm install` and all your dependencies are installed. - -In all cases, make sure your plugins' peerDependencies have been installed as well. You can use `npm view eslint-plugin-myplugin peerDepencies` to see what peer dependencies `eslint-plugin-myplugin` has. - -### Does ESLint support JSX? - -Yes, 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. +## Team -### What ECMAScript versions does ESLint support? +These folks keep the project moving and are resources for help. -ESLint has full support for ECMAScript 3, 5 (default), 2015, 2016, 2017, and 2018. 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). +### Technical Steering Committee (TSC) -### What about experimental features? +
+
+ + Nicholas C. Zakas + |
+
+
+ + Ilya Volodin + |
+
+
+ + Brandon Mills + |
+
+
+ + Gyandeep Singh + |
+
+
+ + Toru Nagashima + |
+
+
+ + Alberto Rodríguez + |
+
+
+ + Kai Cataldo + |
+
+
+ + Teddy Katz + |
+
+
+ + Kevin Partington + |
+
+
+ + Mathias Schreck + |
+
+
+ + Jamund Ferguson + |
+
+
+ + Ian VanSchooten + |
+
+
+ + Burak Yiğit Kaya + |
+
+
+ + Michael Ficarra + |
+
+
+ + Mark Pedrotti + |
+
+
+ + Oleg Gaidarenko + |
+
+
+ + Mike Sherov + |
+
+
+ + Henry Zhu + |
+
+
+ + Marat Dulin + |
+
+
+ + Alexej Yaroshevich + |
+
+
+ + Vitor Balocco + |
+
+
+ + James Henry + |
+
+
+ + Reyad Attiyat + |
+
+
+ + 薛定谔的猫 + |
+
+
+ + Victor Hom + |
+