https://github.com/etchteam/eslint
Our shared eslint config
https://github.com/etchteam/eslint
eslint eslint-config eslint-config-next eslint-config-react
Last synced: 2 months ago
JSON representation
Our shared eslint config
- Host: GitHub
- URL: https://github.com/etchteam/eslint
- Owner: etchteam
- License: isc
- Created: 2022-12-05T11:59:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T12:53:56.000Z (about 1 year ago)
- Last Synced: 2024-05-22T11:45:13.297Z (about 1 year ago)
- Topics: eslint, eslint-config, eslint-config-next, eslint-config-react
- Language: JavaScript
- Homepage:
- Size: 415 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @etchteam/eslint
The eslint config that we use at [Etch](https://etch.co)
## Install
```bash
npm i -D eslint prettier @etchteam/eslint-config
```
## Usage
```bash
echo "module.exports = { extends: ['@etchteam'] };" > .eslintrc.cjs
```
### With lint-staged
#### New project
Run the following:
```bash
npm i -D husky lint-staged
echo "module.exports = { '*.{ts,tsx,js,jsx,yml,yaml,json}': 'eslint --fix' };" > lint-staged.config.cjs
npx husky init
echo "npx --no-install -- lint-staged" > .husky/pre-commit
```
#### Existing project with husky and lint staged
Add the following to your lint-staged config:
`'*.{ts,tsx,js,jsx,yml,yaml,json}': 'eslint --fix'`
## Usage with VSCode
### New project with no VSCode config
Run the following:
```bash
mkdir .vscode
echo "{ \"editor.formatOnSave\": false, \"editor.codeActionsOnSave\": { \"source.fixAll.eslint\": \"explicit\" } }" > .vscode/settings.json
# The VSCode prettier extension doesn't read the eslint config, so specific
# prettier overrides need to go in a prettier config for format on save
echo "module.exports = { singleQuote: true };" > prettier.config.cjs
```
### Exisiting project with VSCode config
Add the following to `.vscode/settings.json`:
```json
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
}
```
Run the following:
```bash
# The VSCode prettier extension doesn't read the eslint config, so specific
# prettier overrides need to go in a prettier config for format on save
echo "module.exports = { singleQuote: true };" > prettier.config.cjs
```