https://github.com/dcoric/eslint-config-groundlink
Extension of the eslint-config-standard used for in-house projects
https://github.com/dcoric/eslint-config-groundlink
Last synced: over 1 year ago
JSON representation
Extension of the eslint-config-standard used for in-house projects
- Host: GitHub
- URL: https://github.com/dcoric/eslint-config-groundlink
- Owner: dcoric
- License: mit
- Created: 2020-01-23T13:49:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-01T15:39:40.000Z (over 3 years ago)
- Last Synced: 2025-01-10T14:30:02.934Z (over 1 year ago)
- Language: JavaScript
- Size: 426 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config-groundlink
## Install
```bash
npm install eslint-config-groundlink
```
## Usage
Shareable configs are designed to work with the `extends` feature of `.eslintrc` files.
You can learn more about
[Shareable Configs](http://eslint.org/docs/developer-guide/shareable-configs) on the
official ESLint website.
**If you want to set up the config automatically**, follow these steps in your project directory:
1. `npx eslint --init`
2. Select "Use a popular style guide."
3. Select "Standard."
4. Select a config file format.
5. If prompted, confirm the installation of the necessary dependencies.
The above steps will automatically set up an ESLint configuration and install the necessary dependencies for you.
**If you want to set up the config manually**, run the following command:
```bash
npm install --save-dev eslint-config-groundlink eslint-plugin-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node
```
Then, add this to your `.eslintrc` file:
```
{
"extends": "standard"
}
```
*Note: We omitted the `eslint-config-` prefix since it is automatically assumed by ESLint.*
You can override settings from the shareable config by adding them directly into your
`.eslintrc` file.
### Looking for something easier than this?
The easiest way to use JavaScript Standard Style to check your code is to use the
[`standard`](http://standardjs.com) package. This comes with a global
Node command line program (`standard`) that you can run or add to your `npm test` script
to quickly check your style.
## Badge
Use this in one of your projects? Include one of these badges in your readme to
let people know that your code is using the standard style.
[](http://standardjs.com)
```markdown
[](http://standardjs.com)
```
[](http://standardjs.com)
```markdown
[](http://standardjs.com)
```
## Learn more
For the full listing of rules, editor plugins, FAQs, and more, visit the main
[JavaScript Standard Style repo](http://standardjs.com).
## License
MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).