Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kirklin/eslint-config

Kirk Lin's ESLint config presets
https://github.com/kirklin/eslint-config

eslint eslint-config formatter

Last synced: 18 days ago
JSON representation

Kirk Lin's ESLint config presets

Awesome Lists containing this project

README 

        
# @kirklin/eslint-config



[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![JSDocs][jsdocs-src]][jsdocs-href]

[![License][license-src]][license-href]

[![javascript_code style][code-style-image]][code-style-url]



[npm-version-src]: https://img.shields.io/npm/v/@kirklin/eslint-config?style=flat&colorA=080f12&colorB=3491fa

[npm-version-href]: https://npmjs.com/package/@kirklin/eslint-config

[npm-downloads-src]: https://img.shields.io/npm/dm/@kirklin/eslint-config?style=flat&colorA=080f12&colorB=3491fa

[npm-downloads-href]: https://npmjs.com/package/@kirklin/eslint-config

[license-src]: https://img.shields.io/github/license/kirklin/eslint-config.svg?style=flat&colorA=080f12&colorB=3491fa

[license-href]: https://github.com/kirklin/eslint-config/blob/main/LICENSE

[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=3491fa

[jsdocs-href]: https://www.jsdocs.io/package/@kirklin/eslint-config

[code-style-image]: https://img.shields.io/badge/code__style-%40kirklin%2Feslint--config-3491fa?style=flat&colorA=080f12&colorB=3491fa

[code-style-url]: https://github.com/kirklin/eslint-config/





English | įŽ€äŊ“中文







## 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](#customization)

- [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new), compose easily!

- Optional [React](#react), [Svelte](#svelte), [UnoCSS](#unocss), [Astro](#astro), [Solid](#solid) support

- Optional [formatters](#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](https://github.com/eslint-stylistic/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](https://eslint.org/docs/latest/use/configure/configuration-files-new), check the [release note](https://github.com/kirklin/eslint-config/releases/tag/v1.0.0) 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.



```bash

pnpm dlx @kirklin/eslint-config@latest

```



### Manual Install



If you prefer to set up manually:



```bash

pnpm i -D eslint @kirklin/eslint-config

```



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



```js

// eslint.config.mjs

import kirklin from "@kirklin/eslint-config";



export default kirklin();

```



Combined with legacy config:



If you still use some configs from the legacy eslintrc format, you can use the [`@eslint/eslintrc`](https://www.npmjs.com/package/@eslint/eslintrc) package to convert them to the flat config.



```js

// 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...

);

```



> Note that `.eslintignore` no longer works in Flat config, see [customization](#customization) for more details.



### Add script for package.json



For example:



```json

{

  "scripts": {

    "lint": "eslint .",

    "lint:fix": "eslint . --fix"

  }

}

```



## IDE Support (auto fix on save)



đŸŸĻ VS Code support







Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)



Add the following settings to your `.vscode/settings.json`:



```jsonc

{

  // 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", "fixable": true },

    { "rule": "format/*", "severity": "off", "fixable": true },

    { "rule": "*-indent", "severity": "off", "fixable": true },

    { "rule": "*-spacing", "severity": "off", "fixable": true },

    { "rule": "*-spaces", "severity": "off", "fixable": true },

    { "rule": "*-order", "severity": "off", "fixable": true },

    { "rule": "*-dangle", "severity": "off", "fixable": true },

    { "rule": "*-newline", "severity": "off", "fixable": true },

    { "rule": "*quotes", "severity": "off", "fixable": true },

    { "rule": "*semi", "severity": "off", "fixable": true }

  ],



  // Enable eslint for all supported languages

  "eslint.validate": [

    "javascript",

    "javascriptreact",

    "typescript",

    "typescriptreact",

    "vue",

    "html",

    "markdown",

    "json",

    "jsonc",

    "yaml",

    "toml",

    "xml",

    "gql",

    "graphql",

    "astro",

    "svelte",

    "css",

    "less",

    "scss",

    "pcss",

    "postcss"

  ]

}

```



🟩 Neovim Support







Update your configuration to use the following:



```lua

local customizations = {

  { rule = 'style/*', severity = 'off', fixable = true },

  { rule = 'format/*', severity = 'off', fixable = true },

  { rule = '*-indent', severity = 'off', fixable = true },

  { rule = '*-spacing', severity = 'off', fixable = true },

  { rule = '*-spaces', severity = 'off', fixable = true },

  { rule = '*-order', severity = 'off', fixable = true },

  { rule = '*-dangle', severity = 'off', fixable = true },

  { rule = '*-newline', severity = 'off', fixable = true },

  { rule = '*quotes', severity = 'off', fixable = true },

  { rule = '*semi', severity = 'off', fixable = true },

}



local lspconfig = require('lspconfig')

-- Enable eslint for all supported languages

lspconfig.eslint.setup(

  {

    filetypes = {

      "javascript",

      "javascriptreact",

      "javascript.jsx",

      "typescript",

      "typescriptreact",

      "typescript.tsx",

      "vue",

      "html",

      "markdown",

      "json",

      "jsonc",

      "yaml",

      "toml",

      "xml",

      "gql",

      "graphql",

      "astro",

      "svelte",

      "css",

      "less",

      "scss",

      "pcss",

      "postcss"

    },

    settings = {

      -- Silent the stylistic rules in you IDE, but still auto fix them

      rulesCustomizations = customizations,

    },

  }

)

```



### Neovim format on save



There's few ways you can achieve format on save in neovim:



- `nvim-lspconfig` has a `EslintFixAll` command predefined, you can create a autocmd to call this command after saving file.



```lua

lspconfig.eslint.setup({

  --- ...

  on_attach = function(client, bufnr)

    vim.api.nvim_create_autocmd("BufWritePre", {

      buffer = bufnr,

      command = "EslintFixAll",

    })

  end,

})

```



- Use [conform.nvim](https://github.com/stevearc/conform.nvim).

- Use [none-ls](https://github.com/nvimtools/none-ls.nvim)

- Use [nvim-lint](https://github.com/mfussenegger/nvim-lint)



## Customization



Since v1.0, we migrated to [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new). It provides much better organization and composition.



Normally you only need to import the `kirklin` preset:



```js

// 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:



```js

// eslint.config.js

import kirklin from "@kirklin/eslint-config";



export default kirklin({

  // Type of the project. 'lib' for libraries, the default is 'app'

  type: "lib",



  // 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 autodetected, 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:



```js

// 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:



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.



```js

// 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(),

);

```



Check out the [configs](https://github.com/kirklin/eslint-config/blob/main/src/configs) and [factory](https://github.com/kirklin/eslint-config/blob/main/src/factory.ts) for more details.



> Thanks to [sxzz/eslint-config](https://github.com/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](https://github.com/un-es/eslint-plugin-import-x)                  |

| `node/*`   | `n/*`                  | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)                     |

| `yaml/*`   | `yml/*`                | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml)                        |

| `ts/*`     | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |

| `style/*`  | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)           |

| `test/*`   | `vitest/*`             | [@vitest/eslint-plugin](https://github.com/vitest-dev/eslint-plugin-vitest)                |

| `test/*`   | `no-only-tests/*`      | [eslint-plugin-no-only-tests](https://github.com/levibuzolic/eslint-plugin-no-only-tests)  |



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 dangrous move that might leading to potential naming collisions, pointed out [here](https://github.com/eslint/eslint/discussions/17766) and [here](https://github.com/prettier/eslint-config-prettier#eslintconfigjs-flat-config-plugin-caveat). 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 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.3.0, this preset will automatically rename the plugins also for your custom configs. You can use the original prefix to override the rules directly.



Change back to original prefix



If you really want to use the original prefix, you can revert the plugin renaming by:



```ts

import kirklin from "@kirklin/eslint-config";



export default kirklin()

  .renamePlugins({

    ts: "@typescript-eslint",

    yaml: "yml",

    node: "n"

    // ...

  });

```



### 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:



```js

// 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:



```js

// 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`](https://github.com/antfu/eslint-flat-config-utils#composer) where you can chain the methods to compose the config even more flexibly.



```js

// 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:



```js

// 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](https://v2.vuejs.org/eol/)). If you are still using Vue 2, you can configure it manually by setting `vueVersion` to `2`:



```js

// 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`](https://github.com/antfu/eslint-plugin-format).



```js

// eslint.config.js

import kirklin from "@kirklin/eslint-config";



export default kirklin({

  formatters: {

    /**

     * Format CSS, LESS, SCSS files, also the `` 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:



```bash

npm i -D eslint-plugin-format

```



#### React



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



```js

// 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:



```bash

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:



```js

// 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:



```bash

npm i -D eslint-plugin-svelte

```



#### Astro



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



```js

// 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:



```bash

npm i -D eslint-plugin-astro

```



#### Solid



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



```js

// 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:



```bash

npm i -D eslint-plugin-solid

```



#### UnoCSS



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



```js

// 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:



```bash

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`](https://github.com/antfu/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](https://github.com/antfu/eslint-plugin-command#built-in-commands)



You can add the trigger comment one line above the code you want to transform, for example (note the triple slash):



<!-- eslint-skip -->



```ts

/// 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`:



```ts

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](https://typescript-eslint.io/linting/typed-linting/) by passing the options object to the `typescript` config:



```js

// 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`](https://www.npmjs.com/package/eslint-plugin-unused-imports) [`test/no-only-tests`](https://github.com/levibuzolic/eslint-plugin-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](#lint-staged). If you don't want this behavior, you can disable them:



```js

// 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`:



```json

{

  "simple-git-hooks": {

    "pre-commit": "pnpm lint-staged"

  },

  "lint-staged": {

    "*": "eslint --fix"

  }

}

```



and then



```bash

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](https://github.com/eslint/config-inspector)



Go to your project root that contains `eslint.config.js` and run:



```bash

npx @eslint/config-inspector

```



## Versioning Policy



This project follows [Semantic Versioning](https://semver.org/) 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/)



```markdown

[![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/)

```



[code-style-image]: https://img.shields.io/badge/code__style-%40kirklin%2Feslint--config-3491fa?style=flat&colorA=080f12&colorB=3491fa

[code-style-url]: https://github.com/kirklin/eslint-config/



## Thanks



This project is based on [@antfu/eslint-config](https://github.com/antfu/eslint-config)



## Check Also



- [kirklin/dotfiles](https://github.com/kirklin/dotfiles) - My dotfiles

- [kirklin/vscode-settings](https://github.com/kirklin/vscode-settings) - My VS Code settings

- [kirklin/boot-ts](https://github.com/kirklin/boot-ts) - My starter template for TypeScript library

- [kirklin/boot-vue](https://github.com/kirklin/boot-vue) - My starter template for Vue & Vite app



## License



[MIT](./LICENSE) License &copy; 2019-PRESENT [Kirk Lin](https://github.com/kirklin)