67 lines
1.4 KiB
Markdown
67 lines
1.4 KiB
Markdown
# @antfu/eslint-config
|
|
|
|
[](https://npmjs.com/package/@antfu/eslint-config)
|
|
|
|
- Single quotes, no semi
|
|
- Auto fix for formatting (aimed to be used standalone without Prettier)
|
|
- TypeScript, Vue, React out-of-box
|
|
- Lint also for json, yaml, markdown
|
|
- Sorted imports, dangling commas for cleaner commit diff
|
|
- Reasonable defaults, best practices, only one-line of config
|
|
|
|
## Usage
|
|
|
|
### Install
|
|
|
|
```bash
|
|
pnpm add -D eslint @antfu/eslint-config
|
|
```
|
|
|
|
### Config `.eslintrc`
|
|
|
|
```json
|
|
{
|
|
"extends": "@antfu"
|
|
}
|
|
```
|
|
|
|
> You don't need `.eslintignore` normally as it has been provided by the preset.
|
|
|
|
### Add script for package.json
|
|
|
|
For example:
|
|
|
|
```json
|
|
{
|
|
"scripts": {
|
|
"lint": "eslint .",
|
|
"lint:fix": "eslint . --fix"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Config VS Code auto fix
|
|
|
|
Create `.vscode/settings.json`
|
|
|
|
```json
|
|
{
|
|
"prettier.enable": false,
|
|
"editor.codeActionsOnSave": {
|
|
"source.fixAll.eslint": true
|
|
}
|
|
}
|
|
```
|
|
|
|
## Check Also
|
|
|
|
- [antfu/dotfiles](https://github.com/antfu/dotfiles) - My dotfiles
|
|
- [antfu/vscode-settings](https://github.com/antfu/vscode-settings) - My VS Code settings
|
|
- [antfu/eslint-config](https://github.com/antfu/eslint-config) - My ESLint config
|
|
- [antfu/ts-starter](https://github.com/antfu/ts-starter) - My starter template for TypeScript library
|
|
- [antfu/vitesse](https://github.com/antfu/vitesse) - My starter template for Vue & Vite app
|
|
|
|
## License
|
|
|
|
MIT
|