chore: remove shared types (#19718)

fasttime · web-flow · commit cf3635299e09 · 2025-05-12T18:44:47.000+02:00
* chore: remove shared types

* use `SuggestedEdit`
diff --git a/lib/cli-engine/cli-engine.js b/lib/cli-engine/cli-engine.js
@@ -58,15 +58,15 @@ const validFixTypes = new Set(["directive", "problem", "suggestion", "layout"]);
 //------------------------------------------------------------------------------
 
 // For VSCode IntelliSense
-/** @typedef {import("../shared/types").LintMessage} LintMessage */
-/** @typedef {import("../shared/types").SuppressedLintMessage} SuppressedLintMessage */
-/** @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").Linter.LintMessage} LintMessage */
 /** @typedef {import("../types").Linter.ParserOptions} ParserOptions */
 /** @typedef {import("../types").ESLint.Plugin} Plugin */
 /** @typedef {import("../types").Rule.RuleModule} Rule */
+/** @typedef {import("../types").Linter.RuleEntry} RuleConf */
+/** @typedef {import("../types").Linter.SuppressedLintMessage} SuppressedLintMessage */
 /** @typedef {ReturnType<CascadingConfigArrayFactory.getConfigArrayForFile>} ConfigArray */
 /** @typedef {ReturnType<ConfigArray.extractConfig>} ExtractedConfig */
 
diff --git a/lib/cli.js b/lib/cli.js
@@ -40,12 +40,13 @@ const debug = require("debug")("eslint:cli");
 // Types
 //------------------------------------------------------------------------------
 
-/** @typedef {import("./eslint/eslint").ESLintOptions} ESLintOptions */
-/** @typedef {import("./eslint/eslint").LintMessage} LintMessage */
-/** @typedef {import("./eslint/eslint").LintResult} LintResult */
+/** @import { ESLintOptions } from "./eslint/eslint.js" */
+
 /** @typedef {import("./options").ParsedCLIOptions} ParsedCLIOptions */
-/** @typedef {import("./shared/types").ResultsMeta} ResultsMeta */
+/** @typedef {import("./types").Linter.LintMessage} LintMessage */
+/** @typedef {import("./types").ESLint.LintResult} LintResult */
 /** @typedef {import("./types").ESLint.Plugin} Plugin */
+/** @typedef {import("./types").ESLint.ResultsMeta} ResultsMeta */
 
 //------------------------------------------------------------------------------
 // Helpers
diff --git a/lib/eslint/eslint-helpers.js b/lib/eslint/eslint-helpers.js
@@ -30,10 +30,12 @@ const MINIMATCH_OPTIONS = { dot: true };
 
 /**
  * @import { ESLintOptions } from "./eslint.js";
- * @import { LintMessage, LintResult } from "../shared/types.js";
  * @import { ConfigLoader, LegacyConfigLoader } from "../config/config-loader.js";
  */
 
+/** @typedef {import("../types").Linter.LintMessage} LintMessage */
+/** @typedef {import("../types").ESLint.LintResult} LintResult */
+
 /**
  * @typedef {Object} GlobSearch
  * @property {Array<string>} patterns The normalized patterns to use for a search.
diff --git a/lib/eslint/eslint.js b/lib/eslint/eslint.js
@@ -57,13 +57,15 @@ 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 { 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").Linter.LintMessage} LintMessage */
+/** @typedef {import("../types").ESLint.LintResult} LintResult */
 /** @typedef {import("../types").ESLint.Plugin} Plugin */
+/** @typedef {import("../types").ESLint.ResultsMeta} ResultsMeta */
 
 /**
  * The options with which to configure the ESLint instance.
diff --git a/lib/eslint/legacy-eslint.js b/lib/eslint/legacy-eslint.js
@@ -30,14 +30,14 @@ const { version } = require("../../package.json");
 //------------------------------------------------------------------------------
 
 /** @typedef {import("../cli-engine/cli-engine").LintReport} CLIEngineLintReport */
-/** @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").Linter.LintMessage} LintMessage */
+/** @typedef {import("../types").ESLint.LintResult} LintResult */
 /** @typedef {import("../types").ESLint.Plugin} Plugin */
+/** @typedef {import("../types").ESLint.ResultsMeta} ResultsMeta */
 /** @typedef {import("../types").Rule.RuleModule} Rule */
+/** @typedef {import("../types").Linter.SuppressedLintMessage} SuppressedLintMessage */
 
 /**
  * The main formatter object.
diff --git a/lib/linter/apply-disable-directives.js b/lib/linter/apply-disable-directives.js
@@ -9,7 +9,7 @@
 // Typedefs
 //------------------------------------------------------------------------------
 
-/** @typedef {import("../shared/types").LintMessage} LintMessage */
+/** @typedef {import("../types").Linter.LintMessage} LintMessage */
 /** @typedef {import("@eslint/core").Language} Language */
 /** @typedef {import("@eslint/core").Position} Position */
 /** @typedef {import("@eslint/core").RulesConfig} RulesConfig */
diff --git a/lib/linter/linter.js b/lib/linter/linter.js
@@ -75,18 +75,19 @@ const STEP_KIND_CALL = 2;
 
 /** @import { Language, LanguageOptions, RuleConfig, RuleDefinition, RuleSeverity } from "@eslint/core" */
 
-/** @typedef {import("../shared/types").Environment} Environment */
-/** @typedef {import("../shared/types").GlobalConf} GlobalConf */
-/** @typedef {import("../shared/types").LintMessage} LintMessage */
-/** @typedef {import("../shared/types").SuppressedLintMessage} SuppressedLintMessage */
-/** @typedef {import("../shared/types").Processor} Processor */
-/** @typedef {import("../shared/types").Times} Times */
 /** @typedef {import("../types").Linter.Config} Config */
 /** @typedef {import("../types").ESLint.ConfigData} ConfigData */
+/** @typedef {import("../types").ESLint.Environment} Environment */
+/** @typedef {import("../types").Linter.GlobalConf} GlobalConf */
 /** @typedef {import("../types").Linter.LanguageOptions} JSLanguageOptions */
+/** @typedef {import("../types").Linter.LintMessage} LintMessage */
+/** @typedef {import("../types").Linter.Parser} Parser */
 /** @typedef {import("../types").Linter.ParserOptions} ParserOptions */
-/** @typedef {import("../types").Linter.StringSeverity} StringSeverity */
+/** @typedef {import("../types").Linter.Processor} Processor */
 /** @typedef {import("../types").Rule.RuleModule} Rule */
+/** @typedef {import("../types").Linter.StringSeverity} StringSeverity */
+/** @typedef {import("../types").Linter.SuppressedLintMessage} SuppressedLintMessage */
+/** @typedef {import("../types").Linter.TimePass} TimePass */
 
 /* eslint-disable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
 /**
@@ -111,7 +112,7 @@ const STEP_KIND_CALL = 2;
  * @property {SourceCode|null} lastSourceCode The `SourceCode` instance that the last `verify()` call used.
  * @property {SuppressedLintMessage[]} lastSuppressedMessages The `SuppressedLintMessage[]` instance that the last `verify()` call produced.
  * @property {Map<string, Parser>} parserMap The loaded parsers.
- * @property {Times} times The times spent on applying a rule to a file (see `stats` option).
+ * @property {{ passes: TimePass[]; }} times The times spent on applying a rule to a file (see `stats` option).
  * @property {Rules} ruleMap The loaded rules.
  */
 
@@ -2618,7 +2619,7 @@ class Linter {
 
 	/**
 	 * Gets the times spent on (parsing, fixing, linting) a file.
-	 * @returns {LintTimes} The times.
+	 * @returns {{ passes: TimePass[]; }} The times.
 	 */
 	getTimes() {
 		return internalSlotsMap.get(this).times ?? { passes: [] };
diff --git a/lib/linter/report-translator.js b/lib/linter/report-translator.js
@@ -17,7 +17,8 @@ const { interpolate } = require("./interpolate");
 // Typedefs
 //------------------------------------------------------------------------------
 
-/** @typedef {import("../shared/types").LintMessage} LintMessage */
+/** @typedef {import("../types").Linter.LintMessage} LintMessage */
+/** @typedef {import("../types").Linter.LintSuggestion} SuggestionResult */
 
 /**
  * An error message description
diff --git a/lib/rule-tester/rule-tester.js b/lib/rule-tester/rule-tester.js
@@ -41,7 +41,7 @@ const { SourceCode } = require("../languages/js/source-code");
 
 /** @import { LanguageOptions, RuleDefinition } from "@eslint/core" */
 
-/** @typedef {import("../shared/types").Parser} Parser */
+/** @typedef {import("../types").Linter.Parser} Parser */
 
 /**
  * A test case that is expected to pass lint.
diff --git a/lib/rules/prefer-named-capture-group.js b/lib/rules/prefer-named-capture-group.js
@@ -17,6 +17,12 @@ const {
 } = require("@eslint-community/eslint-utils");
 const regexpp = require("@eslint-community/regexpp");
 
+//------------------------------------------------------------------------------
+// Typedefs
+//------------------------------------------------------------------------------
+
+/** @import { SuggestedEdit } from "@eslint/core"; */
+
 //------------------------------------------------------------------------------
 // Helpers
 //------------------------------------------------------------------------------
@@ -29,7 +35,7 @@ const parser = new regexpp.RegExpParser();
  * @param {string} pattern The regular expression pattern to be checked.
  * @param {string} rawText Source text of the regexNode.
  * @param {ASTNode} regexNode AST node which contains the regular expression.
- * @returns {Array<SuggestionResult>} Fixer suggestions for the regex, if statically determinable.
+ * @returns {Array<SuggestedEdit>} Fixer suggestions for the regex, if statically determinable.
  */
 function suggestIfPossible(groupStart, pattern, rawText, regexNode) {
 	switch (regexNode.type) {
diff --git a/lib/services/processor-service.js b/lib/services/processor-service.js
@@ -17,7 +17,7 @@ const { VFile } = require("../linter/vfile.js");
 // Types
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("../shared/types.js").LintMessage} LintMessage */
+/** @typedef {import("../types").Linter.LintMessage} LintMessage */
 /** @typedef {import("../linter/vfile.js").VFile} VFile */
 /** @typedef {import("@eslint/core").Language} Language */
 /** @typedef {import("eslint").Linter.Processor} Processor */
diff --git a/lib/services/suppressions-service.js b/lib/services/suppressions-service.js
@@ -19,8 +19,9 @@ const stringify = require("json-stable-stringify-without-jsonify");
 //------------------------------------------------------------------------------
 
 // For VSCode IntelliSense
-/** @typedef {import("../shared/types").LintResult} LintResult */
-/** @typedef {import("../shared/types").SuppressedViolations} SuppressedViolations */
+/** @typedef {import("../types").Linter.LintMessage} LintMessage */
+/** @typedef {import("../types").ESLint.LintResult} LintResult */
+/** @typedef {Record<string, Record<string, { count: number; }>>} SuppressedViolations */
 
 //-----------------------------------------------------------------------------
 // Exports
diff --git a/lib/shared/types.js b/lib/shared/types.js
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
diff --git a/tests/fixtures/processors/pattern-processor.js b/tests/fixtures/processors/pattern-processor.js
diff --git a/tools/check-rule-examples.js b/tools/check-rule-examples.js
diff --git a/tools/code-sample-minimizer.js b/tools/code-sample-minimizer.js
diff --git a/tools/eslint-fuzzer.js b/tools/eslint-fuzzer.js
