refactor: refine plugin configuration types (#1209)

Rel1cx · web-flow · commit a878b8fee200 · 2025-08-31T03:02:50.000+08:00
diff --git a/examples/react-dom/eslint.config.js b/examples/react-dom/eslint.config.js
@@ -1,3 +1,5 @@
+// @ts-check
+
 import eslintReact from "@eslint-react/eslint-plugin";
 import eslintJs from "@eslint/js";
 import eslintPluginReactHooks from "eslint-plugin-react-hooks";
diff --git a/packages/plugins/eslint-plugin-react-debug/src/configs/all.ts b/packages/plugins/eslint-plugin-react-debug/src/configs/all.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 import { DEFAULT_ESLINT_REACT_SETTINGS } from "@eslint-react/shared";
 
 export const name = "react-debug/all";
@@ -9,7 +9,7 @@ export const rules = {
   "react-debug/hook": "warn",
   "react-debug/is-from-react": "warn",
   "react-debug/jsx": "warn",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const settings = {
   "react-x": DEFAULT_ESLINT_REACT_SETTINGS,
diff --git a/packages/plugins/eslint-plugin-react-debug/src/index.ts b/packages/plugins/eslint-plugin-react-debug/src/index.ts
@@ -1,5 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
-import type { CompatibleConfig } from "@eslint-react/shared";
+import type { CompatibleConfig } from "@eslint-react/kit";
 
 import * as allConfig from "./configs/all";
 import { plugin } from "./plugin";
@@ -13,7 +12,7 @@ function toFlatConfig(config: CompatibleConfig) {
   };
 }
 
-function toLegacyConfig({ rules }: { rules: RulePreset }) {
+function toLegacyConfig({ rules }: CompatibleConfig) {
   return {
     plugins: ["react-debug"],
     rules,
diff --git a/packages/plugins/eslint-plugin-react-debug/src/plugin.ts b/packages/plugins/eslint-plugin-react-debug/src/plugin.ts
@@ -1,4 +1,4 @@
-import type { CompatiblePlugin } from "@eslint-react/shared";
+import type { CompatiblePlugin } from "@eslint-react/kit";
 
 import { name, version } from "../package.json";
 
diff --git a/packages/plugins/eslint-plugin-react-dom/src/configs/recommended.ts b/packages/plugins/eslint-plugin-react-dom/src/configs/recommended.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 import { DEFAULT_ESLINT_REACT_SETTINGS } from "@eslint-react/shared";
 
 export const name = "react-dom/recommended";
@@ -20,7 +20,7 @@ export const rules = {
   "react-dom/no-unsafe-target-blank": "warn",
   "react-dom/no-use-form-state": "error",
   "react-dom/no-void-elements-with-children": "error",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const settings = {
   "react-x": DEFAULT_ESLINT_REACT_SETTINGS,
diff --git a/packages/plugins/eslint-plugin-react-dom/src/index.ts b/packages/plugins/eslint-plugin-react-dom/src/index.ts
@@ -1,5 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
-import type { CompatibleConfig } from "@eslint-react/shared";
+import type { CompatibleConfig } from "@eslint-react/kit";
 
 import * as recommendedConfig from "./configs/recommended";
 import { plugin } from "./plugin";
@@ -13,7 +12,7 @@ function toFlatConfig(config: CompatibleConfig) {
   };
 }
 
-function toLegacyConfig({ rules }: { rules: RulePreset }) {
+function toLegacyConfig({ rules }: CompatibleConfig) {
   return {
     plugins: ["react-dom"],
     rules,
diff --git a/packages/plugins/eslint-plugin-react-dom/src/plugin.ts b/packages/plugins/eslint-plugin-react-dom/src/plugin.ts
@@ -1,4 +1,4 @@
-import type { CompatiblePlugin } from "@eslint-react/shared";
+import type { CompatiblePlugin } from "@eslint-react/kit";
 
 import { name, version } from "../package.json";
 
diff --git a/packages/plugins/eslint-plugin-react-hooks-extra/src/configs/recommended.ts b/packages/plugins/eslint-plugin-react-hooks-extra/src/configs/recommended.ts
@@ -1,7 +1,7 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 export const name = "react-hooks-extra/recommended";
 
 export const rules = {
   "react-hooks-extra/no-direct-set-state-in-use-effect": "warn",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
diff --git a/packages/plugins/eslint-plugin-react-hooks-extra/src/index.ts b/packages/plugins/eslint-plugin-react-hooks-extra/src/index.ts
@@ -1,5 +1,5 @@
-import type { RulePreset } from "@eslint-react/kit";
-import type { CompatibleConfig } from "@eslint-react/shared";
+import type { RuleConfig } from "@eslint-react/kit";
+import type { CompatibleConfig } from "@eslint-react/kit";
 
 import * as recommendedConfig from "./configs/recommended";
 import { plugin } from "./plugin";
@@ -13,7 +13,7 @@ function toFlatConfig(config: CompatibleConfig) {
   };
 }
 
-function toLegacyConfig({ rules }: { rules: RulePreset }) {
+function toLegacyConfig({ rules }: CompatibleConfig) {
   return {
     plugins: ["react-hooks-extra"],
     rules,
diff --git a/packages/plugins/eslint-plugin-react-hooks-extra/src/plugin.ts b/packages/plugins/eslint-plugin-react-hooks-extra/src/plugin.ts
@@ -1,4 +1,4 @@
-import type { CompatiblePlugin } from "@eslint-react/shared";
+import type { CompatiblePlugin } from "@eslint-react/kit";
 
 import { name, version } from "../package.json";
 
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/src/configs/recommended.ts b/packages/plugins/eslint-plugin-react-naming-convention/src/configs/recommended.ts
@@ -1,8 +1,8 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 export const name = "react-naming-convention/recommended";
 
 export const rules = {
   "react-naming-convention/context-name": "warn",
   // "react-naming-convention/use-state": "warn",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/src/index.ts b/packages/plugins/eslint-plugin-react-naming-convention/src/index.ts
@@ -1,5 +1,5 @@
-import type { RulePreset } from "@eslint-react/kit";
-import type { CompatibleConfig } from "@eslint-react/shared";
+import type { RuleConfig } from "@eslint-react/kit";
+import type { CompatibleConfig } from "@eslint-react/kit";
 
 import * as recommendedConfig from "./configs/recommended";
 import { plugin } from "./plugin";
@@ -13,7 +13,7 @@ function toFlatConfig(config: CompatibleConfig) {
   };
 }
 
-function toLegacyConfig({ rules }: { rules: RulePreset }) {
+function toLegacyConfig({ rules }: CompatibleConfig) {
   return {
     plugins: ["react-naming-convention"],
     rules,
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/src/plugin.ts b/packages/plugins/eslint-plugin-react-naming-convention/src/plugin.ts
@@ -1,4 +1,4 @@
-import type { CompatiblePlugin } from "@eslint-react/shared";
+import type { CompatiblePlugin } from "@eslint-react/kit";
 
 import { name, version } from "../package.json";
 
diff --git a/packages/plugins/eslint-plugin-react-web-api/src/configs/recommended.ts b/packages/plugins/eslint-plugin-react-web-api/src/configs/recommended.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 import { DEFAULT_ESLINT_REACT_SETTINGS } from "@eslint-react/shared";
 
 export const name = "react-web-api/recommended";
@@ -8,7 +8,7 @@ export const rules = {
   "react-web-api/no-leaked-interval": "warn",
   "react-web-api/no-leaked-resize-observer": "warn",
   "react-web-api/no-leaked-timeout": "warn",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const settings = {
   "react-x": DEFAULT_ESLINT_REACT_SETTINGS,
diff --git a/packages/plugins/eslint-plugin-react-web-api/src/index.ts b/packages/plugins/eslint-plugin-react-web-api/src/index.ts
@@ -1,5 +1,5 @@
-import type { RulePreset } from "@eslint-react/kit";
-import type { CompatibleConfig } from "@eslint-react/shared";
+import type { RuleConfig } from "@eslint-react/kit";
+import type { CompatibleConfig } from "@eslint-react/kit";
 
 import * as recommendedConfig from "./configs/recommended";
 import { plugin } from "./plugin";
@@ -13,7 +13,7 @@ function toFlatConfig(config: CompatibleConfig) {
   };
 }
 
-function toLegacyConfig({ rules }: { rules: RulePreset }) {
+function toLegacyConfig({ rules }: CompatibleConfig) {
   return {
     plugins: ["react-web-api"],
     rules,
diff --git a/packages/plugins/eslint-plugin-react-web-api/src/plugin.ts b/packages/plugins/eslint-plugin-react-web-api/src/plugin.ts
@@ -1,4 +1,4 @@
-import type { CompatiblePlugin } from "@eslint-react/shared";
+import type { CompatiblePlugin } from "@eslint-react/kit";
 
 import { name, version } from "../package.json";
 
diff --git a/packages/plugins/eslint-plugin-react-x/src/configs/recommended-type-checked.ts b/packages/plugins/eslint-plugin-react-x/src/configs/recommended-type-checked.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 import * as recommendedTypeScript from "./recommended-typescript";
 
@@ -8,7 +8,7 @@ export const rules = {
   ...recommendedTypeScript.rules,
   "react-x/no-leaked-conditional-rendering": "warn",
   "react-x/no-unused-props": "warn",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const settings = {
   ...recommendedTypeScript.settings,
diff --git a/packages/plugins/eslint-plugin-react-x/src/configs/recommended-typescript.ts b/packages/plugins/eslint-plugin-react-x/src/configs/recommended-typescript.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 import * as recommended from "./recommended";
 
@@ -10,7 +10,7 @@ export const rules = {
   "react-x/jsx-no-undef": "off",
   "react-x/jsx-uses-react": "off",
   "react-x/jsx-uses-vars": "off",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const settings = {
   ...recommended.settings,
diff --git a/packages/plugins/eslint-plugin-react-x/src/configs/recommended.ts b/packages/plugins/eslint-plugin-react-x/src/configs/recommended.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 import { DEFAULT_ESLINT_REACT_SETTINGS } from "@eslint-react/shared";
 
 export const name = "react-x/recommended";
@@ -47,7 +47,7 @@ export const rules = {
   "react-x/no-use-context": "warn",
   "react-x/no-useless-forward-ref": "warn",
   "react-x/prefer-use-state-lazy-initialization": "warn",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const settings = {
   "react-x": DEFAULT_ESLINT_REACT_SETTINGS,
diff --git a/packages/plugins/eslint-plugin-react-x/src/index.ts b/packages/plugins/eslint-plugin-react-x/src/index.ts
@@ -1,5 +1,5 @@
-import type { RulePreset } from "@eslint-react/kit";
-import type { CompatibleConfig } from "@eslint-react/shared";
+import type { RuleConfig } from "@eslint-react/kit";
+import type { CompatibleConfig } from "@eslint-react/kit";
 
 import * as recommendedConfig from "./configs/recommended";
 import * as recommendedTypeCheckedConfig from "./configs/recommended-type-checked";
@@ -15,7 +15,7 @@ function toFlatConfig(config: CompatibleConfig) {
   };
 }
 
-function toLegacyConfig({ rules }: { rules: RulePreset }) {
+function toLegacyConfig({ rules }: CompatibleConfig) {
   return {
     plugins: ["react-x"],
     rules,
diff --git a/packages/plugins/eslint-plugin-react-x/src/plugin.ts b/packages/plugins/eslint-plugin-react-x/src/plugin.ts
@@ -1,4 +1,4 @@
-import type { CompatiblePlugin } from "@eslint-react/shared";
+import type { CompatiblePlugin } from "@eslint-react/kit";
 
 import { name, version } from "../package.json";
 
diff --git a/packages/plugins/eslint-plugin/README.md b/packages/plugins/eslint-plugin/README.md
@@ -165,8 +165,8 @@ export default tseslint.config({
 
 Contributions are welcome!
 
-Please follow our [contributing guidelines](https://github.com/Rel1cx/eslint-react/tree/2.0.0/.github/CONTRIBUTING.md).
+Please follow our [contributing guidelines](https://github.com/Rel1cx/eslint-react/tree/feature/refine-plugin-configuration-types/.github/CONTRIBUTING.md).
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](https://github.com/Rel1cx/eslint-react/tree/2.0.0/LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/Rel1cx/eslint-react/tree/feature/refine-plugin-configuration-types/LICENSE) file for details.
diff --git a/packages/plugins/eslint-plugin/src/configs/all.ts b/packages/plugins/eslint-plugin/src/configs/all.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 import reactDebug from "eslint-plugin-react-debug";
 import reactHooksExtra from "eslint-plugin-react-hooks-extra";
 import reactNamingConvention from "eslint-plugin-react-naming-convention";
@@ -104,7 +104,7 @@ export const rules = {
   "@eslint-react/naming-convention/filename": "warn",
   "@eslint-react/naming-convention/filename-extension": "warn",
   "@eslint-react/naming-convention/use-state": "warn",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const plugins = {
   ...x.plugins,
diff --git a/packages/plugins/eslint-plugin/src/configs/debug.ts b/packages/plugins/eslint-plugin/src/configs/debug.ts
@@ -1,3 +1,5 @@
+import type { RuleConfig } from "@eslint-react/kit";
+
 import reactDebug from "eslint-plugin-react-debug";
 
 export const name = "@eslint-react/debug";
@@ -8,7 +10,7 @@ export const rules = {
   "@eslint-react/debug/hook": "warn",
   "@eslint-react/debug/is-from-react": "warn",
   "@eslint-react/debug/jsx": "warn",
-} as const;
+} as const satisfies Record<string, RuleConfig>;
 
 export const plugins = {
   "@eslint-react/debug": reactDebug,
diff --git a/packages/plugins/eslint-plugin/src/configs/disable-conflict-eslint-plugin-react.ts b/packages/plugins/eslint-plugin/src/configs/disable-conflict-eslint-plugin-react.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 // This rulelist should be kept in sync with `apps/website/content/docs/migration.mdx`
 // Rules provided by `eslint-plugin-react` that exist in this plugin.
@@ -54,6 +54,6 @@ const conflictingRules = [
 
 export const name = "@eslint-react/disable-conflict-eslint-plugin-react";
 
-export const rules: RulePreset = Object.fromEntries(
+export const rules: Record<string, RuleConfig> = Object.fromEntries(
   conflictingRules.map((key) => [key, "off"] as const),
 );
diff --git a/packages/plugins/eslint-plugin/src/configs/disable-debug.ts b/packages/plugins/eslint-plugin/src/configs/disable-debug.ts
@@ -1,7 +1,9 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 import { rules as debugRules } from "./debug";
 
 export const name = "@eslint-react/disable-debug";
 
-export const rules: RulePreset = Object.fromEntries(Object.entries(debugRules).map(([rule]) => [rule, "off"]));
+export const rules: Record<string, RuleConfig> = Object.fromEntries(
+  Object.entries(debugRules).map(([rule]) => [rule, "off"]),
+);
diff --git a/packages/plugins/eslint-plugin/src/configs/disable-dom.ts b/packages/plugins/eslint-plugin/src/configs/disable-dom.ts
@@ -1,7 +1,9 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 import { rules as domRules } from "./dom";
 
 export const name = "@eslint-react/disable-dom";
 
-export const rules: RulePreset = Object.fromEntries(Object.entries(domRules).map(([key]) => [key, "off"] as const));
+export const rules: Record<string, RuleConfig> = Object.fromEntries(
+  Object.entries(domRules).map(([key]) => [key, "off"] as const),
+);
diff --git a/packages/plugins/eslint-plugin/src/configs/disable-type-checked.ts b/packages/plugins/eslint-plugin/src/configs/disable-type-checked.ts
@@ -1,8 +1,8 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 export const name = "@eslint-react/disable-type-checked";
 
-export const rules: RulePreset = {
+export const rules: Record<string, RuleConfig> = {
   "@eslint-react/no-leaked-conditional-rendering": "off",
   "@eslint-react/no-unused-props": "off",
   "@eslint-react/prefer-read-only-props": "off",
diff --git a/packages/plugins/eslint-plugin/src/configs/disable-web-api.ts b/packages/plugins/eslint-plugin/src/configs/disable-web-api.ts
@@ -1,7 +1,9 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 import { rules as webApiRules } from "./web-api";
 
 export const name = "@eslint-react/disable-web-api";
 
-export const rules: RulePreset = Object.fromEntries(Object.entries(webApiRules).map(([key]) => [key, "off"] as const));
+export const rules: Record<string, RuleConfig> = Object.fromEntries(
+  Object.entries(webApiRules).map(([key]) => [key, "off"] as const),
+);
diff --git a/packages/plugins/eslint-plugin/src/configs/dom.ts b/packages/plugins/eslint-plugin/src/configs/dom.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 import { DEFAULT_ESLINT_REACT_SETTINGS } from "@eslint-react/shared";
 import reactDom from "eslint-plugin-react-dom";
 
@@ -20,7 +20,7 @@ export const rules = {
   "@eslint-react/dom/no-unsafe-target-blank": "warn",
   "@eslint-react/dom/no-use-form-state": "error",
   "@eslint-react/dom/no-void-elements-with-children": "error",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const plugins = {
   "@eslint-react/dom": reactDom,
diff --git a/packages/plugins/eslint-plugin/src/configs/off.ts b/packages/plugins/eslint-plugin/src/configs/off.ts
@@ -1,11 +1,11 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 import { rules as allRules } from "./all";
 import { rules as disableTypeCheckedRules } from "./disable-type-checked";
 
 export const name = "@eslint-react/off";
 
-export const rules: RulePreset = {
+export const rules: Record<string, RuleConfig> = {
   ...Object.fromEntries(Object.entries(allRules).map(([key]) => [key, "off"] as const)),
   ...disableTypeCheckedRules,
 };
diff --git a/packages/plugins/eslint-plugin/src/configs/recommended-type-checked.ts b/packages/plugins/eslint-plugin/src/configs/recommended-type-checked.ts
@@ -1,4 +1,4 @@
-import type { RulePreset } from "@eslint-react/kit";
+import type { RuleConfig } from "@eslint-react/kit";
 
 import * as recommendedTypeScript from "./recommended-typescript";
 
@@ -9,7 +9,7 @@ export const rules = {
   "@eslint-react/no-leaked-conditional-rendering": "warn",
   "@eslint-react/no-unused-props": "warn",
   // "@eslint-react/prefer-read-only-props": "warn",
-} as const satisfies RulePreset;
+} as const satisfies Record<string, RuleConfig>;
 
 export const plugins = {
   ...recommendedTypeScript.plugins,
diff --git a/packages/plugins/eslint-plugin/src/configs/recommended-typescript.ts b/packages/plugins/eslint-plugin/src/configs/recommended-typescript.ts
diff --git a/packages/plugins/eslint-plugin/src/configs/recommended.ts b/packages/plugins/eslint-plugin/src/configs/recommended.ts
diff --git a/packages/plugins/eslint-plugin/src/configs/web-api.ts b/packages/plugins/eslint-plugin/src/configs/web-api.ts
diff --git a/packages/plugins/eslint-plugin/src/configs/x.ts b/packages/plugins/eslint-plugin/src/configs/x.ts
diff --git a/packages/plugins/eslint-plugin/src/index.ts b/packages/plugins/eslint-plugin/src/index.ts
diff --git a/packages/shared/docs/README.md b/packages/shared/docs/README.md
diff --git a/packages/shared/docs/interfaces/CompatibleConfig.md b/packages/shared/docs/interfaces/CompatibleConfig.md
diff --git a/packages/shared/docs/interfaces/CompatiblePlugin.md b/packages/shared/docs/interfaces/CompatiblePlugin.md
diff --git a/packages/shared/src/compatibility-types.ts b/packages/shared/src/compatibility-types.ts
diff --git a/packages/shared/src/index.ts b/packages/shared/src/index.ts
diff --git a/packages/utilities/kit/src/types.ts b/packages/utilities/kit/src/types.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// @ts-check`
	`2`	`+`
`1`	`3`	`import eslintReact from "@eslint-react/eslint-plugin";`
`2`	`4`	`import eslintJs from "@eslint/js";`
`3`	`5`	`import eslintPluginReactHooks from "eslint-plugin-react-hooks";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { CompatiblePlugin } from "@eslint-react/shared";`
	`1`	`+import type { CompatiblePlugin } from "@eslint-react/kit";`
`2`	`2`
`3`	`3`	`import { name, version } from "../package.json";`
`4`	`4`