Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stackbit/eslint-config
Stackbit's shareable config for ESLint
https://github.com/stackbit/eslint-config
config linting
Last synced: about 1 month ago
JSON representation
Stackbit's shareable config for ESLint
- Host: GitHub
- URL: https://github.com/stackbit/eslint-config
- Owner: stackbit
- License: mit
- Created: 2019-07-31T13:39:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-08-05T15:02:24.000Z (over 5 years ago)
- Last Synced: 2024-12-11T21:12:47.494Z (2 months ago)
- Topics: config, linting
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@stackbit/eslint-config
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-config [](https://www.npmjs.com/package/@stackbit/eslint-config)
Stackbit's [shareable config](https://eslint.org/docs/developer-guide/shareable-configs) for [ESLint](https://eslint.org/)
## Installation
Install ESLint and `@stackbit/eslint-config`:
```
npm install --save-dev eslint @stackbit/eslint-config
```### Prettier
`@stackbit/eslint-config` should be used in conjunction with [Prettier](https://prettier.io/). See the [`@stackbit/prettier-config` installation guide](https://github.com/stackbithq/prettier-config#installation) for more details.
## Usage
Stackbit's ESLint rules come bundled in `@stackbit/eslint-config`. To enable these rules, add an `eslintConfig` property in your `package.json`. See the [ESLint configuration docs](https://eslint.org/docs/user-guide/configuring) for more details.```json
"eslintConfig": {
"extends": ["@stackbit"]
}
```Now you can run ESLint by adding the following scripts to your `package.json`. See the [ESLint CLI docs](https://eslint.org/docs/user-guide/command-line-interface) for more details.
```json
"scripts": {
"lint:js": "eslint --cache --ext .js,.jsx .",
"format:js": "npm run lint:js -- --fix"
}
```Lint it:
```
npm run lint:js
```Format it:
```
npm run format:js
```## [CHANGELOG](CHANGELOG.md)
## [LICENSE](LICENSE)