@sxzz/eslint-config

A opinionated ESLint config preset for JavaScript, TypeScript, Vue, Astro, and Prettier.

Features

• Format with Prettier.
• Designed to work with TypeScript, Vue, Astro 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.

Install

npm i -D @sxzz/eslint-config

Require Node.js >= 20.0.0, and ESLint >= 9.5.0.

Optional Dependencies

Usage

import { sxzz } from '@sxzz/eslint-config'
export default sxzz(
  // Features: it'll detect installed dependency and enable necessary features automatically
  {
    prettier: true,
    markdown: true,
    vue: true, // auto detection
    astro: false, // auto detection
    unocss: false, // auto detection
  },
  [/* your custom config */],
).removeRules('foo/bar') // see more in https://github.com/antfu/eslint-flat-config-utils

Presets

// 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
  // - Astro support (`eslint-plugin-astro` is required)
  // - Vue support
  // - UnoCSS support (`uno.config.ts` is required)
  // - Prettier support
  presetAll,
} from '@sxzz/eslint-config'

export default presetAll

See 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.
• React and Svelte are not supported.
• Maybe stricter and simpler.

Sponsors

License

MIT License © 2021-PRESENT Kevin Deng