Skip to content

Commit 3c5d6cb

Browse files
committedJun 14, 2021
Sync documentation with eslint-config-standard
1 parent a53c7c9 commit 3c5d6cb

File tree

4 files changed

+48
-100
lines changed

4 files changed

+48
-100
lines changed
 

‎.github/PULL_REQUEST_TEMPLATE.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!--
2+
Proposing a new rule or a rule change? Please open an issue here first:
3+
https://github.com/standard/standard/issues
4+
5+
If the rule has been accepted and you want to send a PR, please send it
6+
to: https://github.com/standard/standard. Add the rule to the
7+
'eslintrc.json' file, in the "rules" field. This is where rules live
8+
until a new major version of standard is released, at which point all
9+
new rules and rule changes are moved into eslint-config-standard.
10+
-->

‎CONTRIBUTING.md

-57
This file was deleted.

‎README.md

+17-23
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,33 @@
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]
22

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
94
[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
1013

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.
1215

1316
## Install
1417

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 :)
1619

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
2622
```
2723

2824
## Usage
2925

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).
3327

34-
## Contributing
28+
## Learn more
3529

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).
3731

3832
## License
3933

‎package.json

+21-20
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "eslint-config-semistandard",
3-
"description": "eslint sharable config for semistandard",
3+
"description": "JavaScript Semistandard Style - ESLint Shareable Config",
44
"version": "15.0.1",
55
"author": "Dan Flettre <flettre@gmail.com>",
66
"bugs": {
@@ -17,30 +17,31 @@
1717
},
1818
"homepage": "https://github.com/standard/eslint-config-semistandard",
1919
"keywords": [
20-
"semistandard",
21-
"style checker",
22-
"code style",
20+
"JavaScript Standard Style",
21+
"check",
22+
"checker",
23+
"code",
2324
"code checker",
2425
"code linter",
25-
"style linter",
26-
"simple",
27-
"policy",
28-
"style",
29-
"code",
30-
"lint",
26+
"code standards",
27+
"code style",
28+
"enforce",
3129
"eslint",
32-
"jshint",
33-
"jscs",
30+
"eslintconfig",
3431
"hint",
35-
"enforce",
36-
"check",
37-
"verify",
32+
"jscs",
33+
"jshint",
34+
"lint",
35+
"policy",
3836
"quality",
39-
"checker",
40-
"code standards",
41-
"JavaScript Semistandard Style",
42-
"semistandard style",
43-
"eslintconfig"
37+
"simple",
38+
"semistandard",
39+
"standard",
40+
"standard style",
41+
"style",
42+
"style checker",
43+
"style linter",
44+
"verify"
4445
],
4546
"license": "ISC",
4647
"main": "index.js",

0 commit comments

Comments
 (0)
Please sign in to comment.