⬅️ Back to Table of Contents

📄 LegacyESLint

📊 Analysis Summary

Metric	Count
🔧 Functions	3
🧱 Classes	3
📦 Imports	4
📐 Interfaces	1
📑 Type Aliases	7

📚 Table of Contents

• Imports
• Functions
• Classes
• Interfaces
• Type Aliases

🛠️ File Location:

📂 packages/utils/src/ts-eslint/eslint/LegacyESLint.ts

📦 Imports

Name	Source
ESLint	eslint
useAtYourOwnRisk	eslint/use-at-your-own-risk
ClassicConfig	../Config
Linter	../Linter

---

Functions

throwMissingLegacyESLintError(): never

Returns: never

Code

function throwMissingLegacyESLintError(): never {
  throw new Error(
    'LegacyESLint is not available with the current version of ESLint.',
  );
}

MissingLegacyESLint.getErrorResults(): Shared.LintResult

Returns: Shared.LintResult

Calls:

• throwMissingLegacyESLintError

Code

static getErrorResults(): Shared.LintResult {
    throwMissingLegacyESLintError();
  }

MissingLegacyESLint.outputFixes(): Promise<void>

Returns: Promise<void>

Calls:

• throwMissingLegacyESLintError

Code

static outputFixes(): Promise<void> {
    throwMissingLegacyESLintError();
  }

---

Classes

LegacyESLintBase

Extends: `Shared.ESLintBase< ClassicConfig.Config, LegacyESLint.ESLintOptions

`

Class Code

declare class LegacyESLintBase extends Shared.ESLintBase<
  ClassicConfig.Config,
  LegacyESLint.ESLintOptions
> {
  static readonly configType: 'eslintrc';
}

MissingLegacyESLint

Class Code

class MissingLegacyESLint {
  static readonly configType = 'eslintrc';
  static readonly version = (ESLint as typeof LegacyESLintBase).version;
  constructor() {
    throwMissingLegacyESLintError();
  }
  static getErrorResults(): Shared.LintResult {
    throwMissingLegacyESLintError();
  }
  static outputFixes(): Promise<void> {
    throwMissingLegacyESLintError();
  }
}

Methods (2) — full entries under Functions

Method	Signature
getErrorResults	(): Shared.LintResult
outputFixes	(): Promise<void>

LegacyESLint

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.

Extends: ((useAtYourOwnRisk.LegacyESLint ?? MissingLegacyESLint) as typeof LegacyESLintBase)

Class Code

export class LegacyESLint extends ((useAtYourOwnRisk.LegacyESLint ??
  MissingLegacyESLint) as typeof LegacyESLintBase) {}

---

Interfaces

ESLintOptions

Interface Code

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;
  }

Properties

Name	Type	Optional	Description
extensions	string[] \| null	✓	not shown
ignore	boolean	✓	not shown
ignorePath	string	✓	not shown
overrideConfigFile	string \| null	✓	not shown
reportUnusedDisableDirectives	Linter.SeverityString \| null	✓	not shown
resolvePluginsRelativeTo	string \| null	✓	not shown
rulePaths	string[]	✓	not shown
useEslintrc	boolean	✓	not shown

---

Type Aliases

DeprecatedRuleInfo

type DeprecatedRuleInfo = Shared.DeprecatedRuleInfo;

EditInfo

type EditInfo = Shared.EditInfo;

Formatter

type Formatter = Shared.Formatter;

LintMessage

type LintMessage = Shared.LintMessage;

LintResult

type LintResult = Omit<Shared.LintResult, 'stats'>;

LintTextOptions

type LintTextOptions = Shared.LintTextOptions;

SuppressedLintMessage

type SuppressedLintMessage = Shared.SuppressedLintMessage;

---

Generated by Syntax Scribe