chore: fix internal type references to Plugin and Rule (#19665)

fasttime · web-flow · commit f1c858e3c1e9 · 2025-04-28T15:43:24.000+02:00
diff --git a/lib/cli-engine/cli-engine.js b/lib/cli-engine/cli-engine.js
@@ -63,10 +63,10 @@ const validFixTypes = new Set(["directive", "problem", "suggestion", "layout"]);
 /** @typedef {import("../shared/types").LintMessage} LintMessage */
 /** @typedef {import("../shared/types").SuppressedLintMessage} SuppressedLintMessage */
 /** @typedef {import("../shared/types").ParserOptions} ParserOptions */
-/** @typedef {import("../shared/types").Plugin} Plugin */
 /** @typedef {import("../shared/types").RuleConf} RuleConf */
 /** @typedef {import("../types").Rule.RuleModule} Rule */
 /** @typedef {import("../types").ESLint.FormatterFunction} FormatterFunction */
+/** @typedef {import("../types").ESLint.Plugin} Plugin */
 /** @typedef {ReturnType<CascadingConfigArrayFactory.getConfigArrayForFile>} ConfigArray */
 /** @typedef {ReturnType<ConfigArray.extractConfig>} ExtractedConfig */
 
diff --git a/lib/cli.js b/lib/cli.js
@@ -44,8 +44,8 @@ const debug = require("debug")("eslint:cli");
 /** @typedef {import("./eslint/eslint").LintMessage} LintMessage */
 /** @typedef {import("./eslint/eslint").LintResult} LintResult */
 /** @typedef {import("./options").ParsedCLIOptions} ParsedCLIOptions */
-/** @typedef {import("./shared/types").Plugin} Plugin */
 /** @typedef {import("./shared/types").ResultsMeta} ResultsMeta */
+/** @typedef {import("./types").ESLint.Plugin} Plugin */
 
 //------------------------------------------------------------------------------
 // Helpers
diff --git a/lib/eslint/eslint.js b/lib/eslint/eslint.js
@@ -57,10 +57,11 @@ const { ConfigLoader, LegacyConfigLoader } = require("../config/config-loader");
  * @import { CLIEngineLintReport } from "./legacy-eslint.js";
  * @import { FlatConfigArray } from "../config/flat-config-array.js";
  * @import { RuleDefinition } from "@eslint/core";
- * @import { ConfigData, DeprecatedRuleInfo, LintMessage, LintResult, Plugin, ResultsMeta } from "../shared/types.js";
+ * @import { ConfigData, DeprecatedRuleInfo, LintMessage, LintResult, ResultsMeta } from "../shared/types.js";
  */
 
 /** @typedef {ReturnType<ConfigArray.extractConfig>} ExtractedConfig */
+/** @typedef {import("../types").ESLint.Plugin} Plugin */
 
 /**
  * The options with which to configure the ESLint instance.
diff --git a/lib/eslint/legacy-eslint.js b/lib/eslint/legacy-eslint.js
@@ -34,10 +34,10 @@ const { version } = require("../../package.json");
 /** @typedef {import("../shared/types").ConfigData} ConfigData */
 /** @typedef {import("../shared/types").LintMessage} LintMessage */
 /** @typedef {import("../shared/types").SuppressedLintMessage} SuppressedLintMessage */
-/** @typedef {import("../shared/types").Plugin} Plugin */
-/** @typedef {import("../types").Rule.RuleModule} Rule */
 /** @typedef {import("../shared/types").LintResult} LintResult */
 /** @typedef {import("../shared/types").ResultsMeta} ResultsMeta */
+/** @typedef {import("../types").ESLint.Plugin} Plugin */
+/** @typedef {import("../types").Rule.RuleModule} Rule */
 
 /**
  * The main formatter object.
diff --git a/lib/rules/index.js b/lib/rules/index.js
@@ -10,7 +10,7 @@
 
 const { LazyLoadingRuleMap } = require("./utils/lazy-loading-rule-map");
 
-/** @type {Map<string, import("../shared/types").Rule>} */
+/** @type {Map<string, import("../types").Rule.RuleModule>} */
 module.exports = new LazyLoadingRuleMap(
 	Object.entries({
 		"accessor-pairs": () => require("./accessor-pairs"),
diff --git a/lib/rules/utils/lazy-loading-rule-map.js b/lib/rules/utils/lazy-loading-rule-map.js
@@ -6,7 +6,7 @@
 
 const debug = require("debug")("eslint:rules");
 
-/** @typedef {import("../../shared/types").Rule} Rule */
+/** @typedef {import("../../types").Rule.RuleModule} Rule */
 
 /**
  * The `Map` object that loads each rule when it's accessed.
@@ -19,7 +19,7 @@ const debug = require("debug")("eslint:rules");
  *
  * rules.get("semi"); // call `() => require("semi")` here.
  *
- * @extends {Map<string, () => Rule>}
+ * @extends {Map<string, Rule>}
  */
 class LazyLoadingRuleMap extends Map {
 	/**
diff --git a/lib/shared/types.js b/lib/shared/types.js
@@ -166,14 +166,6 @@ module.exports = {};
  * @property {{ name?: string, url?: string }} [rule] Name and information of the replacement rule
  */
 
-/**
- * @typedef {Object} Plugin
- * @property {Record<string, ConfigData>} [configs] The definition of plugin configs.
- * @property {Record<string, Environment>} [environments] The definition of plugin environments.
- * @property {Record<string, Processor>} [processors] The definition of plugin processors.
- * @property {Record<string, Rule>} [rules] The definition of plugin rules.
- */
-
 /**
  * Information of deprecated rules.
  * @typedef {Object} DeprecatedRuleInfo

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`const debug = require("debug")("eslint:rules");`
`8`	`8`
`9`		`-/** @typedef {import("../../shared/types").Rule} Rule */`
	`9`	`+/** @typedef {import("../../types").Rule.RuleModule} Rule */`
`10`	`10`
`11`	`11`	`/**`
`12`	`12`	* The `Map` object that loads each rule when it's accessed.
`@@ -19,7 +19,7 @@ const debug = require("debug")("eslint:rules");`
`19`	`19`	`*`
`20`	`20`	* rules.get("semi"); // call `() => require("semi")` here.
`21`	`21`	`*`
`22`		`- * @extends {Map<string, () => Rule>}`
	`22`	`+ * @extends {Map<string, Rule>}`
`23`	`23`	`*/`
`24`	`24`	`class LazyLoadingRuleMap extends Map {`
`25`	`25`	`/**`