@zzjtnb/eslint-config

• Single quotes, no semi
• Auto fix for formatting (aimed to be used standalone without Prettier)
• Designed to work with TypeScript, Vue 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 @zzjtnb/eslint-config

Config .eslintrc

{
  "extends": "@zzjtnb"
}

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

Add script for package.json

For example:

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

Config VS Code auto fix

Install VS Code ESLint extension and create .vscode/settings.json

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

Directory Description

eslint-config
├── LICENSE
├── README.md
├── package.json
├── packages # all have index.js and package.json + additional exports
│   ├── all # could be just consisting from 'extends' statements
│   ├── basic
│   ├── typescript
│   └── vue
└── pnpm-workspace.yaml

除了 all 之外, 所有这些包名称都直接后缀为 eslint-config-zzjtnb-<pkg>

all 的包名目录为：eslint-config-zzjtnb

License

MIT License © 2022 争逐