https://github.com/sxzz/eslint-config
A opinionated ESLint config preset.
https://github.com/sxzz/eslint-config
config eslint eslint-config eslint-flat-config flat sxzz
Last synced: about 2 months ago
JSON representation
A opinionated ESLint config preset.
- Host: GitHub
- URL: https://github.com/sxzz/eslint-config
- Owner: sxzz
- License: mit
- Created: 2023-02-28T13:54:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-26T04:47:37.000Z (about 2 months ago)
- Last Synced: 2026-02-26T13:58:11.283Z (about 2 months ago)
- Topics: config, eslint, eslint-config, eslint-flat-config, flat, sxzz
- Language: TypeScript
- Homepage: https://eslint-config.sxzz.dev
- Size: 1.97 MB
- Stars: 232
- Watchers: 1
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome - config
README
# @sxzz/eslint-config
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Unit Test][unit-test-src]][unit-test-href]
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](https://eslint.org/docs/latest/use/configure/configuration-files-new), 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
```bash
npm i -D @sxzz/eslint-config
```
Require Node.js >= 20.0.0, and ESLint >= 9.5.0.
### Optional Dependencies
| Feature | Optional Dependency |
| ------- | ------------------- |
| Astro | `eslint-plugin-astro` |
| UnoCSS | `@unocss/eslint-plugin` |
## Usage
```js
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
```js
// 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](./src/presets.ts) for more details.
## Comparing to [`@antfu/eslint-config`](https://github.com/antfu/eslint-config)
Most of the rules are the same, but there are some differences:
- Use [Prettier](https://prettier.io/) instead of [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic).
- React and Svelte are not supported.
- Maybe stricter and simpler.
## Sponsors
## License
[MIT](./LICENSE) License © 2021-PRESENT [Kevin Deng](https://github.com/sxzz)
[npm-version-src]: https://img.shields.io/npm/v/@sxzz/eslint-config.svg
[npm-version-href]: https://npmjs.com/package/@sxzz/eslint-config
[npm-downloads-src]: https://img.shields.io/npm/dm/@sxzz/eslint-config
[npm-downloads-href]: https://www.npmcharts.com/compare/@sxzz/eslint-config?interval=30
[unit-test-src]: https://github.com/sxzz/eslint-config/actions/workflows/unit-test.yml/badge.svg
[unit-test-href]: https://github.com/sxzz/eslint-config/actions/workflows/unit-test.yml