A opinionated ESLint config preset for JavaScript, TypeScript, Vue 2 or Vue 3, and Prettier.
- Format with Prettier.
- Designed to work with TypeScript, Vue 2 and 3 out-of-box.
- Support JSON(5), YAML, Markdown...
- Sort imports,
package.json,tsconfig.json... - ESLint Flat config, compose easily!
- Ignores common files like
dist,node_modules,coverage, and files in.gitignore. - Reasonable defaults, best practices, only one-line of config
- Reasonable strict, but with better code quality.
npm i -D @sxzz/eslint-configRequire Node.js >= 18.18, and ESLint >= 9.5.0.
import { sxzz } from '@sxzz/eslint-config'
export default sxzz(
[
/* your custom config */
],
// Features: it'll detect installed dependency and enable necessary features automatically
{
prettier: true,
markdown: true,
vue: true, // auto detection
unocss: false, // auto detection
},
)// eslint.config.js
import {
presetJavaScript, // Ignore common files and include javascript support
presetJsonc, // Includes basic json(c) file support and sorting json keys
presetLangsExtensions, // Includes markdown, yaml + `presetJsonc` support
presetBasic, // Includes `presetJavaScript` and typescript support
// Includes
// - `presetBasic` (JS+TS) support
// - `presetLangsExtensions` (markdown, yaml, jsonc) support
// - Vue support
// - UnoCSS support (`uno.config.ts` is required)
// - Prettier support
presetAll,
} from '@sxzz/eslint-config'
export default presetAllSee preset.ts for more details.
Comparing to @antfu/eslint-config
Most of the rules are the same, but there are some differences:
- Use Prettier instead of ESLint Stylistic.
- Support both Vue 2 and Vue 3.
- Support Vue Reactivity Transform.
- More stricter rules.
