Forked from antfu/eslint-config
Based on the version of @Antfu, the following sections have been modified:
- Update default package name to
defineConfig - Supplement more
package.jsonproperties ordering rules - Reduce the number of default dependencies (auto-detect vue, react, vitest, cypress)
- More unicorn rules (very crazy 😈)
- More sensible
import/orderrules - Only allow camelcase in variable names
- TypeScript: consistent type assertions (use
xxx as Tinstead of<T>xxx) - Vue: block order change to ['template', 'script', 'style']
- Vue: don't allow attribute more than 3 in one line
- Vue: Allow singleline html element
- Test: support Cypress recommendation rules (optional, enable it by update config
test: { cypress: true }) - Style: set linebreak-style to
unix - Style: no extra parens
- Style: avoid escape quotes in statement
- Fix:
ignoresoption is not working issue
Following is what the Antfu version supports:
- Single quotes, no semi
- Auto fix for formatting (aimed to be used standalone without Prettier)
- Sorted imports, dangling commas
- Reasonable defaults, best practices, only one line of config
- Designed to work with TypeScript, JSX, Vue out-of-box
- Lints also for json, yaml, toml, markdown
- Opinionated, but very customizable
- ESLint Flat config, compose easily!
- Using ESLint Stylistic
- Respects
.gitignoreby default - Optional React, Svelte, UnoCSS support
- Optional formatters support for CSS, HTML, etc.
- Style principle: Minimal for reading, stable for diff, consistent
Important
Since v1.0.0, this config is rewritten to the new ESLint Flat config, check the release note for more details.
pnpm i -D eslint @sundarshahi/eslint-configWith "type": "module" in package.json (recommended):
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig()With CJS:
// eslint.config.js
const defineConfig = require('@sundarshahi/eslint-config').default
module.exports = defineConfig()Tip
ESLint only detects eslint.config.js as the flat config entry, meaning you need to put type: module in your package.json or you have to use CJS in eslint.config.js. If you want explicit extension like .mjs or .cjs, or even eslint.config.ts, you can install eslint-ts-patch to fix it.
Combined with legacy config:
// eslint.config.js
const { FlatCompat } = require('@eslint/eslintrc')
const defineConfig = require('@sundarshahi/eslint-config').default
const compat = new FlatCompat()
module.exports = defineConfig(
{
ignores: [],
},
// Legacy config
...compat.config({
extends: [
'eslint:recommended',
// Other extends...
],
})
// Other flat configs...
)Note that
.eslintignoreno longer works in Flat config, see customization for more details.
For example:
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
}
}We provided an experimental CLI tool to help you migrate from the legacy config to the new flat config.
npx @sundarshahi/eslint-config@latestBefore running the migration, make sure to commit your unsaved changes first.
Install VS Code ESLint extension
Add the following settings to your .vscode/settings.json:
{
// Enable the ESlint flat config support
"eslint.experimental.useFlatConfig": true,
// Disable the default formatter, use eslint instead
"prettier.enable": false,
"editor.formatOnSave": false,
// Auto fix
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never"
},
// Silent the stylistic rules in you IDE, but still auto fix them
"eslint.rules.customizations": [
{ "rule": "style/*", "severity": "off" },
{ "rule": "format/*", "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" }
],
// Enable eslint for all supported languages
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
"vue",
"html",
"markdown",
"json",
"jsonc",
"yaml",
"toml"
]
}Since v1.0, we migrated to ESLint Flat config. It provides much better organization and composition.
Normally you only need to import the defineConfig preset:
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig()And that's it! Or you can configure each integration individually, for example:
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig({
// 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 auto-detected, you can also explicitly enable them:
typescript: true,
vue: true,
// Disable jsonc and yaml support
jsonc: false,
yaml: false,
// `.eslintignore` is no longer supported in Flat config, use `ignores` instead
ignores: [
'./fixtures',
// ...globs
],
})The defineConfig factory function also accepts any number of arbitrary custom config overrides:
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig(
{
// 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:
Advanced Example
We wouldn't recommend using this style in general unless you know exactly what they are doing, as there are shared options between configs and might need extra care to make them consistent.
// eslint.config.js
import {
combine,
comments,
ignores,
imports,
javascript,
jsdoc,
jsonc,
markdown,
node,
sortPackageJson,
sortTsconfig,
stylistic,
toml,
typescript,
unicorn,
vue,
yaml,
} from '@sundarshahi/eslint-config'
export default combine(
ignores(),
javascript(/* Options */),
comments(),
node(),
jsdoc(),
imports(),
unicorn(),
typescript(/* Options */),
stylistic(),
vue(),
jsonc(),
yaml(),
toml(),
markdown()
)Check out the configs and factory for more details.
Thanks to sxzz/eslint-config for the inspiration and reference.
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/* |
i/* |
eslint-plugin-i |
node/* |
n/* |
eslint-plugin-n |
yaml/* |
yml/* |
eslint-plugin-yml |
ts/* |
@typescript-eslint/* |
@typescript-eslint/eslint-plugin |
style/* |
@stylistic/* |
@stylistic/eslint-plugin |
test/* |
vitest/* |
eslint-plugin-vitest |
test/* |
no-only-tests/* |
eslint-plugin-no-only-tests |
When you want to override 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 }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:
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig(
{
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 a overrides options in each integration to make it easier:
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig({
vue: {
overrides: {
'vue/operator-linebreak': ['error', 'before'],
},
},
typescript: {
overrides: {
'ts/consistent-type-definitions': ['error', 'interface'],
},
},
yaml: {
overrides: {
// ...
},
},
})We provide some optional configs for specific use cases, that we don't include their dependencies by default.
Warning
Experimental feature, changes might not follow semver.
Use external formatters to format files that ESLint cannot handle yet (.css, .html, etc). Powered by eslint-plugin-format.
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig({
formatters: {
/**
* Format CSS, LESS, SCSS files, also the `<style>` blocks in Vue
* By default uses Prettier
*/
css: true,
/**
* Format HTML files
* By default uses Prettier
*/
html: true,
/**
* Format Markdown files
* Supports Prettier and dprint
* By default uses Prettier
*/
markdown: 'prettier',
},
})Running npx eslint should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D eslint-plugin-formatTo enable React support, you need to explicitly turn it on:
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig({
react: true,
})Running npx eslint should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refreshTo enable svelte support, you need to explicitly turn it on:
// eslint.config.js
import antfu from '@antfu/eslint-config'
export default antfu({
svelte: true,
})Running npx eslint should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D eslint-plugin-svelteTo enable UnoCSS support, you need to explicitly turn it on:
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig({
unocss: true,
})Running npx eslint should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D @unocss/eslint-pluginThis config also provides some optional plugins/rules for extended usage.
This plugin eslint-plugin-perfectionist allows you to sorted object keys, imports, etc, with auto-fix.
The plugin is installed but no rules are enabled by default.
It's recommended to opt-in on each file individually using configuration comments.
/* eslint perfectionist/sort-objects: "error" */
const objectWantedToSort = {
a: 2,
b: 1,
c: 3,
}
/* eslint perfectionist/sort-objects: "off" */You can optionally enable the type aware rules by passing the options object to the typescript config:
// eslint.config.js
import defineConfig from '@sundarshahi/eslint-config'
export default defineConfig({
typescript: {
tsconfigPath: 'tsconfig.json',
},
})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
// to active the hooks
npx simple-git-hooksI built a visual tool to help you view what rules are enabled in your project and apply them to what files, eslint-flat-config-viewer
Go to your project root that contains eslint.config.js and run:
npx eslint-flat-config-viewerThis project follows Semantic Versioning for releases. However, since this is just a config and involves opinions and many moving parts, we don't treat rules changes as breaking changes.
- Node.js version requirement changes
- Huge refactors that might break the config
- Plugins made major changes that might break the config
- Changes that might affect most of the codebases
- Enable/disable rules and plugins (that might become stricter)
- Rules options changes
- Version bumps of dependencies
If you enjoy this code style, and would like to mention it in your project, here is the badge you can use:
[](https://github.com/antfu/eslint-config)Well, you can still use Prettier to format files that are not supported well by ESLint yet, such as .css, .html, etc. See formatters for more details.
dprint is also a great formatter that with more abilities to customize. However, it's in the same model as Prettier which reads the AST and reprints the code from scratch. This means it's similar to Prettier, which ignores the original line breaks and might also cause the inconsistent diff. So in general, we prefer to use ESLint to format and lint JavaScript/TypeScript code.
Meanwhile, we do have dprint integrations for formatting other files such as .md. See formatters for more details.
You can opt-in to the formatters feature to format your CSS. Note that it's only doing formatting, but not linting. If you want proper linting support, give stylelint a try.
Sure, you can configure 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.
- antfu/eslint-config - Upstream repository
- antfu/dotfiles - My dotfiles
- antfu/vscode-settings - My VS Code settings
- antfu/starter-ts - My starter template for TypeScript library
- antfu/vitesse - My starter template for Vue & Vite app
MIT License © 2023-PRESENT sundarshahi