npm - @kirklin/eslint-config - Versions diffs - 2.7.0 → 3.0.0 - Mend

@kirklin/eslint-config 2.7.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md CHANGED Viewed

@@ -24,9 +24,6 @@
 <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.
@@ -748,9 +745,15 @@ export default kirklin({
 ### 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)
+Auto-fixing for the following rules are disabled when ESLint is running in a code editor:
+- [`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)
+Since v3.0.0, they are no longer disabled, but made non-fixable using [this helper](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix).
-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:
+This is to prevent unused imports from getting removed by the editor 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

package/README.zh-cn.md CHANGED Viewed

@@ -40,10 +40,10 @@
 - 可选的[格式化程序](#formatters)支持CSS，HTML，XML等。
 - **样式原则**：最小化阅读，稳定的差异性，保持一致性
-> [!IMPORTANT]
-> 从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,20 +747,19 @@ export default kirklin({
 });
 ```
-### 编辑器特定禁用
+### 编辑器特定的禁用规则
-有些规则在ESLint IDE集成中被禁用，具体来说是 [`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)。
+当 ESLint 在代码编辑器中运行时，以下规则的自动修复功能被禁用：
-这样做是为了防止在重构过程中IDE自动移除未使用的导入，以提供更好的开发体验。当您在终端或使用 [Lint Staged](#lint-staged) 运行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)
-```js
-// eslint.config.js
-import kirklin from "@kirklin/eslint-config";
+自 v3.0.0 版本起，这些规则不再被完全禁用，而是通过 [此辅助工具](https://github.com/antfu/eslint-flat-config-utils#composerdisablerulesfix) 设为不可自动修复。
-export default kirklin({
-  isInEditor: false
-});
-```
+这样可以防止编辑器在重构代码时自动删除未使用的导入，以提供更好的开发体验。这些规则仍然会在你通过终端运行 ESLint 或使用 [Lint Staged](#lint-staged) 时生效。
+如果你不希望有这种行为，你可以手动禁用它们。
 ### Lint Staged

package/dist/cli.js CHANGED Viewed

@@ -12,8 +12,8 @@ import c from "picocolors";
 var package_default = {
   name: "@kirklin/eslint-config",
   type: "module",
-  version: "2.7.0",
-  packageManager: "pnpm@9.12.3",
+  version: "3.0.0",
+  packageManager: "pnpm@10.2.1",
   description: "Kirk Lin's ESLint config",
   author: "Kirk Lin (https://github.com/kirklin/)",
   license: "MIT",
@@ -23,10 +23,7 @@ var package_default = {
     "eslint-config"
   ],
   exports: {
-    ".": {
-      import: "./dist/index.js",
-      require: "./dist/index.cjs"
-    }
+    ".": "./dist/index.js"
   },
   main: "./dist/index.js",
   types: "./dist/index.d.ts",
@@ -36,14 +33,14 @@ var package_default = {
     "dist"
   ],
   scripts: {
-    build: "nr typegen && tsup --format esm,cjs --clean --dts",
-    stub: "tsup --format esm",
+    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 --format esm,cjs --watch",
-    lint: "eslint --flag unstable_ts_config .",
-    "lint:fix": "eslint --flag unstable_ts_config . --fix",
-    typegen: "esno scripts/typegen.ts",
+    watch: "tsup --watch",
+    lint: "eslint .",
+    "lint:fix": "eslint . --fix",
+    typegen: "tsx scripts/typegen.ts",
     prepack: "nr build",
     release: "bumpp && pnpm publish",
     test: "vitest",
@@ -51,7 +48,7 @@ var package_default = {
     prepare: "simple-git-hooks"
   },
   peerDependencies: {
-    "@eslint-react/eslint-plugin": "^1.5.8",
+    "@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",
@@ -62,7 +59,7 @@ var package_default = {
     "eslint-plugin-react-refresh": "^0.4.4",
     "eslint-plugin-solid": "^0.14.3",
     "eslint-plugin-svelte": ">=2.35.1",
-    "prettier-plugin-astro": "^0.13.0",
+    "prettier-plugin-astro": "^0.14.0",
     "prettier-plugin-slidev": "^1.0.5",
     "svelte-eslint-parser": ">=0.37.0"
   },
@@ -108,35 +105,35 @@ var package_default = {
     }
   },
   dependencies: {
-    "@antfu/install-pkg": "^0.4.1",
-    "@clack/prompts": "^0.7.0",
+    "@antfu/install-pkg": "^1.0.0",
+    "@clack/prompts": "^0.10.0",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
-    "@eslint/markdown": "^6.2.1",
-    "@stylistic/eslint-plugin": "^2.10.1",
-    "@typescript-eslint/eslint-plugin": "^8.12.2",
-    "@typescript-eslint/parser": "^8.12.2",
-    "@vitest/eslint-plugin": "^1.1.7",
-    "eslint-config-flat-gitignore": "^0.3.0",
-    "eslint-flat-config-utils": "^0.4.0",
-    "eslint-merge-processors": "^0.1.0",
-    "eslint-plugin-command": "^0.2.6",
-    "eslint-plugin-import-x": "^4.4.0",
-    "eslint-plugin-jsdoc": "^50.4.3",
-    "eslint-plugin-jsonc": "^2.16.0",
-    "eslint-plugin-kirklin": "^1.5.0",
-    "eslint-plugin-n": "^17.12.0",
+    "@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": "^3.9.1",
-    "eslint-plugin-regexp": "^2.6.0",
-    "eslint-plugin-toml": "^0.11.1",
-    "eslint-plugin-unicorn": "^56.0.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.30.0",
-    "eslint-plugin-yml": "^1.15.0",
-    "eslint-processor-vue-blocks": "^0.1.2",
-    globals: "^15.11.0",
+    "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": "^0.5.0",
+    "local-pkg": "^1.0.0",
     "parse-gitignore": "^2.0.0",
     picocolors: "^1.1.1",
     "toml-eslint-parser": "^0.10.0",
@@ -145,56 +142,55 @@ var package_default = {
     yargs: "^17.7.2"
   },
   devDependencies: {
-    "@antfu/ni": "^0.23.0",
-    "@eslint-react/eslint-plugin": "^1.15.2",
-    "@eslint/config-inspector": "^0.5.6",
+    "@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": "^2.10.1",
+    "@stylistic/eslint-plugin-migrate": "^3.1.0",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^22.8.6",
+    "@types/node": "^22.13.1",
     "@types/prompts": "^2.4.9",
     "@types/yargs": "^17.0.33",
-    "@unocss/eslint-plugin": "^0.63.6",
-    "astro-eslint-parser": "^1.0.3",
-    bumpp: "^9.8.0",
-    eslint: "^9.14.0",
-    "eslint-plugin-astro": "^1.3.0",
-    "eslint-plugin-format": "^0.1.2",
-    "eslint-plugin-react-hooks": "^5.0.0",
-    "eslint-plugin-react-refresh": "^0.4.14",
-    "eslint-plugin-solid": "^0.14.3",
-    "eslint-plugin-svelte": "^2.46.0",
-    "eslint-typegen": "^0.3.2",
-    esno: "^4.8.0",
-    execa: "^9.5.1",
-    "fast-glob": "^3.3.2",
-    "fs-extra": "^11.2.0",
-    jiti: "^2.4.0",
-    "lint-staged": "^15.2.10",
+    "@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.1.9",
+    svelte: "^5.19.9",
     "svelte-eslint-parser": "^0.43.0",
-    tsup: "^8.3.5",
+    tsup: "^8.3.6",
     tsx: "^4.19.2",
-    typescript: "^5.6.3",
-    vitest: "^2.1.4",
-    vue: "^3.5.12"
+    typescript: "^5.7.3",
+    vitest: "^3.0.5",
+    vue: "^3.5.13"
   },
   resolutions: {
     "@eslint-community/eslint-utils": "^4.4.1",
-    "@typescript-eslint/utils": "^8.12.2",
-    eslint: "^9.14.0",
+    "@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 --flag unstable_ts_config --fix"
+    "*": "eslint --fix"
   }
 };
@@ -242,6 +238,7 @@ var vscodeSettingsString = `
     "gql",
     "graphql",
     "astro",
+    "svelte",
     "css",
     "less",
     "scss",
@@ -565,7 +562,7 @@ async function run(options = {}) {
   await updateEslintFiles(result);
   await updateVscodeSettings(result);
   p4.log.success(c5.green(`Setup completed`));
-  p4.outro(`Now you can update the dependencies and run ${c5.blue("eslint . --fix")}
+  p4.outro(`Now you can update the dependencies by run ${c5.blue("pnpm install")} and run ${c5.blue("eslint . --fix")}
 `);
 }