|
1 |
| -# eslint-config-semistandard |
| 1 | +# eslint-config-semistandard [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url] |
2 | 2 |
|
3 |
| -[![npm][npm-image]][npm-url] |
4 |
| -[![travis][travis-image]][travis-url] |
5 |
| - |
6 |
| -[npm-image]: https://img.shields.io/npm/v/eslint-config-semistandard.svg?style=flat-square |
7 |
| -[npm-url]: https://www.npmjs.com/package/eslint-config-semistandard |
8 |
| -[travis-image]: https://img.shields.io/travis/standard/eslint-config-semistandard.svg?style=flat-square |
| 3 | +[travis-image]: https://img.shields.io/travis/standard/eslint-config-semistandard.svg |
9 | 4 | [travis-url]: https://travis-ci.org/standard/eslint-config-semistandard
|
| 5 | +[npm-image]: https://img.shields.io/npm/v/eslint-config-semistandard.svg |
| 6 | +[npm-url]: https://www.npmjs.com/package/eslint-config-semistandard |
| 7 | +[downloads-image]: https://img.shields.io/npm/dm/eslint-config-semistandard.svg |
| 8 | +[downloads-url]: https://npmjs.org/package/eslint-config-semistandard |
| 9 | +[standard-image]: https://img.shields.io/badge/code_style-semistandard-brightgreen.svg |
| 10 | +[standard-url]: https://github.com/standard/semistandard |
| 11 | + |
| 12 | +#### One Semicolon for the Dark Lord on his dark throne |
10 | 13 |
|
11 |
| -eslint sharable config for semistandard – like [eslint-config-standard](https://github.com/feross/eslint-config-standard), but with semicolons |
| 14 | +An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) for [JavaScript Standard Style](http://standardjs.com) with semicolons sprinkled on top. |
12 | 15 |
|
13 | 16 | ## Install
|
14 | 17 |
|
15 |
| -Use [`install-peerdeps`](https://npm.im/install-peerdeps): |
| 18 | +This module is for advanced users. You probably want to use [`semistandard`](https://github.com/standard/semistandard) instead :) |
16 | 19 |
|
17 |
| -``` |
18 |
| -npx install-peerdeps --dev eslint-config-semistandard |
19 |
| -``` |
20 |
| -or the classic way: |
21 |
| -``` |
22 |
| -npm install --save-dev eslint-plugin-promise eslint-plugin-standard eslint-plugin-node eslint-plugin-import |
23 |
| -npm install --save-dev eslint-config-standard |
24 |
| -npm install --save-dev eslint-config-semistandard |
25 |
| -# note that eslint-plugin-promise, eslint-plugin-standard, eslint-plugin-node, eslint-plugin-import & eslint-config-standard are required peer dependencies |
| 20 | +```bash |
| 21 | +npm install eslint-config-semistandard |
26 | 22 | ```
|
27 | 23 |
|
28 | 24 | ## Usage
|
29 | 25 |
|
30 |
| -Read up on how to use [sharable configs](http://eslint.org/docs/developer-guide/shareable-configs) at the eslint website. |
31 |
| - |
32 |
| -For more details see [eslint-config-standard](https://github.com/feross/eslint-config-standard) |
| 26 | +This is just [eslint-config-standard](https://github.com/standard/eslint-config-standard) with semicolons set as required rather than banned. For further details, see [eslint-config-standard](https://github.com/standard/eslint-config-standard). |
33 | 27 |
|
34 |
| -## Contributing |
| 28 | +## Learn more |
35 | 29 |
|
36 |
| -Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first. |
| 30 | +For the full listing of rules, editor plugins, FAQs, and more, visit the main [JavaScript Standard Style repo](http://standardjs.com). |
37 | 31 |
|
38 | 32 | ## License
|
39 | 33 |
|
|
0 commit comments