@kirklin/eslint-config 3.0.0 → 5.0.0

package/README.md

@@ -33,7 +33,7 @@
 - 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
+  - double quotes, no semi
   - Using [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
 - Respects `.gitignore` by default
 - Requires ESLint v9.5.0+
@@ -112,8 +112,8 @@ For example:
 ```json
 {
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint": "eslint",
+    "lint:fix": "eslint --fix"
   }
 }
 ```
@@ -555,6 +555,27 @@ export default kirklin({
 
 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.
 
+#### Vue Accessibility
+
+To enable Vue accessibility support, you need to explicitly turn it on:
+
+```js
+// eslint.config.js
+import kirklin from "@kirklin/eslint-config";
+
+export default kirklin({
+  vue: {
+    a11y: true
+  },
+});
+```
+
+Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+
+```bash
+npm i -D eslint-plugin-vuejs-accessibility
+```
+
 ### Optional Configs
 
 We provide some optional configs for specific use cases, that we don't include their dependencies by default.

package/README.zh-cn.md

@@ -40,10 +40,10 @@
 - 可选的[格式化程序](#formatters)支持CSS，HTML，XML等。
 - **样式原则**：最小化阅读，稳定的差异性，保持一致性
 
-> [!NOTE]  
-> 自 v1.0.0 版本起，该配置已重写为新的 [ESLint Flat 配置](https://eslint.org/docs/latest/use/configure/configuration-files-new)，详细信息请查看 [发布说明](https://github.com/kirklin/eslint-config/releases/tag/v1.0.0)。  
->  
-> 自 v2.7.0 版本起，现要求使用 ESLint v9.5.0 及以上版本。  
+> [!NOTE]
+> 自 v1.0.0 版本起，该配置已重写为新的 [ESLint Flat 配置](https://eslint.org/docs/latest/use/configure/configuration-files-new)，详细信息请查看 [发布说明](https://github.com/kirklin/eslint-config/releases/tag/v1.0.0)。
+>
+> 自 v2.7.0 版本起，现要求使用 ESLint v9.5.0 及以上版本。
 
 ## 使用方法
 
@@ -747,17 +747,17 @@ export default kirklin({
 });
 ```
 
-### 编辑器特定的禁用规则  
+### 编辑器特定的禁用规则
 
-当 ESLint 在代码编辑器中运行时，以下规则的自动修复功能被禁用：  
+当 ESLint 在代码编辑器中运行时，以下规则的自动修复功能被禁用：
 
-- [`prefer-const`](https://eslint.org/docs/rules/prefer-const)  
-- [`test/no-only-tests`](https://github.com/levibuzolic/eslint-plugin-no-only-tests)  
-- [`unused-imports/no-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports)  
+- [`prefer-const`](https://eslint.org/docs/rules/prefer-const)
+- [`test/no-only-tests`](https://github.com/levibuzolic/eslint-plugin-no-only-tests)
+- [`unused-imports/no-unused-imports`](https://www.npmjs.com/package/eslint-plugin-unused-imports)
 
-自 v3.0.0 版本起，这些规则不再被完全禁用，而是通过 [此辅助工具](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix) 设为不可自动修复。  
+自 v3.0.0 版本起，这些规则不再被完全禁用，而是通过 [此辅助工具](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix) 设为不可自动修复。
 
-这样可以防止编辑器在重构代码时自动删除未使用的导入，以提供更好的开发体验。这些规则仍然会在你通过终端运行 ESLint 或使用 [Lint Staged](#lint-staged) 时生效。  
+这样可以防止编辑器在重构代码时自动删除未使用的导入，以提供更好的开发体验。这些规则仍然会在你通过终端运行 ESLint 或使用 [Lint Staged](#lint-staged) 时生效。
 
 如果你不希望有这种行为，你可以手动禁用它们。
 

package/dist/cli.js

@@ -1,200 +1,21 @@
 // src/cli/index.ts
 import process5 from "node:process";
 import * as p5 from "@clack/prompts";
-import c6 from "picocolors";
-import yargs from "yargs";
-import { hideBin } from "yargs/helpers";
-
-// src/cli/constants.ts
-import c from "picocolors";
+import c5 from "ansis";
+import { cac } from "cac";
 
 // package.json
-var package_default = {
-  name: "@kirklin/eslint-config",
-  type: "module",
-  version: "3.0.0",
-  packageManager: "pnpm@10.2.1",
-  description: "Kirk Lin's ESLint config",
-  author: "Kirk Lin (https://github.com/kirklin/)",
-  license: "MIT",
-  funding: "https://www.buymeacoffee.com/linkirk",
-  homepage: "https://github.com/kirklin/eslint-config",
-  keywords: [
-    "eslint-config"
-  ],
-  exports: {
-    ".": "./dist/index.js"
-  },
-  main: "./dist/index.js",
-  types: "./dist/index.d.ts",
-  bin: "./bin/index.js",
-  files: [
-    "bin",
-    "dist"
-  ],
-  scripts: {
-    build: "nr typegen && tsup --clean --dts",
-    stub: "tsup",
-    dev: "npx @eslint/config-inspector --config eslint.config.ts",
-    "build:inspector": "pnpm build && npx @eslint/config-inspector build",
-    watch: "tsup --watch",
-    lint: "eslint .",
-    "lint:fix": "eslint . --fix",
-    typegen: "tsx scripts/typegen.ts",
-    prepack: "nr build",
-    release: "bumpp && pnpm publish",
-    test: "vitest",
-    typecheck: "tsc --noEmit",
-    prepare: "simple-git-hooks"
-  },
-  peerDependencies: {
-    "@eslint-react/eslint-plugin": "^1.19.0",
-    "@prettier/plugin-xml": "^3.4.1",
-    "@unocss/eslint-plugin": ">=0.50.0",
-    "astro-eslint-parser": "^1.0.2",
-    eslint: "^9.10.0",
-    "eslint-plugin-astro": "^1.2.0",
-    "eslint-plugin-format": ">=0.1.0",
-    "eslint-plugin-react-hooks": "^5.0.0",
-    "eslint-plugin-react-refresh": "^0.4.4",
-    "eslint-plugin-solid": "^0.14.3",
-    "eslint-plugin-svelte": ">=2.35.1",
-    "prettier-plugin-astro": "^0.14.0",
-    "prettier-plugin-slidev": "^1.0.5",
-    "svelte-eslint-parser": ">=0.37.0"
-  },
-  peerDependenciesMeta: {
-    "@eslint-react/eslint-plugin": {
-      optional: true
-    },
-    "@prettier/plugin-xml": {
-      optional: true
-    },
-    "@unocss/eslint-plugin": {
-      optional: true
-    },
-    "astro-eslint-parser": {
-      optional: true
-    },
-    "eslint-plugin-astro": {
-      optional: true
-    },
-    "eslint-plugin-format": {
-      optional: true
-    },
-    "eslint-plugin-react-hooks": {
-      optional: true
-    },
-    "eslint-plugin-react-refresh": {
-      optional: true
-    },
-    "eslint-plugin-solid": {
-      optional: true
-    },
-    "eslint-plugin-svelte": {
-      optional: true
-    },
-    "prettier-plugin-astro": {
-      optional: true
-    },
-    "prettier-plugin-slidev": {
-      optional: true
-    },
-    "svelte-eslint-parser": {
-      optional: true
-    }
-  },
-  dependencies: {
-    "@antfu/install-pkg": "^1.0.0",
-    "@clack/prompts": "^0.10.0",
-    "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
-    "@eslint/markdown": "^6.2.2",
-    "@stylistic/eslint-plugin": "^3.1.0",
-    "@typescript-eslint/eslint-plugin": "^8.23.0",
-    "@typescript-eslint/parser": "^8.23.0",
-    "@vitest/eslint-plugin": "^1.1.26",
-    "eslint-config-flat-gitignore": "^2.0.0",
-    "eslint-flat-config-utils": "^2.0.1",
-    "eslint-merge-processors": "^2.0.0",
-    "eslint-plugin-command": "^3.0.0",
-    "eslint-plugin-import-x": "^4.6.1",
-    "eslint-plugin-jsdoc": "^50.6.3",
-    "eslint-plugin-jsonc": "^2.19.1",
-    "eslint-plugin-kirklin": "^2.0.0",
-    "eslint-plugin-n": "^17.15.1",
-    "eslint-plugin-no-only-tests": "^3.3.0",
-    "eslint-plugin-perfectionist": "^4.8.0",
-    "eslint-plugin-regexp": "^2.7.0",
-    "eslint-plugin-toml": "^0.12.0",
-    "eslint-plugin-unicorn": "^56.0.1",
-    "eslint-plugin-unused-imports": "^4.1.4",
-    "eslint-plugin-vue": "^9.32.0",
-    "eslint-plugin-yml": "^1.16.0",
-    "eslint-processor-vue-blocks": "^2.0.0",
-    globals: "^15.14.0",
-    "jsonc-eslint-parser": "^2.4.0",
-    "local-pkg": "^1.0.0",
-    "parse-gitignore": "^2.0.0",
-    picocolors: "^1.1.1",
-    "toml-eslint-parser": "^0.10.0",
-    "vue-eslint-parser": "^9.4.3",
-    "yaml-eslint-parser": "^1.2.3",
-    yargs: "^17.7.2"
-  },
-  devDependencies: {
-    "@antfu/ni": "^23.3.1",
-    "@eslint-react/eslint-plugin": "^1.26.2",
-    "@eslint/config-inspector": "^1.0.0",
-    "@kirklin/eslint-config": "workspace:*",
-    "@prettier/plugin-xml": "^3.4.1",
-    "@stylistic/eslint-plugin-migrate": "^3.1.0",
-    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^22.13.1",
-    "@types/prompts": "^2.4.9",
-    "@types/yargs": "^17.0.33",
-    "@unocss/eslint-plugin": "^65.4.3",
-    "astro-eslint-parser": "^1.2.1",
-    bumpp: "^10.0.2",
-    eslint: "^9.20.0",
-    "eslint-plugin-astro": "^1.3.1",
-    "eslint-plugin-format": "^1.0.1",
-    "eslint-plugin-react-hooks": "^5.1.0",
-    "eslint-plugin-react-refresh": "^0.4.18",
-    "eslint-plugin-solid": "^0.14.5",
-    "eslint-plugin-svelte": "^2.46.1",
-    "eslint-typegen": "^1.0.0",
-    execa: "^9.5.2",
-    "fast-glob": "^3.3.3",
-    "fs-extra": "^11.3.0",
-    jiti: "^2.4.2",
-    "lint-staged": "^15.4.3",
-    "prettier-plugin-astro": "^0.14.1",
-    "prettier-plugin-slidev": "^1.0.5",
-    rimraf: "^6.0.1",
-    "simple-git-hooks": "^2.11.1",
-    svelte: "^5.19.9",
-    "svelte-eslint-parser": "^0.43.0",
-    tsup: "^8.3.6",
-    tsx: "^4.19.2",
-    typescript: "^5.7.3",
-    vitest: "^3.0.5",
-    vue: "^3.5.13"
-  },
-  resolutions: {
-    "@eslint-community/eslint-utils": "^4.4.1",
-    "@typescript-eslint/utils": "^8.23.0",
-    eslint: "^9.20.0",
-    tsx: "^4.19.2"
-  },
-  "simple-git-hooks": {
-    "pre-commit": "npx lint-staged"
-  },
-  "lint-staged": {
-    "*": "eslint --fix"
-  }
-};
+var version = "5.0.0";
+
+// src/cli/run.ts
+import fs3 from "node:fs";
+import path4 from "node:path";
+import process4 from "node:process";
+import * as p4 from "@clack/prompts";
+import c4 from "ansis";
 
 // src/cli/constants.ts
+import c from "ansis";
 var vscodeSettingsString = `
   // Disable the default formatter, use eslint instead
   "prettier.enable": false,
@@ -290,6 +111,12 @@ var dependenciesMap = {
     "eslint-plugin-astro",
     "astro-eslint-parser"
   ],
+  formatter: [
+    "eslint-plugin-format"
+  ],
+  formatterAstro: [
+    "prettier-plugin-astro"
+  ],
   react: [
     "@eslint-react/eslint-plugin",
     "eslint-plugin-react-hooks",
@@ -305,24 +132,20 @@ var dependenciesMap = {
     "eslint-plugin-svelte",
     "svelte-eslint-parser"
   ],
+  unocss: [
+    "@unocss/eslint-plugin"
+  ],
   vue: []
 };
 
-// src/cli/run.ts
-import fs3 from "node:fs";
-import path4 from "node:path";
-import process4 from "node:process";
-import * as p4 from "@clack/prompts";
-import c5 from "picocolors";
-
 // src/cli/stages/update-eslint-files.ts
 import fs from "node:fs";
 import fsp from "node:fs/promises";
 import path from "node:path";
 import process from "node:process";
 import * as p from "@clack/prompts";
+import c2 from "ansis";
 import parse from "parse-gitignore";
-import c2 from "picocolors";
 
 // src/cli/utils.ts
 import { execSync } from "node:child_process";
@@ -357,7 +180,7 @@ async function updateEslintFiles(result) {
   const pathFlatConfig = path.join(cwd, configFileName);
   const eslintIgnores = [];
   if (fs.existsSync(pathESLintIgnore)) {
-    p.log.step(c2.cyan(`Migrating existing .eslintignore`));
+    p.log.step(c2.cyan`Migrating existing .eslintignore`);
     const content = await fsp.readFile(pathESLintIgnore, "utf-8");
     const parsed = parse(content);
     const globs = parsed.globs();
@@ -386,7 +209,7 @@ async function updateEslintFiles(result) {
   const additionalConfig = [];
   const eslintConfigContent = getEslintConfigContent(mainConfig, additionalConfig);
   await fsp.writeFile(pathFlatConfig, eslintConfigContent);
-  p.log.success(c2.green(`Created ${configFileName}`));
+  p.log.success(c2.green`Created ${configFileName}`);
   const files = fs.readdirSync(cwd);
   const legacyConfig = [];
   files.forEach((file) => {
@@ -395,7 +218,7 @@ async function updateEslintFiles(result) {
     }
   });
   if (legacyConfig.length) {
-    p.note(`${c2.dim(legacyConfig.join(", "))}`, "You can now remove those files manually");
+    p.note(c2.dim(legacyConfig.join(", ")), "You can now remove those files manually");
   }
 }
 
@@ -404,37 +227,54 @@ import fsp2 from "node:fs/promises";
 import path2 from "node:path";
 import process2 from "node:process";
 import * as p2 from "@clack/prompts";
-import c3 from "picocolors";
+import c3 from "ansis";
+
+// src/cli/constants-generated.ts
+var versionsMap = {
+  "@eslint-react/eslint-plugin": "^1.43.0",
+  "@unocss/eslint-plugin": "^66.0.0",
+  "astro-eslint-parser": "^1.2.2",
+  "eslint": "^9.24.0",
+  "eslint-plugin-astro": "^1.3.1",
+  "eslint-plugin-format": "^1.0.1",
+  "eslint-plugin-react-hooks": "^5.2.0",
+  "eslint-plugin-react-refresh": "^0.4.19",
+  "eslint-plugin-solid": "^0.14.5",
+  "eslint-plugin-svelte": "^3.5.1",
+  "prettier-plugin-astro": "^0.14.1",
+  "prettier-plugin-slidev": "^1.0.5",
+  "svelte-eslint-parser": "^1.1.2"
+};
+
+// src/cli/stages/update-package-json.ts
 async function updatePackageJson(result) {
   const cwd = process2.cwd();
   const pathPackageJSON = path2.join(cwd, "package.json");
-  p2.log.step(c3.cyan(`Bumping @kirklin/eslint-config to v${package_default.version}`));
+  p2.log.step(c3.cyan`Bumping @kirklin/eslint-config to v${version}`);
   const pkgContent = await fsp2.readFile(pathPackageJSON, "utf-8");
   const pkg = JSON.parse(pkgContent);
   pkg.devDependencies ??= {};
-  pkg.devDependencies["@kirklin/eslint-config"] = `^${package_default.version}`;
-  pkg.devDependencies.eslint ??= package_default.devDependencies.eslint.replace("npm:eslint-ts-patch@", "").replace(/-\d+$/, "");
+  pkg.devDependencies["@kirklin/eslint-config"] = `^${version}`;
+  pkg.devDependencies.eslint ??= versionsMap.eslint;
   const addedPackages = [];
   if (result.extra.length) {
     result.extra.forEach((item) => {
       switch (item) {
         case "formatter":
           [
-            "eslint-plugin-format",
-            result.frameworks.includes("astro") ? "prettier-plugin-astro" : null
+            ...dependenciesMap.formatter,
+            ...result.frameworks.includes("astro") ? dependenciesMap.formatterAstro : []
           ].forEach((f) => {
             if (!f) {
               return;
             }
-            pkg.devDependencies[f] = package_default.devDependencies[f];
+            pkg.devDependencies[f] = versionsMap[f];
             addedPackages.push(f);
           });
           break;
         case "unocss":
-          [
-            "@unocss/eslint-plugin"
-          ].forEach((f) => {
-            pkg.devDependencies[f] = package_default.devDependencies[f];
+          dependenciesMap.unocss.forEach((f) => {
+            pkg.devDependencies[f] = versionsMap[f];
             addedPackages.push(f);
           });
           break;
@@ -445,16 +285,16 @@ async function updatePackageJson(result) {
     const deps = dependenciesMap[framework];
     if (deps) {
       deps.forEach((f) => {
-        pkg.devDependencies[f] = package_default.devDependencies[f];
+        pkg.devDependencies[f] = versionsMap[f];
         addedPackages.push(f);
       });
     }
   }
   if (addedPackages.length) {
-    p2.note(`${c3.dim(addedPackages.join(", "))}`, "Added packages");
+    p2.note(c3.dim(addedPackages.join(", ")), "Added packages");
   }
   await fsp2.writeFile(pathPackageJSON, JSON.stringify(pkg, null, 2));
-  p2.log.success(c3.green(`Changes wrote to package.json`));
+  p2.log.success(c3.green`Changes wrote to package.json`);
 }
 
 // src/cli/stages/update-vscode-settings.ts
@@ -463,7 +303,7 @@ import fsp3 from "node:fs/promises";
 import path3 from "node:path";
 import process3 from "node:process";
 import * as p3 from "@clack/prompts";
-import c4 from "picocolors";
+import { green } from "ansis";
 async function updateVscodeSettings(result) {
   const cwd = process3.cwd();
   if (!result.updateVscodeSettings) {
@@ -477,7 +317,7 @@ async function updateVscodeSettings(result) {
   if (!fs2.existsSync(settingsPath)) {
     await fsp3.writeFile(settingsPath, `{${vscodeSettingsString}}
 `, "utf-8");
-    p3.log.success(c4.green(`Created .vscode/settings.json`));
+    p3.log.success(green`Created .vscode/settings.json`);
   } else {
     let settingsContent = await fsp3.readFile(settingsPath, "utf8");
     settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
@@ -485,17 +325,17 @@ async function updateVscodeSettings(result) {
     settingsContent += `${vscodeSettingsString}}
 `;
     await fsp3.writeFile(settingsPath, settingsContent, "utf-8");
-    p3.log.success(c4.green(`Updated .vscode/settings.json`));
+    p3.log.success(green`Updated .vscode/settings.json`);
   }
 }
 
 // src/cli/run.ts
 async function run(options = {}) {
   const argSkipPrompt = !!process4.env.SKIP_PROMPT || options.yes;
-  const argTemplate = options.frameworks?.map((m) => m.trim());
-  const argExtra = options.extra?.map((m) => m.trim());
+  const argTemplate = options.frameworks?.map((m) => m?.trim()).filter(Boolean);
+  const argExtra = options.extra?.map((m) => m?.trim()).filter(Boolean);
   if (fs3.existsSync(path4.join(process4.cwd(), "eslint.config.js"))) {
-    p4.log.warn(c5.yellow(`eslint.config.js already exists, migration wizard exited.`));
+    p4.log.warn(c4.yellow`eslint.config.js already exists, migration wizard exited.`);
     return process4.exit(1);
   }
   let result = {
@@ -522,7 +362,7 @@ async function run(options = {}) {
         }
         const message = !isArgTemplateValid && argTemplate ? `"${argTemplate}" isn't a valid template. Please choose from below: ` : "Select a framework:";
         return p4.multiselect({
-          message: c5.reset(message),
+          message: c4.reset(message),
           options: frameworkOptions,
           required: false
         });
@@ -534,7 +374,7 @@ async function run(options = {}) {
         }
         const message = !isArgExtraValid && argExtra ? `"${argExtra}" isn't a valid extra util. Please choose from below: ` : "Select a extra utils:";
         return p4.multiselect({
-          message: c5.reset(message),
+          message: c4.reset(message),
           options: extraOptions,
           required: false
         });
@@ -561,42 +401,27 @@ async function run(options = {}) {
   await updatePackageJson(result);
   await updateEslintFiles(result);
   await updateVscodeSettings(result);
-  p4.log.success(c5.green(`Setup completed`));
-  p4.outro(`Now you can update the dependencies by run ${c5.blue("pnpm install")} and run ${c5.blue("eslint . --fix")}
+  p4.log.success(c4.green`Setup completed`);
+  p4.outro(`Now you can update the dependencies by run ${c4.blue("pnpm install")} and run ${c4.blue("eslint --fix")}
 `);
 }
 
 // src/cli/index.ts
 function header() {
   console.log("\n");
-  p5.intro(`${c6.green(`@kirklin/eslint-config `)}${c6.dim(`v${package_default.version}`)}`);
+  p5.intro(`${c5.green`@kirklin/eslint-config `}${c5.dim`v${version}`}`);
 }
-var instance = yargs(hideBin(process5.argv)).scriptName("@kirklin/eslint-config").usage("").command(
-  "*",
-  "Run the initialization or migration",
-  (args) => args.option("yes", {
-    alias: "y",
-    description: "Skip prompts and use default values",
-    type: "boolean"
-  }).option("template", {
-    alias: "t",
-    description: "Use the framework template for optimal customization: vue / react / svelte / astro",
-    type: "string"
-  }).option("extra", {
-    alias: "e",
-    array: true,
-    description: "Use the extra utils: formatter / perfectionist / unocss",
-    type: "string"
-  }).help(),
-  async (args) => {
-    header();
-    try {
-      await run(args);
-    } catch (error) {
-      p5.log.error(c6.inverse(c6.red(" Failed to migrate ")));
-      p5.log.error(c6.red(`\u2718 ${String(error)}`));
-      process5.exit(1);
-    }
+var cli = cac("@kirklin/eslint-config");
+cli.command("", "Run the initialization or migration").option("--yes, -y", "Skip prompts and use default values", { default: false }).option("--template, -t <template>", "Use the framework template for optimal customization: vue / react / svelte / astro", { type: [] }).option("--extra, -e <extra>", "Use the extra utils: formatter / perfectionist / unocss", { type: [] }).action(async (args) => {
+  header();
+  try {
+    await run(args);
+  } catch (error) {
+    p5.log.error(c5.inverse.red(" Failed to migrate "));
+    p5.log.error(c5.red`✘ ${String(error)}`);
+    process5.exit(1);
   }
-).showHelpOnFail(false).alias("h", "help").version("version", package_default.version).alias("v", "version");
-instance.help().argv;
+});
+cli.help();
+cli.version(version);
+cli.parse();