130
edits
DevTools/CodingStandards: Difference between revisions
New intro and ESLint section
(New intro and ESLint section) |
|||
| Line 1: | Line 1: | ||
The DevTools JS code base is quite large, and a lot of different people contribute to it all the time, so it's important that a set of standards be shared when coding so that the code is consistent, written in a predictable style that also hopefully helps avoid common mistakes. | |||
== JS linting with ESLint == | |||
In order to help people write coding standard-compliant code from the start and avoid wasting time during code reviews, a set of ESLint configuration files have been added to the DevTools code base so that the JS code can be analyzed automatically. | |||
This automatic linting can happen either while coding, in a code editor, or when using the command line. | |||
* Learn more [http://eslint.org/ about ESLint], | |||
* learn how to [http://eslint.org/docs/user-guide/integrations integrate ESLint in your code editor], | |||
* or [http://eslint.org/docs/user-guide/command-line-interface run it on the command line]. | |||
== Be consistent within a file! == | == Be consistent within a file! == | ||