@antfu/eslint-config

 

- Auto fix for formatting (aimed to be used standalone without Prettier)
- Reasonable defaults, best practices, only one line of config
- Designed to work with TypeScript, JSX, Vue, JSON, YAML, Toml, Markdown, etc. Out-of-box.
- Opinionated, but very customizable
- ESLint Flat config, compose easily!
- Optional React, Next.js, Svelte, UnoCSS, Astro, Solid support
- Optional formatters support for formatting CSS, HTML, XML, etc.
- Style principle: Minimal for reading, stable for diff, consistent
- Sorted imports, dangling commas
- Single quotes, no semi
- Using ESLint Stylistic
- Respects .gitignore by default
- Requires ESLint v9.5.0+

> [!WARNING]
> I am super appreciative and even a bit flattered that so many of you are fond of using this config. For that reason, I tried to make it as flexible and customizable as possible to fit more use cases.
>
> However, please keep in mind that this is still _a personal config_ with a lot of opinions. Changes might not always work for everyone and every use case.
>
> If you are using this config directly, I suggest you review the changes every time you update. Or if you want more control over the rules, always feel free to fork it. Thanks!

> [!TIP]
> If you are interested in the tooling and the philosophy behind this config, I gave a talk about ESLint flat config at JSNation 2024 - ESLint One for All Made Easy, slides are here.

Usage

$3

We provided a CLI tool to help you set up your project, or migrate from the legacy config to the new flat config with one command.

``bash
pnpm dlx @antfu/eslint-config@latest
`

$3

If you prefer to set up manually:

`bash
pnpm i -D eslint @antfu/eslint-config
`

And create eslint.config.mjs in your project root:

`js
// eslint.config.mjs
import antfu from '@antfu/eslint-config'

export default antfu()
`

$3

For example:

`json
{
"scripts": {
"lint": "eslint",
"lint:fix": "eslint --fix"
}
}
`

IDE Support (auto fix on save)

Customization

Since v1.0, we migrated to ESLint Flat config. It provides much better organization and composition.

Normally you only need to import the antfu preset:

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu()
`

And that's it! Or you can configure each integration individually, for example:

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu({
// Type of the project. 'lib' for libraries, the default is 'app'
type: 'lib',

// .eslintignore is no longer supported in Flat config, use ignores instead
// The ignores option in the option (first argument) is specifically treated to always be global ignores
// And will extend the config's default ignores, not override them
// You can also pass a function to modify the default ignores
ignores: [
'**/fixtures',
// ...globs
],

// Parse the .gitignore file to get the ignores, on by default
gitignore: true,

// Enable stylistic formatting rules
// stylistic: true,

// Or customize the stylistic rules
stylistic: {
indent: 2, // 4, or 'tab'
quotes: 'single', // or 'double'
},

// TypeScript and Vue are autodetected, you can also explicitly enable them:
typescript: true,
vue: true,

// Disable jsonc and yaml support
jsonc: false,
yaml: false,
})
`

The antfu factory function also accepts any number of arbitrary custom config overrides:

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu(
{
// Configures for antfu's config
},

// From the second arguments they are ESLint Flat Configs
// you can have multiple configs
{
files: ['*/.ts'],
rules: {},
},
{
rules: {},
},
)
`

Going more advanced, you can also import fine-grained configs and compose them as you wish:

Check out the configs and factory for more details.

> Thanks to sxzz/eslint-config for the inspiration and reference.

$3

Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write.

| New Prefix | Original Prefix | Source Plugin |
| ---------- | ---------------------- | ----------------------------------------------------------------------------------------------------- |
| import/ | import-lite/ | eslint-plugin-import-lite |
| node/ | n/ | eslint-plugin-n |
| yaml/ | yml/ | eslint-plugin-yml |
| ts/ | @typescript-eslint/ | @typescript-eslint/eslint-plugin |
| style/ | @stylistic/ | @stylistic/eslint-plugin |
| test/ | vitest/ | @vitest/eslint-plugin |
| test/ | no-only-tests/ | eslint-plugin-no-only-tests |
| next/* | @next/next | @next/eslint-plugin-next |

When you want to override rules, or disable them inline, you need to update to the new prefix:

`diff
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+// eslint-disable-next-line ts/consistent-type-definitions
type foo = { bar: 2 }
`

> [!NOTE]
> About plugin renaming - it is actually rather a dangerous move that might lead to potential naming collisions, pointed out here and here. As this config also very personal and opinionated, I ambitiously position this config as the only "top-level" config per project, that might pivots the taste of how rules are named.
>
> This config cares more about the user-facings DX, and try to ease out the implementation details. For example, users could keep using the semantic import/order without ever knowing the underlying plugin has migrated twice to eslint-plugin-i and then to eslint-plugin-import-x. User are also not forced to migrate to the implicit i/order halfway only because we swapped the implementation to a fork.
>
> That said, it's probably still not a good idea. You might not want to do this if you are maintaining your own eslint config.
>
> Feel free to open issues if you want to combine this config with some other config presets but faced naming collisions. I am happy to figure out a way to make them work. But at this moment I have no plan to revert the renaming.

Since v2.9.0, this preset will automatically rename the plugins also for your custom configs. You can use the original prefix to override the rules directly.

$3

Certain rules would only be enabled in specific files, for example, ts/ rules would only be enabled in .ts files and vue/ rules would only be enabled in .vue files. If you want to override the rules, you need to specify the file extension:

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu(
{
vue: true,
typescript: true
},
{
// Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
files: ['*/.vue'],
rules: {
'vue/operator-linebreak': ['error', 'before'],
},
},
{
// Without files, they are general rules for all files
rules: {
'style/semi': ['error', 'never'],
},
}
)
`

We also provided the overrides options in each integration to make it easier:

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu({
vue: {
overrides: {
'vue/operator-linebreak': ['error', 'before'],
},
},
typescript: {
overrides: {
'ts/consistent-type-definitions': ['error', 'interface'],
},
},
yaml: {
overrides: {
// ...
},
},
})
`

$3

Since v2.10.0, the factory function antfu() returns a FlatConfigComposer object from eslint-flat-config-utils where you can chain the methods to compose the config even more flexibly.

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu()
.prepend(
// some configs before the main config
)
// overrides any named configs
.override(
'antfu/stylistic/rules',
{
rules: {
'style/generator-star-spacing': ['error', { after: true, before: false }],
}
}
)
// rename plugin prefixes
.renamePlugins({
'old-prefix': 'new-prefix',
// ...
})
// ...
`

$3

Vue support is detected automatically by checking if vue is installed in your project. You can also explicitly enable/disable it:

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu({
vue: true
})
`

#### Vue 2

We have limited support for Vue 2 (as it's already reached EOL). If you are still using Vue 2, you can configure it manually by setting vueVersion to 2:

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu({
vue: {
vueVersion: 2
},
})
`

As it's in maintenance mode, we only accept bug fixes for Vue 2. It might also be removed in the future when eslint-plugin-vue drops support for Vue 2. We recommend upgrading to Vue 3 if possible.

#### Vue Accessibility

To enable Vue accessibility support, you need to explicitly turn it on:

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu({
vue: {
a11y: true
},
})
`

Running npx eslint should prompt you to install the required dependencies, otherwise, you can install them manually:

`bash
npm i -D eslint-plugin-vuejs-accessibility
`

$3

We provide some optional configs for specific use cases, that we don't include their dependencies by default.

#### Formatters

Use external formatters to format files that ESLint cannot handle yet (.css, .html, etc). Powered by eslint-plugin-format.

`js
// eslint.config.js
import antfu from '@antfu/eslint-config'

export default antfu({
formatters: {
/**
* Format CSS, LESS, SCSS files, also the