@kirklin/eslint-config 2.4.0 → 2.6.0

package/README.md

@@ -33,7 +33,7 @@
 - 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, etc.
+- 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
@@ -51,7 +51,7 @@
 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
-npx @kirklin/eslint-config@latest
+pnpm dlx @kirklin/eslint-config@latest
 ```
 
 ### Manual Install
@@ -119,7 +119,12 @@ For example:
 }
 ```
 
-## VS Code support (auto fix on save)
+## IDE Support (auto fix on save)
+
+<details>
+<summary>🟦 VS Code support</summary>
+
+<br>
 
 Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
@@ -127,9 +132,6 @@ Add the following settings to your `.vscode/settings.json`:
 
 ```jsonc
 {
-  // Enable the ESlint flat config support
-  "eslint.experimental.useFlatConfig": true,
-
   // Disable the default formatter, use eslint instead
   "prettier.enable": false,
   "editor.formatOnSave": false,
@@ -142,16 +144,16 @@ Add the following settings to your `.vscode/settings.json`:
 
   // 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" }
+    { "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
@@ -167,12 +169,104 @@ Add the following settings to your `.vscode/settings.json`:
     "jsonc",
     "yaml",
     "toml",
+    "xml",
     "gql",
-    "graphql"
+    "graphql",
+    "astro",
+    "svelte",
+    "css",
+    "less",
+    "scss",
+    "pcss",
+    "postcss"
   ]
 }
 ```
 
+</details>
+
+<details>
+<summary>🟩 Neovim Support</summary>
+
+<br>
+
+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)
+
+</details>
+
 ## 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.
@@ -193,6 +287,9 @@ And that's it! Or you can configure each integration individually, for example:
 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,
 
@@ -202,7 +299,7 @@ export default kirklin({
     quotes: "double", // or 'single'
   },
 
-  // TypeScript and Vue are auto-detected, you can also explicitly enable them:
+  // TypeScript and Vue are autodetected, you can also explicitly enable them:
   typescript: true,
   vue: true,
 
@@ -305,7 +402,7 @@ Since flat config requires us to explicitly provide the plugin names (instead of
 | `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/*`             | [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest)                    |
+| `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:
@@ -325,7 +422,26 @@ type foo = { bar: 2 }
 >
 > 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.
+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.
+
+<details>
+<summary>Change back to original prefix</summary>
+
+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"
+    // ...
+  });
+```
+
+</details>
 
 ### Rules Overrides
 
@@ -600,7 +716,7 @@ You can add the trigger comment one line above the code you want to transform, f
 /// 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`:
@@ -716,6 +832,8 @@ This project is based on [@antfu/eslint-config](https://github.com/antfu/eslint-
 
 - [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
 

package/README.zh-cn.md

@@ -37,7 +37,7 @@
 - 使用[ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
 - 默认情况下遵守`.gitignore`
 - 可选的[React](#react), [Svelte](#svelte), [UnoCSS](#unocss), [Astro](#astro), [Solid](#solid)支持
-- 可选的[格式化程序](#formatters)支持CSS，HTML等。
+- 可选的[格式化程序](#formatters)支持CSS，HTML，XML等。
 - **样式原则**：最小化阅读，稳定的差异性，保持一致性
 
 > [!IMPORTANT]
@@ -50,7 +50,7 @@
 我们提供了一个命令行工具，帮助您快速设置项目，或者通过一个命令从旧的配置迁移到新的平面配置。
 
 ```bash
-npx @kirklin/eslint-config@latest
+pnpm dlx @kirklin/eslint-config@latest
 ```
 
 ### 手动安装
@@ -118,20 +118,20 @@ For example:
 }
 ```
 
-## VS Code支持（自动修复）
+## IDE 支持（保存时自动修复）
 
-为了在Visual Studio Code中实现保存时自动修复代码的功能，您需要安装ESLint扩展并配置相应的设置。以下是详细的步骤和说明：
+<details>
+<summary>🟦 VS Code 支持</summary>
+
+<br>
 
-1. 安装 [VS Code ESLint扩展](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+安装 [VS Code ESLint 插件](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
-2. 在您的项目根目录下，创建或编辑`.vscode`文件夹中的`settings.json`文件，添加以下配置：
+在 `.vscode/settings.json` 中添加以下设置：
 
 ```jsonc
 {
-  // 启用ESLint flat config支持
-  "eslint.experimental.useFlatConfig": true,
-
-  // 禁用默认的格式化程序，改用ESLint进行格式化
+  // 禁用默认格式化器，使用 eslint 代替
   "prettier.enable": false,
   "editor.formatOnSave": false,
 
@@ -141,21 +141,21 @@ For example:
     "source.organizeImports": "never"
   },
 
-  // 在IDE中隐藏样式规则的提示，但仍然自动修复它们
+  // 在IDE中静默样式规则，但仍然自动修复
   "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" }
+    { "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 }
   ],
 
-  // 为所有支持的语言启用ESLint
+  // 为所有支持的语言启用 eslint
   "eslint.validate": [
     "javascript",
     "javascriptreact",
@@ -168,12 +168,104 @@ For example:
     "jsonc",
     "yaml",
     "toml",
+    "xml",
     "gql",
-    "graphql"
+    "graphql",
+    "astro",
+    "svelte",
+    "css",
+    "less",
+    "scss",
+    "pcss",
+    "postcss"
   ]
 }
 ```
 
+</details>
+
+<details>
+<summary>🟩 Neovim 支持</summary>
+
+<br>
+
+更新你的配置，使用以下内容：
+
+```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')
+-- 为所有支持的语言启用 eslint
+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 = {
+      -- 在IDE中静默样式规则，但仍然自动修复
+      rulesCustomizations = customizations,
+    },
+  }
+)
+```
+
+### Neovim 保存时格式化
+
+在 Neovim 中实现保存时格式化有几种方法：
+
+- `nvim-lspconfig` 预定义了 `EslintFixAll` 命令，你可以创建一个 autocmd，在保存文件后调用该命令。
+
+```lua
+lspconfig.eslint.setup({
+  --- ...
+  on_attach = function(client, bufnr)
+    vim.api.nvim_create_autocmd("BufWritePre", {
+      buffer = bufnr,
+      command = "EslintFixAll",
+    })
+  end,
+})
+```
+
+- 使用 [conform.nvim](https://github.com/stevearc/conform.nvim)。
+- 使用 [none-ls](https://github.com/nvimtools/none-ls.nvim)。
+- 使用 [nvim-lint](https://github.com/mfussenegger/nvim-lint)。
+
+</details>
+
 ## 自定义
 
 从v1.0开始，我们迁移到了[ESLint Flat 配置](https://eslint.org/docs/latest/use/configure/configuration-files-new)。它提供了更好的组织和组合。
@@ -194,6 +286,9 @@ export default kirklin();
 import kirklin from "@kirklin/eslint-config";
 
 export default kirklin({
+  // 项目类型。'lib' 表示库，默认是 'app'
+  type: "lib",
+
   // 启用风格格式规则
   // stylistic: true,
 
@@ -306,7 +401,7 @@ export default combine(
 | `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/*`             | [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest)                    |
+| `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)  |
 
 当您想要覆盖规则或在内联中禁用它们时，您需要更新新前缀：
@@ -328,6 +423,25 @@ type foo = { bar: 2 }
 
 从 v2.3.0 版本开始，这个预设将自动重命名插件，也适用于您的自定义配置。您可以使用原始前缀直接覆盖规则。
 
+<details>
+<summary>恢复原始前缀</summary>
+
+如果你确实想使用原始前缀，可以通过以下方式还原插件重命名：
+
+```ts
+import kirklin from "@kirklin/eslint-config";
+
+export default kirklin()
+  .renamePlugins({
+    ts: "@typescript-eslint",
+    yaml: "yml",
+    node: "n"
+    // ...
+  });
+```
+
+</details>
+
 ### 规则覆盖
 
 某些规则仅在特定文件中启用，例如， `ts/*` 规则仅在 `.ts` 文件中启用， `vue/*` 规则仅在 `.vue` 文件中启用。如果要覆盖规则，需要指定文件扩展名：
@@ -384,7 +498,7 @@ export default kirklin({
 
 ### 配置组合器
 
-从 v2.3.0 版本开始，工厂函数 `kirklin()` 返回了一个来自 `eslint-flat-config-utils` 的 [`FlatConfigComposer` 对象](https://github.com/antfu/eslint-flat-config-utils#composer)。您可以链式调用方法，以更加灵活地组合配置。
+从 v2.3.0 版本开始，工厂函数 `kirklin()` 返回了一个来自 `eslint-flat-config-utils` 的 [`FlatConfigComposer` 对象](https://github.com/kirklin/eslint-flat-config-utils#composer)。您可以链式调用方法，以更加灵活地组合配置。
 
 ```js
 // eslint.config.js
@@ -718,6 +832,8 @@ This project is based on [@antfu/eslint-config](https://github.com/antfu/eslint-
 
 - [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