Skip to content

Commit

Permalink
Sync documentation with eslint-config-standard
Browse files Browse the repository at this point in the history
  • Loading branch information
voxpelli committed Jun 14, 2021
1 parent a53c7c9 commit 3c5d6cb
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 100 deletions.
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!--
Proposing a new rule or a rule change? Please open an issue here first:
https://github.com/standard/standard/issues
If the rule has been accepted and you want to send a PR, please send it
to: https://github.com/standard/standard. Add the rule to the
'eslintrc.json' file, in the "rules" field. This is where rules live
until a new major version of standard is released, at which point all
new rules and rule changes are moved into eslint-config-standard.
-->
57 changes: 0 additions & 57 deletions CONTRIBUTING.md

This file was deleted.

40 changes: 17 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,33 @@
# eslint-config-semistandard
# 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]

[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]

[npm-image]: https://img.shields.io/npm/v/eslint-config-semistandard.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/eslint-config-semistandard
[travis-image]: https://img.shields.io/travis/standard/eslint-config-semistandard.svg?style=flat-square
[travis-image]: https://img.shields.io/travis/standard/eslint-config-semistandard.svg
[travis-url]: https://travis-ci.org/standard/eslint-config-semistandard
[npm-image]: https://img.shields.io/npm/v/eslint-config-semistandard.svg
[npm-url]: https://www.npmjs.com/package/eslint-config-semistandard
[downloads-image]: https://img.shields.io/npm/dm/eslint-config-semistandard.svg
[downloads-url]: https://npmjs.org/package/eslint-config-semistandard
[standard-image]: https://img.shields.io/badge/code_style-semistandard-brightgreen.svg
[standard-url]: https://github.com/standard/semistandard

#### One Semicolon for the Dark Lord on his dark throne

eslint sharable config for semistandard – like [eslint-config-standard](https://github.com/feross/eslint-config-standard), but with semicolons
An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) for [JavaScript Standard Style](http://standardjs.com) with semicolons sprinkled on top.

## Install

Use [`install-peerdeps`](https://npm.im/install-peerdeps):
This module is for advanced users. You probably want to use [`semistandard`](https://github.com/standard/semistandard) instead :)

```
npx install-peerdeps --dev eslint-config-semistandard
```
or the classic way:
```
npm install --save-dev eslint-plugin-promise eslint-plugin-standard eslint-plugin-node eslint-plugin-import
npm install --save-dev eslint-config-standard
npm install --save-dev eslint-config-semistandard
# note that eslint-plugin-promise, eslint-plugin-standard, eslint-plugin-node, eslint-plugin-import & eslint-config-standard are required peer dependencies
```bash
npm install eslint-config-semistandard
```

## Usage

Read up on how to use [sharable configs](http://eslint.org/docs/developer-guide/shareable-configs) at the eslint website.

For more details see [eslint-config-standard](https://github.com/feross/eslint-config-standard)
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).

## Contributing
## Learn more

Contributions welcome! Please read the [contributing guidelines](CONTRIBUTING.md) first.
For the full listing of rules, editor plugins, FAQs, and more, visit the main [JavaScript Standard Style repo](http://standardjs.com).

## License

Expand Down
41 changes: 21 additions & 20 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "eslint-config-semistandard",
"description": "eslint sharable config for semistandard",
"description": "JavaScript Semistandard Style - ESLint Shareable Config",
"version": "15.0.1",
"author": "Dan Flettre <[email protected]>",
"bugs": {
Expand All @@ -17,30 +17,31 @@
},
"homepage": "https://github.com/standard/eslint-config-semistandard",
"keywords": [
"semistandard",
"style checker",
"code style",
"JavaScript Standard Style",
"check",
"checker",
"code",
"code checker",
"code linter",
"style linter",
"simple",
"policy",
"style",
"code",
"lint",
"code standards",
"code style",
"enforce",
"eslint",
"jshint",
"jscs",
"eslintconfig",
"hint",
"enforce",
"check",
"verify",
"jscs",
"jshint",
"lint",
"policy",
"quality",
"checker",
"code standards",
"JavaScript Semistandard Style",
"semistandard style",
"eslintconfig"
"simple",
"semistandard",
"standard",
"standard style",
"style",
"style checker",
"style linter",
"verify"
],
"license": "ISC",
"main": "index.js",
Expand Down

0 comments on commit 3c5d6cb

Please sign in to comment.