|
| 1 | +[eslint-url]: http://eslint.org |
| 2 | +[travis-badge]: https://travis-ci.org/strvcom/eslint-config-javascript.svg |
| 3 | +[travis-url]: https://travis-ci.org/strvcom/eslint-config-javascript |
| 4 | +[eslint-version]: https://img.shields.io/badge/ESLint->=4.6.0-brightgreen.svg |
| 5 | +[eslint-fixing]: http://eslint.org/docs/user-guide/command-line-interface#fix |
| 6 | +[flow-home]: https://flow.org |
| 7 | +[react-home]: http://reactjs.com |
| 8 | +[nodejs-home]: https://nodejs.org |
| 9 | + |
| 10 | + |
1 | 11 | # JavaScript Coding Standards |
2 | 12 |
|
3 | 13 | > Write bulletproof JavaScript like a pro! 😎 |
@@ -32,43 +42,36 @@ See the [tutorial](tutorial) directory for lots of example config files. |
32 | 42 |
|
33 | 43 | ### Available rulesets |
34 | 44 |
|
35 | | -> These are for Node.js code. |
| 45 | +#### For [Node.js][nodejs-home] |
36 | 46 |
|
37 | 47 | - @strv/javascript/environments/nodejs/v8-3 |
38 | 48 | - @strv/javascript/environments/nodejs/v8 |
39 | 49 | - @strv/javascript/environments/nodejs/v7 |
40 | 50 | - @strv/javascript/environments/nodejs/v6 |
41 | 51 | - @strv/javascript/environments/nodejs/optional |
42 | 52 |
|
43 | | -> These are for browser-specific code which uses React. |
| 53 | +#### For [React][react-home] |
44 | 54 |
|
45 | 55 | - @strv/javascript/environments/react/v15 |
46 | 56 | - @strv/javascript/environments/react/optional |
47 | 57 | - @strv/javascript/environments/react/accessibility |
| 58 | + > This one contains rules specific to web accessibility best practices. |
48 | 59 |
|
49 | | -> These are rules for [Flow][flow-home] type checker. |
50 | | -- @strv/javascript/environments/flow/recommended |
| 60 | +#### For [Flow][flow-home] |
51 | 61 |
|
52 | | -> This one includes rules which deal with how the code looks like and not how it works. It helps keep the code clean and consistent. |
| 62 | +- @strv/javascript/environments/flow/recommended |
53 | 63 |
|
54 | | -- @strv/javascript/coding-styles/recommended |
| 64 | +#### Coding styles |
55 | 65 |
|
56 | | -> This is a subset of the `recommended` coding style ruleset and includes only rules which [ESLint can fix automatically][eslint-fixing]. This is great for gradual adoption of coding style rulesets into existing projects. |
| 66 | +These rulesets include rules which deal with how the code looks like and not how it works. They help keep the code clean and consistent. |
57 | 67 |
|
| 68 | +- @strv/javascript/coding-styles/recommended |
58 | 69 | - @strv/javascript/coding-styles/fixable |
59 | | - |
60 | | -> This one contains coding style rules for Flow |
| 70 | + > This is a subset of the `recommended` coding style ruleset and includes only rules which [ESLint can fix automatically][eslint-fixing]. This is great for gradual adoption of coding style rulesets into existing projects. |
61 | 71 |
|
62 | 72 | - @strv/javascript/coding-styles/flow |
| 73 | + > This one contains coding style rules for code using Flow |
63 | 74 |
|
64 | 75 | ## License |
65 | 76 |
|
66 | 77 | This software is licensed under the **BSD-3-Clause License**. See the [LICENSE](LICENSE) file for more information. |
67 | | - |
68 | | - |
69 | | -[eslint-url]: http://eslint.org |
70 | | -[travis-badge]: https://travis-ci.org/strvcom/eslint-config-javascript.svg |
71 | | -[travis-url]: https://travis-ci.org/strvcom/eslint-config-javascript |
72 | | -[eslint-version]: https://img.shields.io/badge/ESLint->=4.6.0-brightgreen.svg |
73 | | -[eslint-fixing]: http://eslint.org/docs/user-guide/command-line-interface#fix |
74 | | -[flow-home]: https://flow.org |
|
0 commit comments