From 84abbfc9c407f1e529a3124f34b62b7940885f09 Mon Sep 17 00:00:00 2001
From: Brad Zacher <brad.zacher@gmail.com>
Date: Sat, 6 Apr 2024 14:23:59 +1030
Subject: [PATCH] add types for both flat and legacy eslint classes

---
 packages/utils/src/ts-eslint/ESLint.ts        | 393 +----------------
 .../src/ts-eslint/eslint/ESLintShared.ts      | 408 ++++++++++++++++++
 .../utils/src/ts-eslint/eslint/FlatESLint.ts  |  91 ++++
 .../src/ts-eslint/eslint/LegacyESLint.ts      |  79 ++++
 packages/utils/tests/ts-eslint/ESLint.test.ts |  30 ++
 packages/utils/typings/eslint.d.ts            |  10 +-
 6 files changed, 622 insertions(+), 389 deletions(-)
 create mode 100644 packages/utils/src/ts-eslint/eslint/ESLintShared.ts
 create mode 100644 packages/utils/src/ts-eslint/eslint/FlatESLint.ts
 create mode 100644 packages/utils/src/ts-eslint/eslint/LegacyESLint.ts
 create mode 100644 packages/utils/tests/ts-eslint/ESLint.test.ts

diff --git a/packages/utils/src/ts-eslint/ESLint.ts b/packages/utils/src/ts-eslint/ESLint.ts
index b3e829e1ce10..30ebb0ea5a6d 100644
--- a/packages/utils/src/ts-eslint/ESLint.ts
+++ b/packages/utils/src/ts-eslint/ESLint.ts
@@ -1,390 +1,11 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 
-import { ESLint as ESLintESLint } from 'eslint';
-
-import type { ClassicConfig } from './Config';
-import type { Linter } from './Linter';
-
-declare class ESLintBase {
-  /**
-   * Creates a new instance of the main ESLint API.
-   * @param options The options for this instance.
-   */
-  constructor(options?: ESLint.ESLintOptions);
-
-  /**
-   * This method calculates the configuration for a given file, which can be useful for debugging purposes.
-   * - It resolves and merges extends and overrides settings into the top level configuration.
-   * - It resolves the parser setting to absolute paths.
-   * - It normalizes the plugins setting to align short names. (e.g., eslint-plugin-foo → foo)
-   * - It adds the processor setting if a legacy file extension processor is matched.
-   * - It doesn't interpret the env setting to the globals and parserOptions settings, so the result object contains
-   *   the env setting as is.
-   * @param filePath The path to the file whose configuration you would like to calculate. Directory paths are forbidden
-   *                 because ESLint cannot handle the overrides setting.
-   * @returns The promise that will be fulfilled with a configuration object.
-   */
-  calculateConfigForFile(filePath: string): Promise<Linter.ConfigType>;
-  /**
-   * This method checks if a given file is ignored by your configuration.
-   * @param filePath The path to the file you want to check.
-   * @returns The promise that will be fulfilled with whether the file is ignored or not. If the file is ignored, then
-   *          it will return true.
-   */
-  isPathIgnored(filePath: string): Promise<boolean>;
-  /**
-   * This method lints the files that match the glob patterns and then returns the results.
-   * @param patterns The lint target files. This can contain any of file paths, directory paths, and glob patterns.
-   * @returns The promise that will be fulfilled with an array of LintResult objects.
-   */
-  lintFiles(patterns: string[] | string): Promise<ESLint.LintResult[]>;
-  /**
-   * This method lints the given source code text and then returns the results.
-   *
-   * By default, this method uses the configuration that applies to files in the current working directory (the cwd
-   * constructor option). If you want to use a different configuration, pass options.filePath, and ESLint will load the
-   * same configuration that eslint.lintFiles() would use for a file at options.filePath.
-   *
-   * If the options.filePath value is configured to be ignored, this method returns an empty array. If the
-   * options.warnIgnored option is set along with the options.filePath option, this method returns a LintResult object.
-   * In that case, the result may contain a warning that indicates the file was ignored.
-   * @param code The source code text to check.
-   * @returns The promise that will be fulfilled with an array of LintResult objects. This is an array (despite there
-   *          being only one lint result) in order to keep the interfaces between this and the eslint.lintFiles()
-   *          method similar.
-   */
-  lintText(
-    code: string,
-    options?: ESLint.LintTextOptions,
-  ): Promise<ESLint.LintResult[]>;
-  /**
-   * This method loads a formatter. Formatters convert lint results to a human- or machine-readable string.
-   * @param name TThe path to the file you want to check.
-   * The following values are allowed:
-   * - undefined. In this case, loads the "stylish" built-in formatter.
-   * - A name of built-in formatters.
-   * - A name of third-party formatters. For examples:
-   * -- `foo` will load eslint-formatter-foo.
-   * -- `@foo` will load `@foo/eslint-formatter`.
-   * -- `@foo/bar` will load `@foo/eslint-formatter-bar`.
-   * - A path to the file that defines a formatter. The path must contain one or more path separators (/) in order to distinguish if it's a path or not. For example, start with ./.
-   * @returns The promise that will be fulfilled with a Formatter object.
-   */
-  loadFormatter(name?: string): Promise<ESLint.Formatter>;
-
-  ////////////////////
-  // static members //
-  ////////////////////
-
-  /**
-   * This method copies the given results and removes warnings. The returned value contains only errors.
-   * @param results The LintResult objects to filter.
-   * @returns The filtered LintResult objects.
-   */
-  static getErrorResults(results: ESLint.LintResult): ESLint.LintResult;
-  /**
-   * This method writes code modified by ESLint's autofix feature into its respective file. If any of the modified
-   * files don't exist, this method does nothing.
-   * @param results The LintResult objects to write.
-   * @returns The promise that will be fulfilled after all files are written.
-   */
-  static outputFixes(results: ESLint.LintResult[]): Promise<void>;
+export {
+  // TODO - remove this in the next major
   /**
-   * The version text.
+   * @deprecated - use FlatESLint or LegacyESLint instead
    */
-  static readonly version: string;
-}
-
-namespace ESLint {
-  export interface ESLintOptions {
-    /**
-     * If false is present, ESLint suppresses directive comments in source code.
-     * If this option is false, it overrides the noInlineConfig setting in your configurations.
-     */
-    allowInlineConfig?: boolean;
-    /**
-     * Configuration object, extended by all configurations used with this instance.
-     * You can use this option to define the default settings that will be used if your configuration files don't
-     * configure it.
-     */
-    baseConfig?: Linter.ConfigType | null;
-    /**
-     * If true is present, the eslint.lintFiles() method caches lint results and uses it if each target file is not
-     * changed. Please mind that ESLint doesn't clear the cache when you upgrade ESLint plugins. In that case, you have
-     * to remove the cache file manually. The eslint.lintText() method doesn't use caches even if you pass the
-     * options.filePath to the method.
-     */
-    cache?: boolean;
-    /**
-     * The eslint.lintFiles() method writes caches into this file.
-     */
-    cacheLocation?: string;
-    /**
-     * The working directory. This must be an absolute path.
-     */
-    cwd?: string;
-    /**
-     * Unless set to false, the eslint.lintFiles() method will throw an error when no target files are found.
-     */
-    errorOnUnmatchedPattern?: boolean;
-    /**
-     * If you pass directory paths to the eslint.lintFiles() method, ESLint checks the files in those directories that
-     * have the given extensions. For example, when passing the src/ directory and extensions is [".js", ".ts"], ESLint
-     * will lint *.js and *.ts files in src/. If extensions is null, ESLint checks *.js files and files that match
-     * overrides[].files patterns in your configuration.
-     * Note: This option only applies when you pass directory paths to the eslint.lintFiles() method.
-     * If you pass glob patterns, ESLint will lint all files matching the glob pattern regardless of extension.
-     */
-    extensions?: string[] | null;
-    /**
-     * If true is present, the eslint.lintFiles() and eslint.lintText() methods work in autofix mode.
-     * If a predicate function is present, the methods pass each lint message to the function, then use only the
-     * lint messages for which the function returned true.
-     */
-    fix?: boolean | ((message: ESLint.LintMessage) => boolean);
-    /**
-     * The types of the rules that the eslint.lintFiles() and eslint.lintText() methods use for autofix.
-     */
-    fixTypes?: ('directive' | 'layout' | 'problem' | 'suggestion')[] | null;
-    /**
-     * If false is present, the eslint.lintFiles() method doesn't interpret glob patterns.
-     */
-    globInputPaths?: boolean;
-    /**
-     * If false is present, the eslint.lintFiles() method doesn't respect `.eslintignore` files or ignorePatterns in
-     * your configuration.
-     */
-    ignore?: boolean;
-    /**
-     * The path to a file ESLint uses instead of `$CWD/.eslintignore`.
-     * If a path is present and the file doesn't exist, this constructor will throw an error.
-     */
-    ignorePath?: string;
-    /**
-     * Configuration object, overrides all configurations used with this instance.
-     * You can use this option to define the settings that will be used even if your configuration files configure it.
-     */
-    overrideConfig?: ClassicConfig.ConfigOverride | null;
-    /**
-     * The path to a configuration file, overrides all configurations used with this instance.
-     * The options.overrideConfig option is applied after this option is applied.
-     */
-    overrideConfigFile?: string | null;
-    /**
-     * The plugin implementations that ESLint uses for the plugins setting of your configuration.
-     * This is a map-like object. Those keys are plugin IDs and each value is implementation.
-     */
-    plugins?: Record<string, Linter.Plugin> | null;
-    /**
-     * The severity to report unused eslint-disable directives.
-     * If this option is a severity, it overrides the reportUnusedDisableDirectives setting in your configurations.
-     */
-    reportUnusedDisableDirectives?: Linter.SeverityString | null;
-    /**
-     * The path to a directory where plugins should be resolved from.
-     * If null is present, ESLint loads plugins from the location of the configuration file that contains the plugin
-     * setting.
-     * If a path is present, ESLint loads all plugins from there.
-     */
-    resolvePluginsRelativeTo?: string | null;
-    /**
-     * An array of paths to directories to load custom rules from.
-     */
-    rulePaths?: string[];
-    /**
-     * If false is present, ESLint doesn't load configuration files (.eslintrc.* files).
-     * Only the configuration of the constructor options is valid.
-     */
-    useEslintrc?: boolean;
-  }
-
-  export interface DeprecatedRuleInfo {
-    /**
-     *  The rule ID.
-     */
-    ruleId: string;
-    /**
-     *  The rule IDs that replace this deprecated rule.
-     */
-    replacedBy: string[];
-  }
-
-  /**
-   * The LintResult value is the information of the linting result of each file.
-   */
-  export interface LintResult {
-    /**
-     * The number of errors. This includes fixable errors.
-     */
-    errorCount: number;
-    /**
-     * The number of fatal errors.
-     */
-    fatalErrorCount: number;
-    /**
-     * The absolute path to the file of this result. This is the string "<text>" if the file path is unknown (when you
-     * didn't pass the options.filePath option to the eslint.lintText() method).
-     */
-    filePath: string;
-    /**
-     * The number of errors that can be fixed automatically by the fix constructor option.
-     */
-    fixableErrorCount: number;
-    /**
-     * The number of warnings that can be fixed automatically by the fix constructor option.
-     */
-    fixableWarningCount: number;
-    /**
-     * The array of LintMessage objects.
-     */
-    messages: ESLint.LintMessage[];
-    /**
-     * The source code of the file that was linted, with as many fixes applied as possible.
-     */
-    output?: string;
-    /**
-     * The original source code text. This property is undefined if any messages didn't exist or the output
-     * property exists.
-     */
-    source?: string;
-    /**
-     * The array of SuppressedLintMessage objects.
-     */
-    suppressedMessages: SuppressedLintMessage[];
-    /**
-     * The information about the deprecated rules that were used to check this file.
-     */
-    usedDeprecatedRules: DeprecatedRuleInfo[];
-    /**
-     * The number of warnings. This includes fixable warnings.
-     */
-    warningCount: number;
-  }
-
-  export interface LintTextOptions {
-    /**
-     * The path to the file of the source code text. If omitted, the result.filePath becomes the string "<text>".
-     */
-    filePath?: string;
-    /**
-     * If true is present and the options.filePath is a file ESLint should ignore, this method returns a lint result
-     * contains a warning message.
-     */
-    warnIgnored?: boolean;
-  }
-
-  /**
-   * The LintMessage value is the information of each linting error.
-   */
-  export interface LintMessage {
-    /**
-     * The 1-based column number of the begin point of this message.
-     */
-    column: number | undefined;
-    /**
-     * The 1-based column number of the end point of this message. This property is undefined if this message
-     * is not a range.
-     */
-    endColumn: number | undefined;
-    /**
-     * The 1-based line number of the end point of this message. This property is undefined if this
-     * message is not a range.
-     */
-    endLine: number | undefined;
-    /**
-     * `true` if this is a fatal error unrelated to a rule, like a parsing error.
-     */
-    fatal?: boolean | undefined;
-    /**
-     * The EditInfo object of autofix. This property is undefined if this message is not fixable.
-     */
-    fix: EditInfo | undefined;
-    /**
-     * The 1-based line number of the begin point of this message.
-     */
-    line: number | undefined;
-    /**
-     * The error message
-     */
-    message: string;
-    /**
-     * The rule name that generates this lint message. If this message is generated by the ESLint core rather than
-     * rules, this is null.
-     */
-    ruleId: string | null;
-    /**
-     * The severity of this message. 1 means warning and 2 means error.
-     */
-    severity: 1 | 2;
-    /**
-     * The list of suggestions. Each suggestion is the pair of a description and an EditInfo object to fix code. API
-     * users such as editor integrations can choose one of them to fix the problem of this message. This property is
-     * undefined if this message doesn't have any suggestions.
-     */
-    suggestions:
-      | {
-          desc: string;
-          fix: EditInfo;
-        }[]
-      | undefined;
-  }
-
-  /**
-   * The SuppressedLintMessage value is the information of each suppressed linting error.
-   */
-  export interface SuppressedLintMessage extends ESLint.LintMessage {
-    /**
-     * The list of suppressions.
-     */
-    suppressions?: {
-      /**
-       * Right now, this is always `directive`
-       */
-      kind: string;
-      /**
-       * The free text description added after the `--` in the comment
-       */
-      justification: string;
-    }[];
-  }
-
-  /**
-   * The EditInfo value is information to edit text.
-   *
-   * This edit information means replacing the range of the range property by the text property value. It's like
-   * sourceCodeText.slice(0, edit.range[0]) + edit.text + sourceCodeText.slice(edit.range[1]). Therefore, it's an add
-   * if the range[0] and range[1] property values are the same value, and it's removal if the text property value is
-   * empty string.
-   */
-  export interface EditInfo {
-    /**
-     * The pair of 0-based indices in source code text to remove.
-     */
-    range: [number, number];
-    /**
-     * The text to add.
-     */
-    text: string;
-  }
-
-  /**
-   * The Formatter value is the object to convert the LintResult objects to text.
-   */
-  export interface Formatter {
-    /**
-     * The method to convert the LintResult objects to text.
-     * Promise return supported since 8.4.0
-     */
-    format(results: LintResult[]): Promise<string> | string;
-  }
-}
-
-/**
- * The ESLint class is the primary class to use in Node.js applications.
- * This class depends on the Node.js fs module and the file system, so you cannot use it in browsers.
- *
- * If you want to lint code on browsers, use the Linter class instead.
- */
-class ESLint extends (ESLintESLint as typeof ESLintBase) {}
-
-export { ESLint };
+  LegacyESLint as ESLint,
+} from './eslint/LegacyESLint';
+export { FlatESLint } from './eslint/FlatESLint';
+export { LegacyESLint } from './eslint/LegacyESLint';
diff --git a/packages/utils/src/ts-eslint/eslint/ESLintShared.ts b/packages/utils/src/ts-eslint/eslint/ESLintShared.ts
new file mode 100644
index 000000000000..c66f62c8dc9e
--- /dev/null
+++ b/packages/utils/src/ts-eslint/eslint/ESLintShared.ts
@@ -0,0 +1,408 @@
+import type { Linter } from '../Linter';
+import type { RuleMetaData } from '../Rule';
+
+export declare class ESLintBase<
+  Config extends Linter.ConfigType,
+  Options extends ESLintOptions<Config>,
+> {
+  /**
+   * Creates a new instance of the main ESLint API.
+   * @param options The options for this instance.
+   */
+  constructor(options?: Options);
+
+  /**
+   * This method calculates the configuration for a given file, which can be useful for debugging purposes.
+   * - It resolves and merges extends and overrides settings into the top level configuration.
+   * - It resolves the parser setting to absolute paths.
+   * - It normalizes the plugins setting to align short names. (e.g., eslint-plugin-foo → foo)
+   * - It adds the processor setting if a legacy file extension processor is matched.
+   * - It doesn't interpret the env setting to the globals and parserOptions settings, so the result object contains
+   *   the env setting as is.
+   * @param filePath The path to the file whose configuration you would like to calculate. Directory paths are forbidden
+   *                 because ESLint cannot handle the overrides setting.
+   * @returns The promise that will be fulfilled with a configuration object.
+   */
+  calculateConfigForFile(filePath: string): Promise<Config>;
+
+  getRulesMetaForResults(
+    results: LintResult[],
+  ): Record<string, RuleMetaData<string, readonly unknown[]>>;
+
+  /**
+   * This method checks if a given file is ignored by your configuration.
+   * @param filePath The path to the file you want to check.
+   * @returns The promise that will be fulfilled with whether the file is ignored or not. If the file is ignored, then
+   *          it will return true.
+   */
+  isPathIgnored(filePath: string): Promise<boolean>;
+
+  /**
+   * This method lints the files that match the glob patterns and then returns the results.
+   * @param patterns The lint target files. This can contain any of file paths, directory paths, and glob patterns.
+   * @returns The promise that will be fulfilled with an array of LintResult objects.
+   */
+  lintFiles(patterns: string[] | string): Promise<LintResult[]>;
+
+  /**
+   * This method lints the given source code text and then returns the results.
+   *
+   * By default, this method uses the configuration that applies to files in the current working directory (the cwd
+   * constructor option). If you want to use a different configuration, pass options.filePath, and ESLint will load the
+   * same configuration that eslint.lintFiles() would use for a file at options.filePath.
+   *
+   * If the options.filePath value is configured to be ignored, this method returns an empty array. If the
+   * options.warnIgnored option is set along with the options.filePath option, this method returns a LintResult object.
+   * In that case, the result may contain a warning that indicates the file was ignored.
+   * @param code The source code text to check.
+   * @returns The promise that will be fulfilled with an array of LintResult objects. This is an array (despite there
+   *          being only one lint result) in order to keep the interfaces between this and the eslint.lintFiles()
+   *          method similar.
+   */
+  lintText(code: string, options?: LintTextOptions): Promise<LintResult[]>;
+
+  /**
+   * This method loads a formatter. Formatters convert lint results to a human- or machine-readable string.
+   * @param name TThe path to the file you want to check.
+   * The following values are allowed:
+   * - undefined. In this case, loads the "stylish" built-in formatter.
+   * - A name of built-in formatters.
+   * - A name of third-party formatters. For examples:
+   * -- `foo` will load eslint-formatter-foo.
+   * -- `@foo` will load `@foo/eslint-formatter`.
+   * -- `@foo/bar` will load `@foo/eslint-formatter-bar`.
+   * - A path to the file that defines a formatter. The path must contain one or more path separators (/) in order to distinguish if it's a path or not. For example, start with ./.
+   * @returns The promise that will be fulfilled with a Formatter object.
+   */
+  loadFormatter(name?: string): Promise<Formatter>;
+
+  ////////////////////
+  // static members //
+  ////////////////////
+
+  /**
+   * This method copies the given results and removes warnings. The returned value contains only errors.
+   * @param results The LintResult objects to filter.
+   * @returns The filtered LintResult objects.
+   */
+  static getErrorResults(results: LintResult): LintResult;
+  /**
+   * This method writes code modified by ESLint's autofix feature into its respective file. If any of the modified
+   * files don't exist, this method does nothing.
+   * @param results The LintResult objects to write.
+   * @returns The promise that will be fulfilled after all files are written.
+   */
+  static outputFixes(results: LintResult[]): Promise<void>;
+  /**
+   * The version text.
+   */
+  static readonly version: string;
+  /**
+   * The type of configuration used by this class.
+   */
+  static readonly configType: 'eslintrc' | 'flat';
+}
+export interface ESLintOptions<Config extends Linter.ConfigType> {
+  /**
+   * If false is present, ESLint suppresses directive comments in source code.
+   * If this option is false, it overrides the noInlineConfig setting in your configurations.
+   * @default true
+   */
+  allowInlineConfig?: boolean;
+  /**
+   * Configuration object, extended by all configurations used with this instance.
+   * You can use this option to define the default settings that will be used if your configuration files don't
+   * configure it.
+   * @default null
+   */
+  baseConfig?: Config | null;
+  /**
+   * If `true` is present, the `eslint.lintFiles()` method caches lint results and uses it if each target file is not
+   * changed. Please mind that ESLint doesn't clear the cache when you upgrade ESLint plugins. In that case, you have
+   * to remove the cache file manually. The `eslint.lintText()` method doesn't use caches even if you pass the
+   * options.filePath to the method.
+   * @default false
+   */
+  cache?: boolean;
+  /**
+   * The eslint.lintFiles() method writes caches into this file.
+   * @default '.eslintcache'
+   */
+  cacheLocation?: string;
+  /**
+   * Strategy for the cache to use for detecting changed files.
+   * @default 'metadata'
+   */
+  cacheStrategy?: 'metadata' | 'content';
+  /**
+   * The working directory. This must be an absolute path.
+   * @default process.cwd()
+   */
+  cwd?: string;
+  /**
+   * Unless set to false, the `eslint.lintFiles()` method will throw an error when no target files are found.
+   * @default true
+   */
+  errorOnUnmatchedPattern?: boolean;
+  /**
+   * If `true` is present, the `eslint.lintFiles()` and `eslint.lintText()` methods work in autofix mode.
+   * If a predicate function is present, the methods pass each lint message to the function, then use only the
+   * lint messages for which the function returned true.
+   * @default false
+   */
+  fix?: boolean | ((message: LintMessage) => boolean);
+  /**
+   * The types of the rules that the `eslint.lintFiles()` and `eslint.lintText()` methods use for autofix.
+   * @default null
+   */
+  fixTypes?: ('directive' | 'layout' | 'problem' | 'suggestion')[] | null;
+  /**
+   * If false is present, the `eslint.lintFiles()` method doesn't interpret glob patterns.
+   * @default true
+   */
+  globInputPaths?: boolean;
+  /**
+   * Configuration object, overrides all configurations used with this instance.
+   * You can use this option to define the settings that will be used even if your configuration files configure it.
+   * @default null
+   */
+  overrideConfig?: Config | null;
+  /**
+   * When set to true, missing patterns cause the linting operation to short circuit and not report any failures.
+   * @default false
+   */
+  passOnNoPatterns?: boolean;
+  /**
+   * The plugin implementations that ESLint uses for the plugins setting of your configuration.
+   * This is a map-like object. Those keys are plugin IDs and each value is implementation.
+   * @default null
+   */
+  plugins?: Record<string, Linter.Plugin> | null;
+}
+
+export interface DeprecatedRuleInfo {
+  /**
+   *  The rule ID.
+   */
+  ruleId: string;
+  /**
+   *  The rule IDs that replace this deprecated rule.
+   */
+  replacedBy: string[];
+}
+
+/**
+ * The LintResult value is the information of the linting result of each file.
+ */
+export interface LintResult {
+  /**
+   * The number of errors. This includes fixable errors.
+   */
+  errorCount: number;
+  /**
+   * The number of fatal errors.
+   */
+  fatalErrorCount: number;
+  /**
+   * The absolute path to the file of this result. This is the string "<text>" if the file path is unknown (when you
+   * didn't pass the options.filePath option to the eslint.lintText() method).
+   */
+  filePath: string;
+  /**
+   * The number of errors that can be fixed automatically by the fix constructor option.
+   */
+  fixableErrorCount: number;
+  /**
+   * The number of warnings that can be fixed automatically by the fix constructor option.
+   */
+  fixableWarningCount: number;
+  /**
+   * The array of LintMessage objects.
+   */
+  messages: LintMessage[];
+  /**
+   * The source code of the file that was linted, with as many fixes applied as possible.
+   */
+  output?: string;
+  /**
+   * The original source code text. This property is undefined if any messages didn't exist or the output
+   * property exists.
+   */
+  source?: string;
+  /**
+   * The array of SuppressedLintMessage objects.
+   */
+  suppressedMessages: SuppressedLintMessage[];
+  /**
+   * The information about the deprecated rules that were used to check this file.
+   */
+  usedDeprecatedRules: DeprecatedRuleInfo[];
+  /**
+   * The number of warnings. This includes fixable warnings.
+   */
+  warningCount: number;
+  /**
+   * Timing information of the lint run.
+   * This exists if and only if the `--stats` CLI flag was added or the `stats: true`
+   * option was passed to the ESLint class
+   * @since 9.0.0
+   */
+  stats?: LintStats;
+}
+
+export interface LintStats {
+  /**
+   * The number of times ESLint has applied at least one fix after linting.
+   */
+  fixPasses: number;
+  /**
+   * The times spent on (parsing, fixing, linting) a file, where the linting refers to the timing information for each rule.
+   */
+  times: {
+    passes: LintStatsTimePass[];
+  };
+}
+export interface LintStatsTimePass {
+  /**
+   * The total time that is spent when parsing a file.
+   */
+  parse: LintStatsParseTime;
+  /**
+   * The total time that is spent on a rule.
+   */
+  rules?: Record<string, LintStatsRuleTime>;
+  /**
+   * The total time that is spent on applying fixes to the code.
+   */
+  fix: LintStatsFixTime;
+  /**
+   * The cumulative total
+   */
+  total: number;
+}
+export interface LintStatsParseTime {
+  total: number;
+}
+export interface LintStatsRuleTime {
+  total: number;
+}
+export interface LintStatsFixTime {
+  total: number;
+}
+
+export interface LintTextOptions {
+  /**
+   * The path to the file of the source code text. If omitted, the result.filePath becomes the string "<text>".
+   */
+  filePath?: string;
+  /**
+   * If true is present and the options.filePath is a file ESLint should ignore, this method returns a lint result
+   * contains a warning message.
+   */
+  warnIgnored?: boolean;
+}
+
+/**
+ * The LintMessage value is the information of each linting error.
+ */
+export interface LintMessage {
+  /**
+   * The 1-based column number of the begin point of this message.
+   */
+  column: number | undefined;
+  /**
+   * The 1-based column number of the end point of this message. This property is undefined if this message
+   * is not a range.
+   */
+  endColumn: number | undefined;
+  /**
+   * The 1-based line number of the end point of this message. This property is undefined if this
+   * message is not a range.
+   */
+  endLine: number | undefined;
+  /**
+   * `true` if this is a fatal error unrelated to a rule, like a parsing error.
+   */
+  fatal?: boolean | undefined;
+  /**
+   * The EditInfo object of autofix. This property is undefined if this message is not fixable.
+   */
+  fix: EditInfo | undefined;
+  /**
+   * The 1-based line number of the begin point of this message.
+   */
+  line: number | undefined;
+  /**
+   * The error message
+   */
+  message: string;
+  /**
+   * The rule name that generates this lint message. If this message is generated by the ESLint core rather than
+   * rules, this is null.
+   */
+  ruleId: string | null;
+  /**
+   * The severity of this message. 1 means warning and 2 means error.
+   */
+  severity: 1 | 2;
+  /**
+   * The list of suggestions. Each suggestion is the pair of a description and an EditInfo object to fix code. API
+   * users such as editor integrations can choose one of them to fix the problem of this message. This property is
+   * undefined if this message doesn't have any suggestions.
+   */
+  suggestions:
+    | {
+        desc: string;
+        fix: EditInfo;
+      }[]
+    | undefined;
+}
+
+/**
+ * The SuppressedLintMessage value is the information of each suppressed linting error.
+ */
+export interface SuppressedLintMessage extends LintMessage {
+  /**
+   * The list of suppressions.
+   */
+  suppressions?: {
+    /**
+     * Right now, this is always `directive`
+     */
+    kind: string;
+    /**
+     * The free text description added after the `--` in the comment
+     */
+    justification: string;
+  }[];
+}
+
+/**
+ * The EditInfo value is information to edit text.
+ *
+ * This edit information means replacing the range of the range property by the text property value. It's like
+ * sourceCodeText.slice(0, edit.range[0]) + edit.text + sourceCodeText.slice(edit.range[1]). Therefore, it's an add
+ * if the range[0] and range[1] property values are the same value, and it's removal if the text property value is
+ * empty string.
+ */
+export interface EditInfo {
+  /**
+   * The pair of 0-based indices in source code text to remove.
+   */
+  range: [number, number];
+  /**
+   * The text to add.
+   */
+  text: string;
+}
+
+/**
+ * The Formatter value is the object to convert the LintResult objects to text.
+ */
+export interface Formatter {
+  /**
+   * The method to convert the LintResult objects to text.
+   * Promise return supported since 8.4.0
+   */
+  format(results: LintResult[]): Promise<string> | string;
+}
diff --git a/packages/utils/src/ts-eslint/eslint/FlatESLint.ts b/packages/utils/src/ts-eslint/eslint/FlatESLint.ts
new file mode 100644
index 000000000000..2784384d057b
--- /dev/null
+++ b/packages/utils/src/ts-eslint/eslint/FlatESLint.ts
@@ -0,0 +1,91 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+import { FlatESLint as ESLintFlatESLint } from 'eslint/use-at-your-own-risk';
+
+import type { FlatConfig } from '../Config';
+import type * as Shared from './ESLintShared';
+
+declare class FlatESLintBase extends Shared.ESLintBase<
+  FlatConfig.ConfigArray,
+  FlatESLint.ESLintOptions
+> {
+  static readonly configType: 'flat';
+
+  /**
+   * Returns a configuration object for the given file based on the CLI options.
+   * This is the same logic used by the ESLint CLI executable to determine
+   * configuration for each file it processes.
+   * @param filePath The path of the file to retrieve a config object for.
+   * @returns A configuration object for the file or `undefined` if there is no configuration data for the object.
+   */
+  calculateConfigForFile(filePath: string): Promise<FlatConfig.ConfigArray>;
+
+  /**
+   * Finds the config file being used by this instance based on the options
+   * passed to the constructor.
+   * @returns The path to the config file being used or `undefined` if no config file is being used.
+   */
+  findConfigFile(): Promise<string | undefined>;
+}
+
+/**
+ * The ESLint class is the primary class to use in Node.js applications.
+ * This class depends on the Node.js fs module and the file system, so you cannot use it in browsers.
+ *
+ * If you want to lint code on browsers, use the Linter class instead.
+ */
+export class FlatESLint extends (ESLintFlatESLint as typeof FlatESLintBase) {}
+export namespace FlatESLint {
+  export interface ESLintOptions
+    extends Shared.ESLintOptions<FlatConfig.ConfigArray> {
+    /**
+     * If false is present, the eslint.lintFiles() method doesn't respect `ignorePatterns` ignorePatterns in your configuration.
+     * @default true
+     */
+    ignore?: boolean;
+    /**
+     * Ignore file patterns to use in addition to config ignores. These patterns are relative to cwd.
+     * @default null
+     */
+    ignorePatterns?: string[] | null;
+    /**
+     * The path to a configuration file, overrides all configurations used with this instance.
+     * The options.overrideConfig option is applied after this option is applied.
+     * Searches for default config file when falsy; doesn't do any config file lookup when `true`; considered to be a config filename when a string.
+     * @default false
+     */
+    overrideConfigFile?: string | boolean;
+    /**
+     * A predicate function that filters rules to be run.
+     * This function is called with an object containing `ruleId` and `severity`, and returns `true` if the rule should be run.
+     * @default () => true
+     */
+    ruleFilter?: RuleFilter;
+    /**
+     * When set to true, additional statistics are added to the lint results.
+     * @see {@link https://eslint.org/docs/latest/extend/stats}
+     * @default false
+     */
+    stats?: boolean;
+    /**
+     * Show warnings when the file list includes ignored files.
+     * @default true
+     */
+    warnIgnored?: boolean;
+  }
+  export type DeprecatedRuleInfo = Shared.DeprecatedRuleInfo;
+  export type EditInfo = Shared.EditInfo;
+  export type Formatter = Shared.Formatter;
+  export type LintMessage = Shared.LintMessage;
+  export type LintResult = Shared.LintResult;
+  export type LintStats = Shared.LintStats;
+  export type LintStatsFixTime = Shared.LintStatsFixTime;
+  export type LintStatsParseTime = Shared.LintStatsParseTime;
+  export type LintStatsRuleTime = Shared.LintStatsRuleTime;
+  export type LintStatsTimePass = Shared.LintStatsTimePass;
+  export type LintTextOptions = Shared.LintTextOptions;
+  export type SuppressedLintMessage = Shared.SuppressedLintMessage;
+  export type RuleFilter = (rule: {
+    ruleId: string;
+    severity: number;
+  }) => boolean;
+}
diff --git a/packages/utils/src/ts-eslint/eslint/LegacyESLint.ts b/packages/utils/src/ts-eslint/eslint/LegacyESLint.ts
new file mode 100644
index 000000000000..cf906f6e3828
--- /dev/null
+++ b/packages/utils/src/ts-eslint/eslint/LegacyESLint.ts
@@ -0,0 +1,79 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+
+import { LegacyESLint as ESLintLegacyESLint } from 'eslint/use-at-your-own-risk';
+
+import type { ClassicConfig } from '../Config';
+import type { Linter } from '../Linter';
+import type * as Shared from './ESLintShared';
+
+declare class LegacyESLintBase extends Shared.ESLintBase<
+  ClassicConfig.Config,
+  LegacyESLint.ESLintOptions
+> {
+  static readonly configType: 'eslintrc';
+}
+
+/**
+ * The ESLint class is the primary class to use in Node.js applications.
+ * This class depends on the Node.js fs module and the file system, so you cannot use it in browsers.
+ *
+ * If you want to lint code on browsers, use the Linter class instead.
+ */
+export class LegacyESLint extends (ESLintLegacyESLint as typeof LegacyESLintBase) {}
+export namespace LegacyESLint {
+  export interface ESLintOptions
+    extends Shared.ESLintOptions<ClassicConfig.Config> {
+    /**
+     * If you pass directory paths to the eslint.lintFiles() method, ESLint checks the files in those directories that
+     * have the given extensions. For example, when passing the src/ directory and extensions is [".js", ".ts"], ESLint
+     * will lint *.js and *.ts files in src/. If extensions is null, ESLint checks *.js files and files that match
+     * overrides[].files patterns in your configuration.
+     * Note: This option only applies when you pass directory paths to the eslint.lintFiles() method.
+     * If you pass glob patterns, ESLint will lint all files matching the glob pattern regardless of extension.
+     */
+    extensions?: string[] | null;
+    /**
+     * If false is present, the eslint.lintFiles() method doesn't respect `.eslintignore` files in your configuration.
+     * @default true
+     */
+    ignore?: boolean;
+    /**
+     * The path to a file ESLint uses instead of `$CWD/.eslintignore`.
+     * If a path is present and the file doesn't exist, this constructor will throw an error.
+     */
+    ignorePath?: string;
+    /**
+     * The path to a configuration file, overrides all configurations used with this instance.
+     * The options.overrideConfig option is applied after this option is applied.
+     */
+    overrideConfigFile?: string | null;
+    /**
+     * The severity to report unused eslint-disable directives.
+     * If this option is a severity, it overrides the reportUnusedDisableDirectives setting in your configurations.
+     */
+    reportUnusedDisableDirectives?: Linter.SeverityString | null;
+    /**
+     * The path to a directory where plugins should be resolved from.
+     * If null is present, ESLint loads plugins from the location of the configuration file that contains the plugin
+     * setting.
+     * If a path is present, ESLint loads all plugins from there.
+     */
+    resolvePluginsRelativeTo?: string | null;
+    /**
+     * An array of paths to directories to load custom rules from.
+     */
+    rulePaths?: string[];
+    /**
+     * If false is present, ESLint doesn't load configuration files (.eslintrc.* files).
+     * Only the configuration of the constructor options is valid.
+     */
+    useEslintrc?: boolean;
+  }
+  export type DeprecatedRuleInfo = Shared.DeprecatedRuleInfo;
+  export type EditInfo = Shared.EditInfo;
+  export type Formatter = Shared.Formatter;
+  export type LintMessage = Shared.LintMessage;
+  export type LintResult = Omit<Shared.LintResult, 'stats'>;
+  export type LintTextOptions = Shared.LintTextOptions;
+  export type SuppressedLintMessage = Shared.SuppressedLintMessage;
+}
diff --git a/packages/utils/tests/ts-eslint/ESLint.test.ts b/packages/utils/tests/ts-eslint/ESLint.test.ts
new file mode 100644
index 000000000000..f252b7eba28a
--- /dev/null
+++ b/packages/utils/tests/ts-eslint/ESLint.test.ts
@@ -0,0 +1,30 @@
+import { FlatESLint, LegacyESLint } from 'eslint/use-at-your-own-risk';
+
+import * as ESLint from '../../src/ts-eslint/ESLint';
+
+describe('ESLint', () => {
+  describe('Constructs successfully and has the correct base type', () => {
+    it('flat', () => {
+      const eslint = new ESLint.FlatESLint({
+        // accepts flat configs
+        baseConfig: [{ ignores: [] }, { languageOptions: {} }],
+        overrideConfig: [{ ignores: [] }, { languageOptions: {} }],
+      });
+      expect(eslint).toBeInstanceOf(FlatESLint);
+    });
+    it('legacy', () => {
+      const eslint = new ESLint.LegacyESLint({
+        // accepts legacy configs
+        baseConfig: {
+          parserOptions: {},
+          overrides: [],
+        },
+        overrideConfig: {
+          parserOptions: {},
+          overrides: [],
+        },
+      });
+      expect(eslint).toBeInstanceOf(LegacyESLint);
+    });
+  });
+});
diff --git a/packages/utils/typings/eslint.d.ts b/packages/utils/typings/eslint.d.ts
index 71978423a4b7..875317e5f11b 100644
--- a/packages/utils/typings/eslint.d.ts
+++ b/packages/utils/typings/eslint.d.ts
@@ -9,8 +9,12 @@ declare module 'eslint' {
   const Linter: unknown;
   const RuleTester: unknown;
   const SourceCode: unknown;
-  const CLIEngine: unknown;
-  const ESLint: unknown;
 
-  export { Linter, RuleTester, SourceCode, CLIEngine, ESLint };
+  export { Linter, RuleTester, SourceCode };
+}
+declare module 'eslint/use-at-your-own-risk' {
+  const FlatESLint: unknown;
+  const LegacyESLint: unknown;
+
+  export { FlatESLint, LegacyESLint };
 }

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/8861.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/8861.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/8861.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/8861.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>