eslint-config/README.md

@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

pnpm add -D eslint @antfu/eslint-config

Config .eslintrc

{
  "extends": "@antfu"
}

You don't need .eslintignore normally as it has been provided by the preset.

Add script for package.json

For example:

{
  "scripts": {
    "lint": "eslint ."
  }
}

Config VS Code auto fix

Create .vscode/settings.json

{
  "prettier.enable": false,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

Check Also

• antfu/vscode-settings - My VS Code settings
• antfu/ts-starter - My starter template for TypeScript library
• antfu/vitesse - My starter template for Vue & Vite app

License

MIT