eslint 9.23.0 → 9.25.0

package/lib/rules/space-infix-ops.js

@@ -11,7 +11,7 @@ const { isEqToken } = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/space-unary-ops.js

@@ -15,7 +15,7 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/spaced-comment.js

@@ -140,7 +140,7 @@ function createNeverStylePattern(markers) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/strict.js

@@ -63,7 +63,7 @@ function isSimpleParameterList(params) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		type: "suggestion",

package/lib/rules/switch-colon-spacing.js

@@ -16,7 +16,7 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/symbol-description.js

@@ -15,7 +15,7 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		type: "suggestion",

package/lib/rules/template-curly-spacing.js

@@ -16,7 +16,7 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/template-tag-spacing.js

@@ -10,7 +10,7 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/unicode-bom.js

@@ -8,7 +8,7 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		type: "layout",

package/lib/rules/use-isnan.js

@@ -38,7 +38,7 @@ function isNaNIdentifier(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		hasSuggestions: true,

package/lib/rules/utils/ast-utils.js

@@ -65,7 +65,7 @@ const ECMASCRIPT_GLOBALS = globals[`es${LATEST_ECMA_VERSION}`];
 /**
  * Checks reference if is non initializer and writable.
  * @param {Reference} reference A reference to check.
- * @param {int} index The index of the reference in the references.
+ * @param {number} index The index of the reference in the references.
  * @param {Reference[]} references The array that the reference belongs to.
  * @returns {boolean} Success/Failure
  * @private
@@ -1488,6 +1488,17 @@ module.exports = {
 			return false;
 		}
 
+		// Check if the function has a parameter named `this`.
+		if (
+			(node.type === "FunctionDeclaration" ||
+				node.type === "FunctionExpression") &&
+			node.params.some(
+				param => param.type === "Identifier" && param.name === "this",
+			)
+		) {
+			return false;
+		}
+
 		if (
 			(capIsConstructor && isES5Constructor(node)) ||
 			hasJSDocThisTag(node, sourceCode)
@@ -1662,7 +1673,7 @@ module.exports = {
 	/**
 	 * Get the precedence level based on the node type
 	 * @param {ASTNode} node node to evaluate
-	 * @returns {int} precedence level
+	 * @returns {number} precedence level
 	 * @private
 	 */
 	getPrecedence(node) {

package/lib/rules/utils/fix-tracker.js

@@ -4,6 +4,14 @@
  */
 "use strict";
 
+//------------------------------------------------------------------------------
+// Typedefs
+//------------------------------------------------------------------------------
+
+/**
+ * @import { SourceRange } from "@eslint/core";
+ */
+
 //------------------------------------------------------------------------------
 // Requirements
 //------------------------------------------------------------------------------
@@ -34,7 +42,7 @@ class FixTracker {
 	/**
 	 * Mark the given range as "retained", meaning that other fixes may not
 	 * may not modify this region in the same pass.
-	 * @param {int[]} range The range to retain.
+	 * @param {SourceRange} range The range to retain.
 	 * @returns {FixTracker} The same RuleFixer, for chained calls.
 	 */
 	retainRange(range) {
@@ -79,7 +87,7 @@ class FixTracker {
 	/**
 	 * Create a fix command that replaces the given range with the given text,
 	 * accounting for any retained ranges.
-	 * @param {int[]} range The range to remove in the fix.
+	 * @param {SourceRange} range The range to remove in the fix.
 	 * @param {string} text The text to insert in place of the range.
 	 * @returns {Object} The fix command.
 	 */

package/lib/rules/valid-typeof.js

@@ -14,7 +14,7 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		type: "problem",

package/lib/rules/vars-on-top.js

@@ -9,7 +9,7 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		type: "suggestion",

package/lib/rules/wrap-iife.js

@@ -37,7 +37,7 @@ function isCalleeOfNewExpression(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/wrap-regex.js

@@ -10,7 +10,7 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/yield-star-spacing.js

@@ -10,7 +10,7 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		deprecated: {

package/lib/rules/yoda.js

@@ -108,7 +108,7 @@ function getNormalizedLiteral(node) {
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
 	meta: {
 		type: "suggestion",

package/lib/services/suppressions-service.js

@@ -0,0 +1,289 @@
+/**
+ * @fileoverview Manages the suppressed violations.
+ * @author Iacovos Constantinou
+ */
+
+"use strict";
+
+//-----------------------------------------------------------------------------
+// Requirements
+//-----------------------------------------------------------------------------
+
+const fs = require("node:fs");
+const path = require("node:path");
+const { calculateStatsPerFile } = require("../eslint/eslint-helpers");
+
+//------------------------------------------------------------------------------
+// Typedefs
+//------------------------------------------------------------------------------
+
+// For VSCode IntelliSense
+/** @typedef {import("../shared/types").LintResult} LintResult */
+/** @typedef {import("../shared/types").SuppressedViolations} SuppressedViolations */
+
+//-----------------------------------------------------------------------------
+// Exports
+//-----------------------------------------------------------------------------
+
+/**
+ * Manages the suppressed violations.
+ */
+class SuppressionsService {
+	filePath = "";
+	cwd = "";
+
+	/**
+	 * Creates a new instance of SuppressionsService.
+	 * @param {Object} options The options.
+	 * @param {string} [options.filePath] The location of the suppressions file.
+	 * @param {string} [options.cwd] The current working directory.
+	 */
+	constructor({ filePath, cwd }) {
+		this.filePath = filePath;
+		this.cwd = cwd;
+	}
+
+	/**
+	 * Updates the suppressions file based on the current violations and the provided rules.
+	 * If no rules are provided, all violations are suppressed.
+	 * @param {LintResult[]|undefined} results The lint results.
+	 * @param {string[]|undefined} rules The rules to suppress.
+	 * @returns {Promise<void>}
+	 */
+	async suppress(results, rules) {
+		const suppressions = await this.load();
+
+		for (const result of results) {
+			const relativeFilePath = this.getRelativeFilePath(result.filePath);
+			const violationsByRule = SuppressionsService.countViolationsByRule(
+				result.messages,
+			);
+
+			for (const ruleId in violationsByRule) {
+				if (rules && !rules.includes(ruleId)) {
+					continue;
+				}
+
+				suppressions[relativeFilePath] ??= {};
+				suppressions[relativeFilePath][ruleId] =
+					violationsByRule[ruleId];
+			}
+		}
+
+		return this.save(suppressions);
+	}
+
+	/**
+	 * Removes old, unused suppressions for violations that do not occur anymore.
+	 * @param {LintResult[]} results The lint results.
+	 * @returns {Promise<void>} No return value.
+	 */
+	async prune(results) {
+		const suppressions = await this.load();
+		const { unused } = this.applySuppressions(results, suppressions);
+
+		for (const file in unused) {
+			if (!suppressions[file]) {
+				continue;
+			}
+
+			for (const rule in unused[file]) {
+				if (!suppressions[file][rule]) {
+					continue;
+				}
+
+				const suppressionsCount = suppressions[file][rule].count;
+				const violationsCount = unused[file][rule].count;
+
+				if (suppressionsCount === violationsCount) {
+					// Remove unused rules
+					delete suppressions[file][rule];
+				} else {
+					// Update the count to match the new number of violations
+					suppressions[file][rule].count -= violationsCount;
+				}
+			}
+
+			// Cleanup files with no rules
+			if (Object.keys(suppressions[file]).length === 0) {
+				delete suppressions[file];
+			}
+		}
+
+		return this.save(suppressions);
+	}
+
+	/**
+	 * Checks the provided suppressions against the lint results.
+	 *
+	 * For each file, counts the number of violations per rule.
+	 * For each rule in each file, compares the number of violations against the counter from the suppressions file.
+	 * If the number of violations is less or equal to the counter, messages are moved to `LintResult#suppressedMessages` and ignored.
+	 * Otherwise, all violations are reported as usual.
+	 * @param {LintResult[]} results The lint results.
+	 * @param {SuppressedViolations} suppressions The suppressions.
+	 * @returns {{
+	 *   results: LintResult[],
+	 *   unused: SuppressedViolations
+	 * }} The updated results and the unused suppressions.
+	 */
+	applySuppressions(results, suppressions) {
+		/**
+		 * We copy the results to avoid modifying the original objects
+		 * We remove only result messages that are matched and hence suppressed
+		 * We leave the rest untouched to minimize the risk of losing parts of the original data
+		 */
+		const filtered = structuredClone(results);
+		const unused = {};
+
+		for (const result of filtered) {
+			const relativeFilePath = this.getRelativeFilePath(result.filePath);
+
+			if (!suppressions[relativeFilePath]) {
+				continue;
+			}
+
+			const violationsByRule = SuppressionsService.countViolationsByRule(
+				result.messages,
+			);
+			let wasSuppressed = false;
+
+			for (const ruleId in violationsByRule) {
+				if (!suppressions[relativeFilePath][ruleId]) {
+					continue;
+				}
+
+				const suppressionsCount =
+					suppressions[relativeFilePath][ruleId].count;
+				const violationsCount = violationsByRule[ruleId].count;
+
+				// Suppress messages if the number of violations is less or equal to the suppressions count
+				if (violationsCount <= suppressionsCount) {
+					SuppressionsService.suppressMessagesByRule(result, ruleId);
+					wasSuppressed = true;
+				}
+
+				// Update the count to match the new number of violations, otherwise remove the rule entirely
+				if (violationsCount < suppressionsCount) {
+					unused[relativeFilePath] ??= {};
+					unused[relativeFilePath][ruleId] ??= {};
+					unused[relativeFilePath][ruleId].count =
+						suppressionsCount - violationsCount;
+				}
+			}
+
+			// Mark as unused all the suppressions that were not matched against a rule
+			for (const ruleId in suppressions[relativeFilePath]) {
+				if (violationsByRule[ruleId]) {
+					continue;
+				}
+
+				unused[relativeFilePath] ??= {};
+				unused[relativeFilePath][ruleId] =
+					suppressions[relativeFilePath][ruleId];
+			}
+
+			// Recalculate stats if messages were suppressed
+			if (wasSuppressed) {
+				Object.assign(result, calculateStatsPerFile(result.messages));
+			}
+		}
+
+		return {
+			results: filtered,
+			unused,
+		};
+	}
+
+	/**
+	 * Loads the suppressions file.
+	 * @throws {Error} If the suppressions file cannot be parsed.
+	 * @returns {Promise<SuppressedViolations>} The suppressions.
+	 */
+	async load() {
+		try {
+			const data = await fs.promises.readFile(this.filePath, "utf8");
+
+			return JSON.parse(data);
+		} catch (err) {
+			if (err.code === "ENOENT") {
+				return {};
+			}
+			throw new Error(
+				`Failed to parse suppressions file at ${this.filePath}`,
+			);
+		}
+	}
+
+	/**
+	 * Updates the suppressions file.
+	 * @param {SuppressedViolations} suppressions The suppressions to save.
+	 * @returns {Promise<void>}
+	 * @private
+	 */
+	save(suppressions) {
+		return fs.promises.writeFile(
+			this.filePath,
+			JSON.stringify(suppressions, null, 2),
+		);
+	}
+
+	/**
+	 * Counts the violations by rule, ignoring warnings.
+	 * @param {LintMessage[]} messages The messages to count.
+	 * @returns {Record<string, number>} The number of violations by rule.
+	 */
+	static countViolationsByRule(messages) {
+		return messages.reduce((totals, message) => {
+			if (message.severity === 2 && message.ruleId) {
+				totals[message.ruleId] ??= { count: 0 };
+				totals[message.ruleId].count++;
+			}
+			return totals;
+		}, {});
+	}
+
+	/**
+	 * Returns the relative path of a file to the current working directory.
+	 * Always in POSIX format for consistency and interoperability.
+	 * @param {string} filePath The file path.
+	 * @returns {string} The relative file path.
+	 */
+	getRelativeFilePath(filePath) {
+		return path
+			.relative(this.cwd, filePath)
+			.split(path.sep)
+			.join(path.posix.sep);
+	}
+
+	/**
+	 * Moves the messages matching the rule to `LintResult#suppressedMessages` and updates the stats.
+	 * @param {LintResult} result The result to update.
+	 * @param {string} ruleId The rule to suppress.
+	 * @returns {void}
+	 */
+	static suppressMessagesByRule(result, ruleId) {
+		const suppressedMessages = result.messages.filter(
+			message => message.ruleId === ruleId,
+		);
+
+		result.suppressedMessages = result.suppressedMessages.concat(
+			suppressedMessages.map(message => {
+				message.suppressions = [
+					{
+						kind: "file",
+						justification: "",
+					},
+				];
+
+				return message;
+			}),
+		);
+
+		result.messages = result.messages.filter(
+			message => message.ruleId !== ruleId,
+		);
+	}
+}
+
+module.exports = { SuppressionsService };

package/lib/shared/flags.js

@@ -31,6 +31,10 @@ const activeFlags = new Map([
 		"unstable_config_lookup_from_file",
 		"Look up `eslint.config.js` from the file being linted.",
 	],
+	[
+		"unstable_native_nodejs_ts_config",
+		"Use native Node.js to load TypeScript configuration.",
+	],
 ]);
 
 /**

package/lib/shared/types.js

@@ -124,6 +124,10 @@ module.exports = {};
  * @property {Array<{desc?: string, messageId?: string, fix: {range: [number, number], text: string}}>} [suggestions] Information for suggestions.
  */
 
+/**
+ * @typedef {Record<string, Record<string, { count: number }>>} SuppressedViolations
+ */
+
 /**
  * @typedef {Object} SuggestionResult
  * @property {string} desc A short description.
@@ -162,25 +166,6 @@ module.exports = {};
  * @property {{ name?: string, url?: string }} [rule] Name and information of the replacement rule
  */
 
-/**
- * @typedef {Object} RuleMeta
- * @property {boolean|DeprecatedInfo} [deprecated] If `true` then the rule has been deprecated.
- * @property {Array} [defaultOptions] Default options for the rule.
- * @property {RuleMetaDocs} docs The document information of the rule.
- * @property {"code"|"whitespace"} [fixable] The autofix type.
- * @property {boolean} [hasSuggestions] If `true` then the rule provides suggestions.
- * @property {Record<string,string>} [messages] The messages the rule reports.
- * @property {string[]} [replacedBy] The IDs of the alternative rules.
- * @property {Array|Object} schema The option schema of the rule.
- * @property {"problem"|"suggestion"|"layout"} type The rule type.
- */
-
-/**
- * @typedef {Object} Rule
- * @property {Function} create The factory of the rule.
- * @property {RuleMeta} meta The meta data of the rule.
- */
-
 /**
  * @typedef {Object} Plugin
  * @property {Record<string, ConfigData>} [configs] The definition of plugin configs.
@@ -259,11 +244,3 @@ module.exports = {};
  * @typedef {Object} ResultsMeta
  * @property {MaxWarningsExceeded} [maxWarningsExceeded] Present if the maxWarnings threshold was exceeded.
  */
-
-/**
- * A formatter function.
- * @callback FormatterFunction
- * @param {LintResult[]} results The list of linting results.
- * @param {{cwd: string, maxWarningsExceeded?: MaxWarningsExceeded, rulesMeta: Record<string, RuleMeta>}} context A context object.
- * @returns {string | Promise<string>} Formatted text.
- */

package/lib/types/index.d.ts

@@ -1174,13 +1174,13 @@ export namespace Rule {
 	}
 
 	interface RuleContext
-		extends CoreRuleContext<
-			RuleContextTypeOptions & {
-				LangOptions: Linter.LanguageOptions;
-				Code: SourceCode;
-				Node: ESTree.Node;
-			}
-		> {
+		extends CoreRuleContext<{
+			LangOptions: Linter.LanguageOptions;
+			Code: SourceCode;
+			RuleOptions: any[];
+			Node: ESTree.Node;
+			MessageIds: string;
+		}> {
 		/*
 		 * Need to extend the `RuleContext` interface to include the
 		 * deprecated methods that have not yet been removed.
@@ -1262,6 +1262,29 @@ export namespace Rule {
 	}
 }
 
+export type JSRuleDefinitionTypeOptions = {
+	RuleOptions: unknown[];
+	MessageIds: string;
+	ExtRuleDocs: Record<string, unknown>;
+};
+
+export type JSRuleDefinition<
+	Options extends Partial<JSRuleDefinitionTypeOptions> = {},
+> = RuleDefinition<
+	// Language specific type options (non-configurable)
+	{
+		LangOptions: Linter.LanguageOptions;
+		Code: SourceCode;
+		Visitor: Rule.NodeListener;
+		Node: ESTree.Node;
+	} & Required<
+		// Rule specific type options (custom)
+		Options &
+			// Rule specific type options (defaults)
+			Omit<JSRuleDefinitionTypeOptions, keyof Options>
+	>
+>;
+
 // #region Linter
 
 export class Linter {

package/lib/types/rules.d.ts

@@ -422,6 +422,15 @@ export interface ESLintRules extends Linter.RulesRecord {
 		[
 			Partial<{
 				exceptMethods: string[];
+				/**
+				 * @default true
+				 */
+				enforceForClassFields: boolean;
+				/**
+				 * @default false
+				 */
+				ignoreOverrideMethods: boolean;
+				ignoreClassesWithImplements: "all" | "public-fields";
 			}>,
 		]
 	>;
@@ -2350,6 +2359,10 @@ export interface ESLintRules extends Linter.RulesRecord {
 					| "constructors"
 					| "asyncFunctions"
 					| "asyncMethods"
+					| "privateConstructors"
+					| "protectedConstructors"
+					| "decoratedFunctions"
+					| "overrideMethods"
 				>;
 			}>,
 		]
@@ -3430,6 +3443,7 @@ export interface ESLintRules extends Linter.RulesRecord {
 				  }
 				| {
 						property: string;
+						allowObjects?: string[];
 						message?: string | undefined;
 				  }
 			>,