feat: change editor rules from disable to non-fixable

Author: kirklin

README.md

@@ -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

README.zh-cn.md

@@ -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
 

src/configs/javascript.ts

@@ -48,6 +48,7 @@ export async function javascript(
         "accessor-pairs": ["error", { enforceForClassMembers: true, setWithoutGet: true }],
 
         "array-callback-return": "error",
+
         "block-scoped-var": "error",
         "constructor-super": "error",
         "default-case-last": "error",
@@ -177,7 +178,7 @@ export async function javascript(
           },
         ],
         "prefer-const": [
-          "error",
+          isInEditor ? "warn" : "error",
           {
             destructuring: "all",
             ignoreReadBeforeAssign: true,
@@ -191,7 +192,7 @@ export async function javascript(
         "prefer-template": "error",
         "symbol-description": "error",
         "unicode-bom": ["error", "never"],
-        "unused-imports/no-unused-imports": isInEditor ? "off" : "error",
+        "unused-imports/no-unused-imports": isInEditor ? "warn" : "error",
         "unused-imports/no-unused-vars": [
           "error",
           {

src/configs/test.ts

@@ -47,7 +47,7 @@ export async function test(
         "test/consistent-test-it": ["error", { fn: "it", withinDescribe: "it" }],
         "test/no-identical-title": "error",
         "test/no-import-node-test": "error",
-        "test/no-only-tests": isInEditor ? "off" : "error",
+        "test/no-only-tests": isInEditor ? "warn" : "error",
 
         "test/prefer-hooks-in-order": "error",
         "test/prefer-lowercase-title": "error",

src/factory.ts

@@ -33,7 +33,6 @@ import {
   yaml,
 } from "./configs";
 import { formatters } from "./configs/formatters";
-
 import { regexp } from "./configs/regexp";
 import { interopDefault, isInEditorEnv } from "./utils";
 
@@ -102,7 +101,7 @@ export function kirklin(
   if (isInEditor == null) {
     isInEditor = isInEditorEnv();
     if (isInEditor) {
-      console.info("[@kirklin/eslint-config] Detected running in editor, some rules are disabled.");
+      console.log("[@kirklin/eslint-config] Detected running in editor, some rules are disabled.");
     }
   }
 
@@ -207,6 +206,7 @@ export function kirklin(
 
   if (enableReact) {
     configs.push(react({
+      ...typescriptOptions,
       overrides: getOverrides(options, "react"),
       tsconfigPath,
     }));
@@ -318,6 +318,17 @@ export function kirklin(
       .renamePlugins(defaultPluginRenaming);
   }
 
+  if (isInEditor) {
+    composer = composer
+      .disableRulesFix([
+        "unused-imports/no-unused-imports",
+        "test/no-only-tests",
+        "prefer-const",
+      ], {
+        builtinRules: () => import(["eslint", "use-at-your-own-risk"].join("/")).then(r => r.builtinRules),
+      });
+  }
+
   return composer;
 }