@antfu/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
Reasonable defaults, best practices, only one-line of config
ESLint Flat config, compose easily!
Using ESLint Stylistic
Style principle: Minimal for reading, stable for diff

Important

The main branch is for v1.0-beta, which rewrites to ESLint Flat config, check #250 for more details.

Usage

Install

pnpm add -D eslint @antfu/eslint-config

Create config file

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

export default antfu()

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"
  }
}

VS Code support (auto fix)

Install VS Code ESLint extension

Add the following settings to your settings.json:

{
  // Enable the flat config support
  "eslint.experimental.useFlatConfig": true,

  // Disable the default formatter
  "prettier.enable": false,
  "editor.formatOnSave": false,

  // Auto fix
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true,
    "source.organizeImports": false
  },

  // Silent the stylistic rules in you IDE, but still auto fix them
  "eslint.rules.customizations": [
    { "rule": "@stylistic/*", "severity": "off" },
    { "rule": "style*", "severity": "off" },
    { "rule": "*-indent", "severity": "off" },
    { "rule": "*-spacing", "severity": "off" },
    { "rule": "*-spaces", "severity": "off" },
    { "rule": "*-order", "severity": "off" },
    { "rule": "*-dangle", "severity": "off" },
    { "rule": "*-newline", "severity": "off" },
    { "rule": "*quotes", "severity": "off" },
    { "rule": "*semi", "severity": "off" }
  ],

  // The following is optional.
  // It's better to put under project setting `.vscode/settings.json`
  // to avoid conflicts with working with different eslint configs
  // that does not support all formats.
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "vue",
    "html",
    "markdown",
    "json",
    "jsonc",
    "yaml"
  ]
}

Customization

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

Normally you only need to import the antfu preset:

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

export default antfu()

You can configure each feature individually, for example:

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

export default antfu({
  stylistic: true, // enable stylistic formatting rules
  typescript: true,
  vue: true,
  jsonc: false,
  yml: false,
})

The antfu factory functions also accepts arbitrary numbers of constom configs overrides:

// 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
  {
    rules: {},
  },
  {
    rules: {},
  },
)

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

// eslint.config.js
import {
  comments,
  ignores,
  imports,
  javascript,
  javascriptStylistic,
  jsdoc,
  jsonc,
  markdown,
  node,
  sortPackageJson,
  sortTsconfig,
  typescript,
  typescriptStylistic,
  unicorn,
  vue,
  yml,
} from '@antfu/eslint-config'

export default [
  ...ignores,
  ...javascript(),
  ...comments,
  ...node,
  ...jsdoc,
  ...imports,
  ...unicorn,
  ...javascriptStylistic,

  ...typescript(),
  ...typescriptStylistic,

  ...vue(),
  ...jsonc,
  ...yml,
  ...markdown(),
]

Check out the configs and factory for more details.

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

Plugins Renaming

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

Original Prefix	New Prefix	Source Plugin
`i/*`	`import/*`	eslint-plugin-i
`n/*`	`node/*`	eslint-plugin-n
`@typescript-eslint/*`	`ts/*`	@typescript-eslint/eslint-plugin
`@stylistic/js/*`	`style/*`	@stylistic/eslint-plugin-js
`@stylistic/ts/*`	`style-ts/*`	@stylistic/eslint-plugin-ts

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

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

Type Aware Rules

You can optionally enable the type aware rules by passing the options object to the typescript config:

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

export default antfu({
  typescript: {
    tsconfigPath: 'tsconfig.json',
  },
})

Lint Staged

If you want to apply lint and auto-fix before every commit, you can add the following to your package.json:

{
  "simple-git-hooks": {
    "pre-commit": "pnpm lint-staged"
  },
  "lint-staged": {
    "*": "eslint --fix"
  }
}

and then

npm i -D lint-staged simple-git-hooks

Badge

If you enjoy this code style, and would like to mention it in your project, here is the badge you can use:

[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)

FAQ

Prettier?

Why I don't use Prettier

How to lint CSS?

This config does NOT lint CSS. I personally use UnoCSS so I don't write CSS. If you still prefer CSS, you can use stylelint for CSS linting.

I prefer XXX...

Sure, you can config and override rules locally in your project to fit your needs. If that still does not work for you, you can always fork this repo and maintain your own.

Check Also

antfu/dotfiles - My dotfiles
antfu/vscode-settings - My VS Code settings
antfu/ts-starter - My starter template for TypeScript library
antfu/vitesse - My starter template for Vue & Vite app

HoangTran0410 / antfu-eslint-config