eslint 9.26.0 → 9.27.0

package/lib/config/flat-config-helpers.js

@@ -1,128 +0,0 @@
-/**
- * @fileoverview Shared functions to work with configs.
- * @author Nicholas C. Zakas
- */
-
-"use strict";
-
-//------------------------------------------------------------------------------
-// Typedefs
-//------------------------------------------------------------------------------
-
-/**
- * @import { RuleDefinition } from "@eslint/core";
- * @import { Linter } from "eslint";
- */
-
-//------------------------------------------------------------------------------
-// Private Members
-//------------------------------------------------------------------------------
-
-// JSON schema that disallows passing any options
-const noOptionsSchema = Object.freeze({
-	type: "array",
-	minItems: 0,
-	maxItems: 0,
-});
-
-//-----------------------------------------------------------------------------
-// Functions
-//-----------------------------------------------------------------------------
-
-/**
- * Parses a ruleId into its plugin and rule parts.
- * @param {string} ruleId The rule ID to parse.
- * @returns {{pluginName:string,ruleName:string}} The plugin and rule
- *      parts of the ruleId;
- */
-function parseRuleId(ruleId) {
-	let pluginName, ruleName;
-
-	// distinguish between core rules and plugin rules
-	if (ruleId.includes("/")) {
-		// mimic scoped npm packages
-		if (ruleId.startsWith("@")) {
-			pluginName = ruleId.slice(0, ruleId.lastIndexOf("/"));
-		} else {
-			pluginName = ruleId.slice(0, ruleId.indexOf("/"));
-		}
-
-		ruleName = ruleId.slice(pluginName.length + 1);
-	} else {
-		pluginName = "@";
-		ruleName = ruleId;
-	}
-
-	return {
-		pluginName,
-		ruleName,
-	};
-}
-
-/**
- * Retrieves a rule instance from a given config based on the ruleId.
- * @param {string} ruleId The rule ID to look for.
- * @param {Linter.Config} config The config to search.
- * @returns {RuleDefinition|undefined} The rule if found
- *      or undefined if not.
- */
-function getRuleFromConfig(ruleId, config) {
-	const { pluginName, ruleName } = parseRuleId(ruleId);
-
-	return config.plugins?.[pluginName]?.rules?.[ruleName];
-}
-
-/**
- * Gets a complete options schema for a rule.
- * @param {RuleDefinition} rule A rule object
- * @throws {TypeError} If `meta.schema` is specified but is not an array, object or `false`.
- * @returns {Object|null} JSON Schema for the rule's options. `null` if `meta.schema` is `false`.
- */
-function getRuleOptionsSchema(rule) {
-	if (!rule.meta) {
-		return { ...noOptionsSchema }; // default if `meta.schema` is not specified
-	}
-
-	const schema = rule.meta.schema;
-
-	if (typeof schema === "undefined") {
-		return { ...noOptionsSchema }; // default if `meta.schema` is not specified
-	}
-
-	// `schema:false` is an allowed explicit opt-out of options validation for the rule
-	if (schema === false) {
-		return null;
-	}
-
-	if (typeof schema !== "object" || schema === null) {
-		throw new TypeError("Rule's `meta.schema` must be an array or object");
-	}
-
-	// ESLint-specific array form needs to be converted into a valid JSON Schema definition
-	if (Array.isArray(schema)) {
-		if (schema.length) {
-			return {
-				type: "array",
-				items: schema,
-				minItems: 0,
-				maxItems: schema.length,
-			};
-		}
-
-		// `schema:[]` is an explicit way to specify that the rule does not accept any options
-		return { ...noOptionsSchema };
-	}
-
-	// `schema:<object>` is assumed to be a valid JSON Schema definition
-	return schema;
-}
-
-//-----------------------------------------------------------------------------
-// Exports
-//-----------------------------------------------------------------------------
-
-module.exports = {
-	parseRuleId,
-	getRuleFromConfig,
-	getRuleOptionsSchema,
-};

package/lib/config/rule-validator.js

@@ -1,199 +0,0 @@
-/**
- * @fileoverview Rule Validator
- * @author Nicholas C. Zakas
- */
-
-"use strict";
-
-//-----------------------------------------------------------------------------
-// Requirements
-//-----------------------------------------------------------------------------
-
-const ajvImport = require("../shared/ajv");
-const ajv = ajvImport();
-const {
-	parseRuleId,
-	getRuleFromConfig,
-	getRuleOptionsSchema,
-} = require("./flat-config-helpers");
-const ruleReplacements = require("../../conf/replacements.json");
-
-//-----------------------------------------------------------------------------
-// Helpers
-//-----------------------------------------------------------------------------
-
-/**
- * Throws a helpful error when a rule cannot be found.
- * @param {Object} ruleId The rule identifier.
- * @param {string} ruleId.pluginName The ID of the rule to find.
- * @param {string} ruleId.ruleName The ID of the rule to find.
- * @param {Object} config The config to search in.
- * @throws {TypeError} For missing plugin or rule.
- * @returns {void}
- */
-function throwRuleNotFoundError({ pluginName, ruleName }, config) {
-	const ruleId = pluginName === "@" ? ruleName : `${pluginName}/${ruleName}`;
-
-	const errorMessageHeader = `Key "rules": Key "${ruleId}"`;
-
-	let errorMessage = `${errorMessageHeader}: Could not find plugin "${pluginName}" in configuration.`;
-
-	const missingPluginErrorMessage = errorMessage;
-
-	// if the plugin exists then we need to check if the rule exists
-	if (config.plugins && config.plugins[pluginName]) {
-		const replacementRuleName = ruleReplacements.rules[ruleName];
-
-		if (pluginName === "@" && replacementRuleName) {
-			errorMessage = `${errorMessageHeader}: Rule "${ruleName}" was removed and replaced by "${replacementRuleName}".`;
-		} else {
-			errorMessage = `${errorMessageHeader}: Could not find "${ruleName}" in plugin "${pluginName}".`;
-
-			// otherwise, let's see if we can find the rule name elsewhere
-			for (const [otherPluginName, otherPlugin] of Object.entries(
-				config.plugins,
-			)) {
-				if (otherPlugin.rules && otherPlugin.rules[ruleName]) {
-					errorMessage += ` Did you mean "${otherPluginName}/${ruleName}"?`;
-					break;
-				}
-			}
-		}
-
-		// falls through to throw error
-	}
-
-	const error = new TypeError(errorMessage);
-
-	if (errorMessage === missingPluginErrorMessage) {
-		error.messageTemplate = "config-plugin-missing";
-		error.messageData = { pluginName, ruleId };
-	}
-
-	throw error;
-}
-
-/**
- * The error type when a rule has an invalid `meta.schema`.
- */
-class InvalidRuleOptionsSchemaError extends Error {
-	/**
-	 * Creates a new instance.
-	 * @param {string} ruleId Id of the rule that has an invalid `meta.schema`.
-	 * @param {Error} processingError Error caught while processing the `meta.schema`.
-	 */
-	constructor(ruleId, processingError) {
-		super(
-			`Error while processing options validation schema of rule '${ruleId}': ${processingError.message}`,
-			{ cause: processingError },
-		);
-		this.code = "ESLINT_INVALID_RULE_OPTIONS_SCHEMA";
-	}
-}
-
-//-----------------------------------------------------------------------------
-// Exports
-//-----------------------------------------------------------------------------
-
-/**
- * Implements validation functionality for the rules portion of a config.
- */
-class RuleValidator {
-	/**
-	 * Creates a new instance.
-	 */
-	constructor() {
-		/**
-		 * A collection of compiled validators for rules that have already
-		 * been validated.
-		 * @type {WeakMap}
-		 */
-		this.validators = new WeakMap();
-	}
-
-	/**
-	 * Validates all of the rule configurations in a config against each
-	 * rule's schema.
-	 * @param {Object} config The full config to validate. This object must
-	 *      contain both the rules section and the plugins section.
-	 * @returns {void}
-	 * @throws {Error} If a rule's configuration does not match its schema.
-	 */
-	validate(config) {
-		if (!config.rules) {
-			return;
-		}
-
-		for (const [ruleId, ruleOptions] of Object.entries(config.rules)) {
-			// check for edge case
-			if (ruleId === "__proto__") {
-				continue;
-			}
-
-			/*
-			 * If a rule is disabled, we don't do any validation. This allows
-			 * users to safely set any value to 0 or "off" without worrying
-			 * that it will cause a validation error.
-			 *
-			 * Note: ruleOptions is always an array at this point because
-			 * this validation occurs after FlatConfigArray has merged and
-			 * normalized values.
-			 */
-			if (ruleOptions[0] === 0) {
-				continue;
-			}
-
-			const rule = getRuleFromConfig(ruleId, config);
-
-			if (!rule) {
-				throwRuleNotFoundError(parseRuleId(ruleId), config);
-			}
-
-			// Precompile and cache validator the first time
-			if (!this.validators.has(rule)) {
-				try {
-					const schema = getRuleOptionsSchema(rule);
-
-					if (schema) {
-						this.validators.set(rule, ajv.compile(schema));
-					}
-				} catch (err) {
-					throw new InvalidRuleOptionsSchemaError(ruleId, err);
-				}
-			}
-
-			const validateRule = this.validators.get(rule);
-
-			if (validateRule) {
-				validateRule(ruleOptions.slice(1));
-
-				if (validateRule.errors) {
-					throw new Error(
-						`Key "rules": Key "${ruleId}":\n${validateRule.errors
-							.map(error => {
-								if (
-									error.keyword === "additionalProperties" &&
-									error.schema === false &&
-									typeof error.parentSchema?.properties ===
-										"object" &&
-									typeof error.params?.additionalProperty ===
-										"string"
-								) {
-									const expectedProperties = Object.keys(
-										error.parentSchema.properties,
-									).map(property => `"${property}"`);
-
-									return `\tValue ${JSON.stringify(error.data)} ${error.message}.\n\t\tUnexpected property "${error.params.additionalProperty}". Expected properties: ${expectedProperties.join(", ")}.\n`;
-								}
-
-								return `\tValue ${JSON.stringify(error.data)} ${error.message}.\n`;
-							})
-							.join("")}`,
-					);
-				}
-			}
-		}
-	}
-}
-
-exports.RuleValidator = RuleValidator;

package/lib/mcp/mcp-server.js

@@ -1,66 +0,0 @@
-/**
- * @fileoverview MCP Server for handling requests and responses to ESLint.
- * @author Nicholas C. Zakas
- */
-
-"use strict";
-
-//-----------------------------------------------------------------------------
-// Requirements
-//-----------------------------------------------------------------------------
-
-const { McpServer } = require("@modelcontextprotocol/sdk/server/mcp.js");
-const { z } = require("zod");
-const { ESLint } = require("../eslint");
-const pkg = require("../../package.json");
-
-//-----------------------------------------------------------------------------
-// Server
-//-----------------------------------------------------------------------------
-
-const mcpServer = new McpServer({
-	name: "ESLint",
-	version: pkg.version,
-});
-
-// Important: Cursor throws an error when `describe()` is used in the schema.
-const filePathsSchema = {
-	filePaths: z.array(z.string().min(1)).nonempty(),
-};
-
-//-----------------------------------------------------------------------------
-// Tools
-//-----------------------------------------------------------------------------
-
-mcpServer.tool(
-	"lint-files",
-	"Lint files using ESLint. You must provide a list of absolute file paths to the files you want to lint. The absolute file paths should be in the correct format for your operating system (e.g., forward slashes on Unix-like systems, backslashes on Windows).",
-	filePathsSchema,
-	async ({ filePaths }) => {
-		const eslint = new ESLint({
-			// enable lookup from file rather than from cwd
-			flags: ["unstable_config_lookup_from_file"],
-		});
-
-		const results = await eslint.lintFiles(filePaths);
-		const content = results.map(result => ({
-			type: "text",
-			text: JSON.stringify(result),
-		}));
-
-		content.unshift({
-			type: "text",
-			text: "Here are the results of running ESLint on the provided files:",
-		});
-		content.push({
-			type: "text",
-			text: "Do not automatically fix these issues. You must ask the user for confirmation before attempting to fix the issues found.",
-		});
-
-		return {
-			content,
-		};
-	},
-);
-
-module.exports = { mcpServer };

package/lib/shared/types.js

@@ -1,229 +0,0 @@
-/**
- * @fileoverview Define common types for input completion.
- * @author Toru Nagashima <https://github.com/mysticatea>
- */
-"use strict";
-
-/** @type {any} */
-module.exports = {};
-
-/** @typedef {boolean | "off" | "readable" | "readonly" | "writable" | "writeable"} GlobalConf */
-/** @typedef {0 | 1 | 2 | "off" | "warn" | "error"} SeverityConf */
-/** @typedef {SeverityConf | [SeverityConf, ...any[]]} RuleConf */
-
-/**
- * @typedef {Object} EcmaFeatures
- * @property {boolean} [globalReturn] Enabling `return` statements at the top-level.
- * @property {boolean} [jsx] Enabling JSX syntax.
- * @property {boolean} [impliedStrict] Enabling strict mode always.
- */
-
-/**
- * @typedef {Object} ParserOptions
- * @property {EcmaFeatures} [ecmaFeatures] The optional features.
- * @property {3|5|6|7|8|9|10|11|12|13|14|15|16|2015|2016|2017|2018|2019|2020|2021|2022|2023|2024|2025} [ecmaVersion] The ECMAScript version (or revision number).
- * @property {"script"|"module"} [sourceType] The source code type.
- * @property {boolean} [allowReserved] Allowing the use of reserved words as identifiers in ES3.
- */
-
-/**
- * @typedef {Object} ConfigData
- * @property {Record<string, boolean>} [env] The environment settings.
- * @property {string | string[]} [extends] The path to other config files or the package name of shareable configs.
- * @property {Record<string, GlobalConf>} [globals] The global variable settings.
- * @property {string | string[]} [ignorePatterns] The glob patterns that ignore to lint.
- * @property {boolean} [noInlineConfig] The flag that disables directive comments.
- * @property {OverrideConfigData[]} [overrides] The override settings per kind of files.
- * @property {string} [parser] The path to a parser or the package name of a parser.
- * @property {ParserOptions} [parserOptions] The parser options.
- * @property {string[]} [plugins] The plugin specifiers.
- * @property {string} [processor] The processor specifier.
- * @property {boolean} [reportUnusedDisableDirectives] The flag to report unused `eslint-disable` comments.
- * @property {boolean} [root] The root flag.
- * @property {Record<string, RuleConf>} [rules] The rule settings.
- * @property {Object} [settings] The shared settings.
- */
-
-/**
- * @typedef {Object} OverrideConfigData
- * @property {Record<string, boolean>} [env] The environment settings.
- * @property {string | string[]} [excludedFiles] The glob patterns for excluded files.
- * @property {string | string[]} [extends] The path to other config files or the package name of shareable configs.
- * @property {string | string[]} files The glob patterns for target files.
- * @property {Record<string, GlobalConf>} [globals] The global variable settings.
- * @property {boolean} [noInlineConfig] The flag that disables directive comments.
- * @property {OverrideConfigData[]} [overrides] The override settings per kind of files.
- * @property {string} [parser] The path to a parser or the package name of a parser.
- * @property {ParserOptions} [parserOptions] The parser options.
- * @property {string[]} [plugins] The plugin specifiers.
- * @property {string} [processor] The processor specifier.
- * @property {boolean} [reportUnusedDisableDirectives] The flag to report unused `eslint-disable` comments.
- * @property {Record<string, RuleConf>} [rules] The rule settings.
- * @property {Object} [settings] The shared settings.
- */
-
-/**
- * @typedef {Object} ParseResult
- * @property {Object} ast The AST.
- * @property {ScopeManager} [scopeManager] The scope manager of the AST.
- * @property {Record<string, any>} [services] The services that the parser provides.
- * @property {Record<string, string[]>} [visitorKeys] The visitor keys of the AST.
- */
-
-/**
- * @typedef {Object} Parser
- * @property {(text:string, options:ParserOptions) => Object} parse The definition of global variables.
- * @property {(text:string, options:ParserOptions) => ParseResult} [parseForESLint] The parser options that will be enabled under this environment.
- */
-
-/**
- * @typedef {Object} Environment
- * @property {Record<string, GlobalConf>} [globals] The definition of global variables.
- * @property {ParserOptions} [parserOptions] The parser options that will be enabled under this environment.
- */
-
-/**
- * @typedef {Object} LintMessage
- * @property {number|undefined} column The 1-based column number.
- * @property {number} [endColumn] The 1-based column number of the end location.
- * @property {number} [endLine] The 1-based line number of the end location.
- * @property {boolean} [fatal] If `true` then this is a fatal error.
- * @property {{range:[number,number], text:string}} [fix] Information for autofix.
- * @property {number|undefined} line The 1-based line number.
- * @property {string} message The error message.
- * @property {string} [messageId] The ID of the message in the rule's meta.
- * @property {(string|null)} nodeType Type of node
- * @property {string|null} ruleId The ID of the rule which makes this message.
- * @property {0|1|2} severity The severity of this message.
- * @property {Array<{desc?: string, messageId?: string, fix: {range: [number, number], text: string}}>} [suggestions] Information for suggestions.
- */
-
-/**
- * @typedef {Object} SuppressedLintMessage
- * @property {number|undefined} column The 1-based column number.
- * @property {number} [endColumn] The 1-based column number of the end location.
- * @property {number} [endLine] The 1-based line number of the end location.
- * @property {boolean} [fatal] If `true` then this is a fatal error.
- * @property {{range:[number,number], text:string}} [fix] Information for autofix.
- * @property {number|undefined} line The 1-based line number.
- * @property {string} message The error message.
- * @property {string} [messageId] The ID of the message in the rule's meta.
- * @property {(string|null)} nodeType Type of node
- * @property {string|null} ruleId The ID of the rule which makes this message.
- * @property {0|1|2} severity The severity of this message.
- * @property {Array<{kind: string, justification: string}>} suppressions The suppression info.
- * @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.
- * @property {string} [messageId] Id referencing a message for the description.
- * @property {{ text: string, range: number[] }} fix fix result info
- */
-
-/**
- * @typedef {Object} Processor
- * @property {(text:string, filename:string) => Array<string | { text:string, filename:string }>} [preprocess] The function to extract code blocks.
- * @property {(messagesList:LintMessage[][], filename:string) => LintMessage[]} [postprocess] The function to merge messages.
- * @property {boolean} [supportsAutofix] If `true` then it means the processor supports autofix.
- */
-
-/**
- * @typedef {Object} RuleMetaDocs
- * @property {string} description The description of the rule.
- * @property {boolean} recommended If `true` then the rule is included in `eslint:recommended` preset.
- * @property {string} url The URL of the rule documentation.
- */
-
-/**
- * @typedef {Object} DeprecatedInfo
- * @property {string} [message] General message presented to the user
- * @property {string} [url] URL to more information about this deprecation in general
- * @property {ReplacedByInfo[]} [replacedBy] Potential replacements for the rule
- * @property {string} [deprecatedSince] Version since the rule is deprecated
- * @property {?string} [availableUntil] Version until it is available or null if indefinite
- */
-
-/**
- * @typedef {Object} ReplacedByInfo
- * @property {string} [message] General message presented to the user
- * @property {string} [url] URL to more information about this replacement in general
- * @property {{ name?: string, url?: string }} [plugin] Use "eslint" for a core rule. Omit if the rule is in the same plugin.
- * @property {{ name?: string, url?: string }} [rule] Name and information of the replacement rule
- */
-
-/**
- * Information of deprecated rules.
- * @typedef {Object} DeprecatedRuleInfo
- * @property {string} ruleId The rule ID.
- * @property {string[]} replacedBy The rule IDs that replace this deprecated rule.
- * @property {DeprecatedInfo} [info] The raw deprecated info provided by rule. Unset if `deprecated` is a boolean.
- */
-
-/**
- * A linting result.
- * @typedef {Object} LintResult
- * @property {string} filePath The path to the file that was linted.
- * @property {LintMessage[]} messages All of the messages for the result.
- * @property {SuppressedLintMessage[]} suppressedMessages All of the suppressed messages for the result.
- * @property {number} errorCount Number of errors for the result.
- * @property {number} fatalErrorCount Number of fatal errors for the result.
- * @property {number} warningCount Number of warnings for the result.
- * @property {number} fixableErrorCount Number of fixable errors for the result.
- * @property {number} fixableWarningCount Number of fixable warnings for the result.
- * @property {Stats} [stats] The performance statistics collected with the `stats` flag.
- * @property {string} [source] The source code of the file that was linted.
- * @property {string} [output] The source code of the file that was linted, with as many fixes applied as possible.
- * @property {DeprecatedRuleInfo[]} usedDeprecatedRules The list of used deprecated rules.
- */
-
-/**
- * Performance statistics
- * @typedef {Object} Stats
- * @property {number} fixPasses The number of times ESLint has applied at least one fix after linting.
- * @property {Times} times The times spent on (parsing, fixing, linting) a file.
- */
-
-/**
- * Performance Times for each ESLint pass
- * @typedef {Object} Times
- * @property {TimePass[]} passes Time passes
- */
-
-/**
- * @typedef {Object} TimePass
- * @property {ParseTime} parse The parse object containing all parse time information.
- * @property {Record<string, RuleTime>} [rules] The rules object containing all lint time information for each rule.
- * @property {FixTime} fix The parse object containing all fix time information.
- * @property {number} total The total time that is spent on (parsing, fixing, linting) a file.
- */
-/**
- * @typedef {Object} ParseTime
- * @property {number} total The total time that is spent when parsing a file.
- */
-/**
- * @typedef {Object} RuleTime
- * @property {number} total The total time that is spent on a rule.
- */
-/**
- * @typedef {Object} FixTime
- * @property {number} total The total time that is spent on applying fixes to the code.
- */
-
-/**
- * Information provided when the maximum warning threshold is exceeded.
- * @typedef {Object} MaxWarningsExceeded
- * @property {number} maxWarnings Number of warnings to trigger nonzero exit code.
- * @property {number} foundWarnings Number of warnings found while linting.
- */
-
-/**
- * Metadata about results for formatters.
- * @typedef {Object} ResultsMeta
- * @property {MaxWarningsExceeded} [maxWarningsExceeded] Present if the maxWarnings threshold was exceeded.
- */