fix: add info to ESLint.DeprecatedRuleUse type (#19701)

fasttime · web-flow · commit fbb8be9256dc · 2025-05-07T08:22:21.000+02:00
* fix: add `info` to `ESLint.DeprecatedRuleUse` type

* fix typo
diff --git a/lib/cli-engine/cli-engine.js b/lib/cli-engine/cli-engine.js
@@ -58,12 +58,12 @@ const validFixTypes = new Set(["directive", "problem", "suggestion", "layout"]);
 //------------------------------------------------------------------------------
 
 // For VSCode IntelliSense
-/** @typedef {import("../shared/types").DeprecatedRuleInfo} DeprecatedRuleInfo */
 /** @typedef {import("../shared/types").LintMessage} LintMessage */
 /** @typedef {import("../shared/types").SuppressedLintMessage} SuppressedLintMessage */
 /** @typedef {import("../shared/types").ParserOptions} ParserOptions */
 /** @typedef {import("../shared/types").RuleConf} RuleConf */
 /** @typedef {import("../types").ESLint.ConfigData} ConfigData */
+/** @typedef {import("../types").ESLint.DeprecatedRuleUse} DeprecatedRuleInfo */
 /** @typedef {import("../types").ESLint.FormatterFunction} FormatterFunction */
 /** @typedef {import("../types").ESLint.Plugin} Plugin */
 /** @typedef {import("../types").Rule.RuleModule} Rule */
diff --git a/lib/eslint/eslint.js b/lib/eslint/eslint.js
@@ -57,11 +57,12 @@ 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 { DeprecatedRuleInfo, LintMessage, LintResult, ResultsMeta } from "../shared/types.js";
+ * @import { LintMessage, LintResult, ResultsMeta } from "../shared/types.js";
  */
 
 /** @typedef {ReturnType<ConfigArray.extractConfig>} ExtractedConfig */
 /** @typedef {import("../types").Linter.Config} Config */
+/** @typedef {import("../types").ESLint.DeprecatedRuleUse} DeprecatedRuleInfo */
 /** @typedef {import("../types").ESLint.Plugin} Plugin */
 
 /**
diff --git a/lib/eslint/legacy-eslint.js b/lib/eslint/legacy-eslint.js
@@ -30,12 +30,12 @@ const { version } = require("../../package.json");
 //------------------------------------------------------------------------------
 
 /** @typedef {import("../cli-engine/cli-engine").LintReport} CLIEngineLintReport */
-/** @typedef {import("../shared/types").DeprecatedRuleInfo} DeprecatedRuleInfo */
 /** @typedef {import("../shared/types").LintMessage} LintMessage */
 /** @typedef {import("../shared/types").SuppressedLintMessage} SuppressedLintMessage */
 /** @typedef {import("../shared/types").LintResult} LintResult */
 /** @typedef {import("../shared/types").ResultsMeta} ResultsMeta */
 /** @typedef {import("../types").ESLint.ConfigData} ConfigData */
+/** @typedef {import("../types").ESLint.DeprecatedRuleUse} DeprecatedRuleInfo */
 /** @typedef {import("../types").ESLint.Plugin} Plugin */
 /** @typedef {import("../types").Rule.RuleModule} Rule */
 
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -2057,9 +2057,25 @@ export namespace ESLint {
 		};
 	}
 
+	/**
+	 * Information about deprecated rules.
+	 */
 	interface DeprecatedRuleUse {
+		/**
+		 * The rule ID.
+		 */
 		ruleId: string;
+
+		/**
+		 * The rule IDs that replace this deprecated rule.
+		 */
 		replacedBy: string[];
+
+		/**
+		 * The raw deprecated info provided by the rule.
+		 * Unset if the rule's `meta.deprecated` property is a boolean.
+		 */
+		info?: DeprecatedInfo;
 	}
 
 	interface ResultsMeta {
diff --git a/tests/lib/types/types.test.ts b/tests/lib/types/types.test.ts
@@ -1774,6 +1774,20 @@ for (const result of results) {
 	};
 	delete result.stats;
 
+	const deprecatedRule = result.usedDeprecatedRules[0];
+	deprecatedRule.ruleId = "foo";
+	deprecatedRule.replacedBy = ["bar"];
+	deprecatedRule.info = {
+		message: "use bar instead",
+		replacedBy: [
+			{
+				rule: {
+					name: "bar",
+				},
+			},
+		],
+	};
+
 	for (const message of result.messages) {
 		message.ruleId = "foo";
 	}
