https://github.com/stoplightio/eslint-config
Shared Stoplight linting rules.
https://github.com/stoplightio/eslint-config
Last synced: about 1 year ago
JSON representation
Shared Stoplight linting rules.
- Host: GitHub
- URL: https://github.com/stoplightio/eslint-config
- Owner: stoplightio
- License: apache-2.0
- Created: 2019-12-15T01:25:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T13:20:19.000Z (over 1 year ago)
- Last Synced: 2025-04-15T08:59:12.081Z (about 1 year ago)
- Language: JavaScript
- Size: 90.8 KB
- Stars: 1
- Watchers: 14
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Usage
#### Install
Including peer dependencies.
```
yarn add -D @typescript-eslint/eslint-plugin \
@typescript-eslint/parser \
eslint \
eslint-plugin-import \
eslint-plugin-jest \
eslint-plugin-prettier \
eslint-plugin-react \
eslint-plugin-react-hooks \
eslint-plugin-simple-import-sort \
prettier
```
Add `@stoplight/eslint-config`:
```
yarn add -D @stoplight/eslint-config
```
#### Setup
Create a `.eslintrc.js` file in the root of the repository with contents:
```js
module.exports = {
extends: ['@stoplight'],
};
```
Create a `.prettierrc.js` file in the root of the repository with contents:
```js
module.exports = {
...require('@stoplight/eslint-config/prettier.config'),
};
```
#### Typical Script Commands
```json
{
"scripts": {
"lint": "yarn prettier.check && eslint --ext .js,.jsx,.ts,.tsx .",
"prettier.check": "prettier --ignore-path .eslintignore --check '**/*.{js,jsx,ts,tsx,md}'",
"lint.fix": "prettier --ignore-path .eslintignore --write '**/*.{js,jsx,ts,tsx,md}'; eslint --ext .js,.jsx,.ts,.tsx . --fix"
}
}
```
#### Typical `.eslintignore` File
```bash
node_modules
dist
build
coverage
.eslintrc.js
.yalc
.yarn
.cache
gen
```