eslint 9.26.0 → 9.28.0

package/lib/languages/js/source-code/source-code.js

@@ -53,7 +53,7 @@ const CODE_PATH_EVENTS = [
 /**
  * Validates that the given AST has the required information.
  * @param {ASTNode} ast The Program node of the AST to check.
- * @throws {Error} If the AST doesn't contain the correct information.
+ * @throws {TypeError} If the AST doesn't contain the correct information.
  * @returns {void}
  * @private
  */
@@ -147,8 +147,8 @@ function sortedMerge(tokens, comments) {
  * Normalizes a value for a global in a config
  * @param {(boolean|string|null)} configuredValue The value given for a global in configuration or in
  * a global directive comment
- * @returns {("readable"|"writeable"|"off")} The value normalized as a string
- * @throws Error if global value is invalid
+ * @returns {("readonly"|"writable"|"off")} The value normalized as a string
+ * @throws {Error} if global value is invalid
  */
 function normalizeConfigGlobal(configuredValue) {
 	switch (configuredValue) {
@@ -316,6 +316,36 @@ function addDeclaredGlobals(
 
 		return true;
 	});
+
+	/*
+	 * "implicit" contains information about implicit global variables (those created
+	 * implicitly by assigning values to undeclared variables in non-strict code).
+	 * Since we augment the global scope using configuration, we need to remove
+	 * the ones that were added by configuration, as they are either built-in
+	 * or declared elsewhere, therefore not implicit.
+	 * Since the "implicit" property was not documented, first we'll check if it exists
+	 * because it's possible that not all custom scope managers create this property.
+	 * If it exists, we assume it has properties `variables` and `set`. Property
+	 * `left` is considered optional (for example, typescript-eslint's scope manage
+	 * has this property named `leftToBeResolved`).
+	 */
+	const { implicit } = globalScope;
+	if (typeof implicit === "object" && implicit !== null) {
+		implicit.variables = implicit.variables.filter(variable => {
+			const name = variable.name;
+			if (globalScope.set.has(name)) {
+				implicit.set.delete(name);
+				return false;
+			}
+			return true;
+		});
+
+		if (implicit.left) {
+			implicit.left = implicit.left.filter(
+				reference => !globalScope.set.has(reference.identifier.name),
+			);
+		}
+	}
 }
 
 /**
@@ -471,6 +501,10 @@ class SourceCode extends TokenStore {
 		 * @type {string[]}
 		 */
 		this.lines = [];
+
+		/**
+		 * @type {number[]}
+		 */
 		this.lineStartIndices = [0];
 
 		const lineEndingPattern = astUtils.createGlobalLinebreakMatcher();
@@ -528,7 +562,7 @@ class SourceCode extends TokenStore {
 
 	/**
 	 * Gets the entire source text split into an array of lines.
-	 * @returns {Array} The source text as an array of lines.
+	 * @returns {string[]} The source text as an array of lines.
 	 * @public
 	 */
 	getLines() {
@@ -687,8 +721,8 @@ class SourceCode extends TokenStore {
 	/**
 	 * Converts a source text index into a (line, column) pair.
 	 * @param {number} index The index of a character in a file
-	 * @throws {TypeError} If non-numeric index or index out of range.
-	 * @returns {Object} A {line, column} location object with a 0-indexed column
+	 * @throws {TypeError|RangeError} If non-numeric index or index out of range.
+	 * @returns {{line: number, column: number}} A {line, column} location object with a 0-indexed column
 	 * @public
 	 */
 	getLocFromIndex(index) {

package/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 */

package/lib/linter/file-context.js

@@ -128,6 +128,17 @@ class FileContext {
 	getSourceCode() {
 		return this.sourceCode;
 	}
+
+	/**
+	 * Creates a new object with the current object as the prototype and
+	 * the specified properties as its own properties.
+	 * @param {Object} extension The properties to add to the new object.
+	 * @returns {FileContext} A new object with the current object as the prototype
+	 * and the specified properties as its own properties.
+	 */
+	extend(extension) {
+		return Object.freeze(Object.assign(Object.create(this), extension));
+	}
 }
 
 exports.FileContext = FileContext;

package/lib/linter/linter.js

@@ -27,17 +27,14 @@ const path = require("node:path"),
 	{ SourceCode } = require("../languages/js/source-code"),
 	applyDisableDirectives = require("./apply-disable-directives"),
 	{ ConfigCommentParser } = require("@eslint/plugin-kit"),
-	NodeEventGenerator = require("./node-event-generator"),
 	createReportTranslator = require("./report-translator"),
 	Rules = require("./rules"),
 	createEmitter = require("./safe-emitter"),
 	SourceCodeFixer = require("./source-code-fixer"),
 	timing = require("./timing"),
 	ruleReplacements = require("../../conf/replacements.json");
-const { getRuleFromConfig } = require("../config/flat-config-helpers");
 const { FlatConfigArray } = require("../config/flat-config-array");
 const { startTime, endTime } = require("../shared/stats");
-const { RuleValidator } = require("../config/rule-validator");
 const { assertIsRuleSeverity } = require("../config/flat-config-schema");
 const {
 	normalizeSeverityToString,
@@ -66,8 +63,9 @@ const { ParserService } = require("../services/parser-service");
 const { FileContext } = require("./file-context");
 const { ProcessorService } = require("../services/processor-service");
 const { containsDifferentProperty } = require("../shared/option-utils");
-const STEP_KIND_VISIT = 1;
-const STEP_KIND_CALL = 2;
+const { Config } = require("../config/config");
+const { WarningService } = require("../services/warning-service");
+const { SourceCodeTraverser } = require("./source-code-traverser");
 
 //------------------------------------------------------------------------------
 // Typedefs
@@ -75,17 +73,19 @@ const STEP_KIND_CALL = 2;
 
 /** @import { Language, LanguageOptions, RuleConfig, RuleDefinition, RuleSeverity } from "@eslint/core" */
 
-/** @typedef {import("../shared/types").ConfigData} ConfigData */
-/** @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").ParserOptions} ParserOptions */
-/** @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.StringSeverity} StringSeverity */
+/** @typedef {import("../types").Linter.LintMessage} LintMessage */
+/** @typedef {import("../types").Linter.Parser} Parser */
+/** @typedef {import("../types").Linter.ParserOptions} ParserOptions */
+/** @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 */
 /**
@@ -110,8 +110,9 @@ 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.
+ * @property {WarningService} warningService The warning service.
  */
 
 /**
@@ -350,7 +351,7 @@ function asArray(value) {
 
 /**
  * Pushes a problem to inlineConfigProblems if ruleOptions are redundant.
- * @param {ConfigData} config Provided config.
+ * @param {Config} config Provided config.
  * @param {Object} loc A line/column location
  * @param {Array} problems Problems that may be added to.
  * @param {string} ruleId The rule ID.
@@ -901,7 +902,7 @@ function normalizeFilename(filename) {
  * Normalizes the possible options for `linter.verify` and `linter.verifyAndFix` to a
  * consistent shape.
  * @param {VerifyOptions} providedOptions Options
- * @param {ConfigData} config Config.
+ * @param {Config|ConfigData} config Config.
  * @returns {Required<VerifyOptions> & InternalOptions} Normalized options
  */
 function normalizeVerifyOptions(providedOptions, config) {
@@ -1176,15 +1177,12 @@ function runRules(
 ) {
 	const emitter = createEmitter();
 
-	// must happen first to assign all node.parent properties
-	const eventQueue = sourceCode.traverse();
-
 	/*
 	 * Create a frozen object with the ruleContext properties and methods that are shared by all rules.
 	 * All rule contexts will inherit from this object. This avoids the performance penalty of copying all the
 	 * properties once for each rule.
 	 */
-	const sharedTraversalContext = new FileContext({
+	const fileContext = new FileContext({
 		cwd,
 		filename,
 		physicalFilename: physicalFilename || filename,
@@ -1198,9 +1196,10 @@ function runRules(
 	});
 
 	const lintingProblems = [];
+	const steps = sourceCode.traverse();
 
 	Object.keys(configuredRules).forEach(ruleId => {
-		const severity = ConfigOps.getRuleSeverity(configuredRules[ruleId]);
+		const severity = Config.getRuleNumericSeverity(configuredRules[ruleId]);
 
 		// not load disabled rules
 		if (severity === 0) {
@@ -1220,63 +1219,61 @@ function runRules(
 
 		const messageIds = rule.meta && rule.meta.messages;
 		let reportTranslator = null;
-		const ruleContext = Object.freeze(
-			Object.assign(Object.create(sharedTraversalContext), {
-				id: ruleId,
-				options: getRuleOptions(
-					configuredRules[ruleId],
-					applyDefaultOptions ? rule.meta?.defaultOptions : void 0,
-				),
-				report(...args) {
-					/*
-					 * Create a report translator lazily.
-					 * In a vast majority of cases, any given rule reports zero errors on a given
-					 * piece of code. Creating a translator lazily avoids the performance cost of
-					 * creating a new translator function for each rule that usually doesn't get
-					 * called.
-					 *
-					 * Using lazy report translators improves end-to-end performance by about 3%
-					 * with Node 8.4.0.
-					 */
-					if (reportTranslator === null) {
-						reportTranslator = createReportTranslator({
-							ruleId,
-							severity,
-							sourceCode,
-							messageIds,
-							disableFixes,
-							language,
-						});
-					}
-					const problem = reportTranslator(...args);
+		const ruleContext = fileContext.extend({
+			id: ruleId,
+			options: getRuleOptions(
+				configuredRules[ruleId],
+				applyDefaultOptions ? rule.meta?.defaultOptions : void 0,
+			),
+			report(...args) {
+				/*
+				 * Create a report translator lazily.
+				 * In a vast majority of cases, any given rule reports zero errors on a given
+				 * piece of code. Creating a translator lazily avoids the performance cost of
+				 * creating a new translator function for each rule that usually doesn't get
+				 * called.
+				 *
+				 * Using lazy report translators improves end-to-end performance by about 3%
+				 * with Node 8.4.0.
+				 */
+				if (reportTranslator === null) {
+					reportTranslator = createReportTranslator({
+						ruleId,
+						severity,
+						sourceCode,
+						messageIds,
+						disableFixes,
+						language,
+					});
+				}
+				const problem = reportTranslator(...args);
 
-					if (problem.fix && !(rule.meta && rule.meta.fixable)) {
-						throw new Error(
-							'Fixable rules must set the `meta.fixable` property to "code" or "whitespace".',
-						);
-					}
+				if (problem.fix && !(rule.meta && rule.meta.fixable)) {
+					throw new Error(
+						'Fixable rules must set the `meta.fixable` property to "code" or "whitespace".',
+					);
+				}
+				if (
+					problem.suggestions &&
+					!(rule.meta && rule.meta.hasSuggestions === true)
+				) {
 					if (
-						problem.suggestions &&
-						!(rule.meta && rule.meta.hasSuggestions === true)
+						rule.meta &&
+						rule.meta.docs &&
+						typeof rule.meta.docs.suggestion !== "undefined"
 					) {
-						if (
-							rule.meta &&
-							rule.meta.docs &&
-							typeof rule.meta.docs.suggestion !== "undefined"
-						) {
-							// Encourage migration from the former property name.
-							throw new Error(
-								"Rules with suggestions must set the `meta.hasSuggestions` property to `true`. `meta.docs.suggestion` is ignored by ESLint.",
-							);
-						}
+						// Encourage migration from the former property name.
 						throw new Error(
-							"Rules with suggestions must set the `meta.hasSuggestions` property to `true`.",
+							"Rules with suggestions must set the `meta.hasSuggestions` property to `true`. `meta.docs.suggestion` is ignored by ESLint.",
 						);
 					}
-					lintingProblems.push(problem);
-				},
-			}),
-		);
+					throw new Error(
+						"Rules with suggestions must set the `meta.hasSuggestions` property to `true`.",
+					);
+				}
+				lintingProblems.push(problem);
+			},
+		});
 
 		const ruleListenersReturn =
 			timing.enabled || stats
@@ -1346,40 +1343,9 @@ function runRules(
 		});
 	});
 
-	const eventGenerator = new NodeEventGenerator(emitter, {
-		visitorKeys: sourceCode.visitorKeys ?? language.visitorKeys,
-		fallback: Traverser.getKeys,
-		matchClass: language.matchesSelectorClass ?? (() => false),
-		nodeTypeKey: language.nodeTypeKey,
-	});
+	const traverser = SourceCodeTraverser.getInstance(language);
 
-	for (const step of eventQueue) {
-		switch (step.kind) {
-			case STEP_KIND_VISIT: {
-				try {
-					if (step.phase === 1) {
-						eventGenerator.enterNode(step.target);
-					} else {
-						eventGenerator.leaveNode(step.target);
-					}
-				} catch (err) {
-					err.currentNode = step.target;
-					throw err;
-				}
-				break;
-			}
-
-			case STEP_KIND_CALL: {
-				emitter.emit(step.target, ...step.args);
-				break;
-			}
-
-			default:
-				throw new Error(
-					`Invalid traversal step found: "${step.type}".`,
-				);
-		}
-	}
+	traverser.traverseSync(sourceCode, emitter, { steps });
 
 	return lintingProblems;
 }
@@ -1484,8 +1450,14 @@ class Linter {
 	 * @param {string} [config.cwd] path to a directory that should be considered as the current working directory, can be undefined.
 	 * @param {Array<string>} [config.flags] the feature flags to enable.
 	 * @param {"flat"|"eslintrc"} [config.configType="flat"] the type of config used.
+	 * @param {WarningService} [config.warningService] The warning service to use.
 	 */
-	constructor({ cwd, configType = "flat", flags = [] } = {}) {
+	constructor({
+		cwd,
+		configType = "flat",
+		flags = [],
+		warningService = new WarningService(),
+	} = {}) {
 		const processedFlags = [];
 
 		flags.forEach(flag => {
@@ -1493,11 +1465,10 @@ class Linter {
 				const inactiveFlagData = inactiveFlags.get(flag);
 				const inactivityReason =
 					getInactivityReasonMessage(inactiveFlagData);
+				const message = `The flag '${flag}' is inactive: ${inactivityReason}`;
 
 				if (typeof inactiveFlagData.replacedBy === "undefined") {
-					throw new Error(
-						`The flag '${flag}' is inactive: ${inactivityReason}`,
-					);
+					throw new Error(message);
 				}
 
 				// if there's a replacement, enable it instead of original
@@ -1505,10 +1476,7 @@ class Linter {
 					processedFlags.push(inactiveFlagData.replacedBy);
 				}
 
-				globalThis.process?.emitWarning?.(
-					`The flag '${flag}' is inactive: ${inactivityReason}`,
-					`ESLintInactiveFlag_${flag}`,
-				);
+				warningService.emitInactiveFlagWarning(flag, message);
 
 				return;
 			}
@@ -1529,6 +1497,7 @@ class Linter {
 			configType, // TODO: Remove after flat config conversion
 			parserMap: new Map([["espree", espree]]),
 			ruleMap: new Rules(),
+			warningService,
 		});
 
 		this.version = pkg.version;
@@ -1885,7 +1854,7 @@ class Linter {
 	/**
 	 * Verify with a processor.
 	 * @param {string|SourceCode} textOrSourceCode The source code.
-	 * @param {FlatConfig} config The config array.
+	 * @param {Config} config The config array.
 	 * @param {VerifyOptions&ProcessorOptions} options The options.
 	 * @param {FlatConfigArray} [configForRecursive] The `ConfigArray` object to apply multiple processors recursively.
 	 * @returns {(LintMessage|SuppressedLintMessage)[]} The found problems.
@@ -1986,7 +1955,7 @@ class Linter {
 	/**
 	 * Verify using flat config and without any processors.
 	 * @param {VFile} file The file to lint.
-	 * @param {FlatConfig} providedConfig An ESLintConfig instance to configure everything.
+	 * @param {Config} providedConfig An ESLintConfig instance to configure everything.
 	 * @param {VerifyOptions} [providedOptions] The optional filename of the file being checked.
 	 * @throws {Error} If during rule execution.
 	 * @returns {(LintMessage|SuppressedLintMessage)[]} The results as an array of messages or an empty array if no messages.
@@ -2100,15 +2069,12 @@ class Linter {
 							}),
 					);
 
-					// next we need to verify information about the specified rules
-					const ruleValidator = new RuleValidator();
-
 					for (const {
 						config: inlineConfig,
 						loc,
 					} of inlineConfigResult.configs) {
 						Object.keys(inlineConfig.rules).forEach(ruleId => {
-							const rule = getRuleFromConfig(ruleId, config);
+							const rule = config.getRuleDefinition(ruleId);
 							const ruleValue = inlineConfig.rules[ruleId];
 
 							if (!rule) {
@@ -2218,11 +2184,8 @@ class Linter {
 								}
 
 								if (shouldValidateOptions) {
-									ruleValidator.validate({
-										plugins: config.plugins,
-										rules: {
-											[ruleId]: ruleOptions,
-										},
+									config.validateRulesConfig({
+										[ruleId]: ruleOptions,
 									});
 								}
 
@@ -2270,7 +2233,7 @@ class Linter {
 			options.allowInlineConfig && !options.warnInlineConfig
 				? getDirectiveCommentsForFlatConfig(
 						sourceCode,
-						ruleId => getRuleFromConfig(ruleId, config),
+						ruleId => config.getRuleDefinition(ruleId),
 						config.language,
 					)
 				: { problems: [], disableDirectives: [] };
@@ -2289,7 +2252,7 @@ class Linter {
 			lintingProblems = runRules(
 				sourceCode,
 				configuredRules,
-				ruleId => getRuleFromConfig(ruleId, config),
+				ruleId => config.getRuleDefinition(ruleId),
 				void 0,
 				config.language,
 				languageOptions,
@@ -2348,7 +2311,7 @@ class Linter {
 	/**
 	 * Same as linter.verify, except without support for processors.
 	 * @param {string|SourceCode} textOrSourceCode The text to parse or a SourceCode object.
-	 * @param {FlatConfig} providedConfig An ESLintConfig instance to configure everything.
+	 * @param {Config} providedConfig An ESLintConfig instance to configure everything.
 	 * @param {VerifyOptions} [providedOptions] The optional filename of the file being checked.
 	 * @throws {Error} If during rule execution.
 	 * @returns {(LintMessage|SuppressedLintMessage)[]} The results as an array of messages or an empty array if no messages.
@@ -2619,7 +2582,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: [] };
@@ -2717,6 +2680,14 @@ class Linter {
 			options && typeof options.fix !== "undefined" ? options.fix : true;
 		const stats = options?.stats;
 
+		const slots = internalSlotsMap.get(this);
+
+		// Remove lint times from the last run.
+		if (stats) {
+			delete slots.times;
+			slots.fixPasses = 0;
+		}
+
 		/**
 		 * This loop continues until one of the following is true:
 		 *
@@ -2726,14 +2697,6 @@ class Linter {
 		 * That means anytime a fix is successfully applied, there will be another pass.
 		 * Essentially, guaranteeing a minimum of two passes.
 		 */
-		const slots = internalSlotsMap.get(this);
-
-		// Remove lint times from the last run.
-		if (stats) {
-			delete slots.times;
-			slots.fixPasses = 0;
-		}
-
 		do {
 			passNumber++;
 			let tTotal;
@@ -2805,9 +2768,8 @@ class Linter {
 				debug(
 					`Circular fixes detected after pass ${passNumber}. Exiting fix loop.`,
 				);
-				globalThis?.process?.emitWarning?.(
-					`Circular fixes detected while fixing ${options?.filename ?? "text"}. It is likely that you have conflicting rules in your configuration.`,
-					"ESLintCircularFixesWarning",
+				slots.warningService.emitCircularFixesWarning(
+					options?.filename ?? "text",
 				);
 				break;
 			}

package/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