Awesome
@kirklin/eslint-config
<!-- Badges --> <div align='left'> <b>English</b> | <a href="README.zh-cn.md">简体中文</a> <br> </div>Features
- "double quotes", must semi;
- 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, 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 - Supports ESLint v9 or v8.50.0+
[!IMPORTANT] Since v1.0.0, this config is rewritten to the new ESLint Flat config, check the release note for more details.
Usage
Starter Wizard
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.
npx @kirklin/eslint-config@latest
Manual Install
If you prefer to set up manually:
pnpm i -D eslint @kirklin/eslint-config
And create eslint.config.mjs
in your project root:
// eslint.config.mjs
import kirklin from "@kirklin/eslint-config";
export default kirklin();
<details>
<summary>
Combined with legacy config:
</summary>
If you still use some configs from the legacy eslintrc format, you can use the @eslint/eslintrc
package to convert them to the flat config.
// eslint.config.mjs
import kirklin from "@kirklin/eslint-config";
import { FlatCompat } from "@eslint/eslintrc";
const compat = new FlatCompat();
export default kirklin(
{
ignores: [],
},
// Legacy config
...compat.config({
extends: [
"eslint:recommended",
// Other extends...
],
})
// Other flat configs...
);
</details>Note that
.eslintignore
no longer works in Flat config, see customization for more details.
Add script for package.json
For example:
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --fix"
}
}
VS Code support (auto fix on save)
Install VS Code ESLint extension
Add the following settings to your .vscode/settings.json
:
{
// 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",
"xml",
"gql",
"graphql",
"astro",
"css",
"less",
"scss",
"pcss",
"postcss"
]
}
Customization
Since v1.0, we migrated to ESLint Flat config. It provides much better organization and composition.
Normally you only need to import the kirklin
preset:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin();
And that's it! Or you can configure each integration individually, for example:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
// Enable stylistic formatting rules
// stylistic: true,
// Or customize the stylistic rules
stylistic: {
indent: 2, // 4, or 'tab'
quotes: "double", // or 'single'
},
// 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 kirklin
factory function also accepts any number of arbitrary custom config overrides:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin(
{
// Configures for kirklin'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:
<details> <summary>Advanced Example</summary>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 "@kirklin/eslint-config";
export default combine(
ignores(),
javascript(/* Options */),
comments(),
node(),
jsdoc(),
imports(),
unicorn(),
typescript(/* Options */),
stylistic(),
vue(),
jsonc(),
yaml(),
toml(),
markdown(),
);
</details>
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 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-x/* | eslint-plugin-import-x |
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 }
[!NOTE] About plugin renaming - it is actually rather a dangrous move that might leading 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 toeslint-plugin-i
and then toeslint-plugin-import-x
. User are also not forced to migrate to the impliciti/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 doing 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.
Rules Overrides
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 kirklin from "@kirklin/eslint-config";
export default kirklin(
{
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:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
vue: {
overrides: {
"vue/operator-linebreak": ["error", "before"],
},
},
typescript: {
overrides: {
"ts/consistent-type-definitions": ["error", "interface"],
},
},
yaml: {
overrides: {
// ...
},
},
});
Config Composer
Since v2.10.0, the factory function kirklin()
returns a FlatConfigComposer
object from eslint-flat-config-utils
where you can chain the methods to compose the config even more flexibly.
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin()
.prepend(
// some configs before the main config
)
// overrides any named configs
.override(
"kirklin/imports",
{
rules: {
"import/order": ["error", { "newlines-between": "always" }],
}
}
)
// rename plugin prefixes
.renamePlugins({
"old-prefix": "new-prefix",
// ...
});
// ...
Vue
Vue support is detected automatically by checking if vue
is installed in your project. You can also explicitly enable/disable it:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
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
:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
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.
Optional Configs
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
.
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
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-format
React
To enable React support, you need to explicitly turn it on:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
react: true,
});
Running npx eslint
should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D @eslint-react/eslint-plugin eslint-plugin-react-hooks eslint-plugin-react-refresh
Svelte
To enable svelte support, you need to explicitly turn it on:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
svelte: true,
});
Running npx eslint
should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D eslint-plugin-svelte
Astro
To enable astro support, you need to explicitly turn it on:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
astro: true,
});
Running npx eslint
should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D eslint-plugin-astro
Solid
To enable Solid support, you need to explicitly turn it on:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
solid: true,
});
Running npx eslint
should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D eslint-plugin-solid
UnoCSS
To enable UnoCSS support, you need to explicitly turn it on:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
unocss: true,
});
Running npx eslint
should prompt you to install the required dependencies, otherwise, you can install them manually:
npm i -D @unocss/eslint-plugin
Optional Rules
This config also provides some optional plugins/rules for extended usage.
command
Powered by eslint-plugin-command
. It is not a typical rule for linting, but an on-demand micro-codemod tool that triggers by specific comments.
For a few triggers, for example:
/// to-function
- converts an arrow function to a normal function/// to-arrow
- converts a normal function to an arrow function/// to-for-each
- converts a for-in/for-of loop to.forEach()
/// to-for-of
- converts a.forEach()
to a for-of loop/// keep-sorted
- sorts an object/array/interface- ... etc. - refer to the documentation
You can add the trigger comment one line above the code you want to transform, for example (note the triple slash):
<!-- eslint-skip -->/// to-function
const foo = async (msg: string): void => {
console.log(msg)
}
Will be transformed to this when you hit save with your editor or run eslint . --fix
:
async function foo(msg: string): void {
console.log(msg);
}
The command comments are usually one-off and will be removed along with the transformation.
Type Aware Rules
You can optionally enable the type aware rules by passing the options object to the typescript
config:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
typescript: {
tsconfigPath: "tsconfig.json",
},
});
Editor Specific Disables
Some rules are disabled when inside ESLint IDE integrations, namely unused-imports/no-unused-imports
test/no-only-tests
This is to prevent unused imports from getting removed by the IDE during refactoring to get a better developer experience. Those rules will be applied when you run ESLint in the terminal or Lint Staged. If you don't want this behavior, you can disable them:
// eslint.config.js
import kirklin from "@kirklin/eslint-config";
export default kirklin({
isInEditor: false
});
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
// to active the hooks
npx simple-git-hooks
View what rules are enabled
I built a visual tool to help you view what rules are enabled in your project and apply them to what files, @eslint/config-inspector
Go to your project root that contains eslint.config.js
and run:
npx @eslint/config-inspector
Versioning Policy
This 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.
Changes Considered 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
Changes Considered as Non-breaking Changes
- Enable/disable rules and plugins (that might become stricter)
- Rules options changes
- Version bumps of dependencies
Badge
Use this in one of your projects? Include one of these badges in your readme to let people know that your code is using the Kirk Lin style.
[![kirklin-code-style-image](https://img.shields.io/badge/code__style-%40kirklin%2Feslint--config-3491fa?style=flat&colorA=080f12&colorB=3491fa)](https://github.com/kirklin/eslint-config/)
Thanks
This project is based on @antfu/eslint-config
Check Also
- kirklin/dotfiles - My dotfiles
- kirklin/vscode-settings - My VS Code settings
- kirklin/boot-ts - My starter template for TypeScript library
- kirklin/boot-vue - My starter template for Vue & Vite app