eslint 10.0.0-alpha.1 → 10.0.0-rc.0

package/README.md

@@ -340,10 +340,10 @@ The following companies, organizations, and individuals support ESLint's ongoing
 to get your logo on our READMEs and [website](https://eslint.org/sponsors).
 
 <h3>Platinum Sponsors</h3>
-<p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="128"></a></p><h3>Gold Sponsors</h3>
+<p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a></p><h3>Gold Sponsors</h3>
 <p><a href="https://qlty.sh/"><img src="https://images.opencollective.com/qltysh/33d157d/logo.png" alt="Qlty Software" height="96"></a> <a href="https://shopify.engineering/"><img src="https://avatars.githubusercontent.com/u/8085" alt="Shopify" height="96"></a></p><h3>Silver Sponsors</h3>
 <p><a href="https://vite.dev/"><img src="https://images.opencollective.com/vite/e6d15e1/logo.png" alt="Vite" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/2d6c3b6/logo.png" alt="Liftoff" height="64"></a> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301" alt="American Express" height="64"></a> <a href="https://stackblitz.com"><img src="https://avatars.githubusercontent.com/u/28635252" alt="StackBlitz" height="64"></a></p><h3>Bronze Sponsors</h3>
-<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" height="32"></a> <a href="https://syntax.fm"><img src="https://github.com/syntaxfm.png" alt="Syntax" height="32"></a> <a href="https://www.n-ix.com/"><img src="https://images.opencollective.com/n-ix-ltd/575a7a5/logo.png" alt="N-iX Ltd" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104" alt="Nx" height="32"></a> <a href="https://opensource.mercedes-benz.com/"><img src="https://avatars.githubusercontent.com/u/34240465" alt="Mercedes-Benz Group" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774" alt="HeroCoders" height="32"></a> <a href="https://www.lambdatest.com"><img src="https://avatars.githubusercontent.com/u/171592363" alt="LambdaTest" height="32"></a></p>
+<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" height="32"></a> <a href="https://www.crawljobs.com/"><img src="https://images.opencollective.com/crawljobs-poland/fa43a17/logo.png" alt="CrawlJobs" height="32"></a> <a href="https://syntax.fm"><img src="https://github.com/syntaxfm.png" alt="Syntax" height="32"></a> <a href="https://www.n-ix.com/"><img src="https://images.opencollective.com/n-ix-ltd/575a7a5/logo.png" alt="N-iX Ltd" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104" alt="Nx" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774" alt="HeroCoders" height="32"></a> <a href="https://www.lambdatest.com"><img src="https://avatars.githubusercontent.com/u/171592363" alt="LambdaTest" height="32"></a></p>
 <h3>Technology Sponsors</h3>
 Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.
 <p><a href="https://netlify.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/netlify-icon.svg" alt="Netlify" height="32"></a> <a href="https://algolia.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/algolia-icon.svg" alt="Algolia" height="32"></a> <a href="https://1password.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/1password-icon.svg" alt="1Password" height="32"></a></p>

package/lib/api.js

@@ -19,8 +19,8 @@ const { SourceCode } = require("./languages/js/source-code");
 //-----------------------------------------------------------------------------
 
 /**
- * Loads the correct ESLint constructor given the options.
- * @returns {Promise<ESLint>} The ESLint constructor
+ * Loads the correct `ESLint` constructor.
+ * @returns {Promise<ESLint>} The ESLint constructor.
  */
 async function loadESLint() {
 	return ESLint;

package/lib/cli-engine/formatters/stylish.js

@@ -4,14 +4,30 @@
  */
 "use strict";
 
-const chalk = require("chalk"),
-	util = require("node:util"),
+const util = require("node:util"),
 	table = require("../../shared/text-table");
 
 //------------------------------------------------------------------------------
 // Helpers
 //------------------------------------------------------------------------------
 
+/**
+ * Returns a styling function based on the color option.
+ * @param {boolean|undefined} color Indicates whether to use colors.
+ * @returns {Function} A function that styles text.
+ */
+function getStyleText(color) {
+	if (typeof color === "undefined") {
+		return (format, text) =>
+			util.styleText(format, text, { validateStream: true });
+	}
+	if (color) {
+		return (format, text) =>
+			util.styleText(format, text, { validateStream: false });
+	}
+	return (_, text) => text;
+}
+
 /**
  * Given a word and a count, append an s if count is not one.
  * @param {string} word A word in its singular form.
@@ -26,7 +42,9 @@ function pluralize(word, count) {
 // Public Interface
 //------------------------------------------------------------------------------
 
-module.exports = function (results) {
+module.exports = function (results, data) {
+	const styleText = getStyleText(data?.color);
+
 	let output = "\n",
 		errorCount = 0,
 		warningCount = 0,
@@ -46,17 +64,17 @@ module.exports = function (results) {
 		fixableErrorCount += result.fixableErrorCount;
 		fixableWarningCount += result.fixableWarningCount;
 
-		output += `${chalk.underline(result.filePath)}\n`;
+		output += `${styleText("underline", result.filePath)}\n`;
 
 		output += `${table(
 			messages.map(message => {
 				let messageType;
 
 				if (message.fatal || message.severity === 2) {
-					messageType = chalk.red("error");
+					messageType = styleText("red", "error");
 					summaryColor = "red";
 				} else {
-					messageType = chalk.yellow("warning");
+					messageType = styleText("yellow", "warning");
 				}
 
 				return [
@@ -65,7 +83,7 @@ module.exports = function (results) {
 					String(message.column || 0),
 					messageType,
 					message.message.replace(/([^ ])\.$/u, "$1"),
-					chalk.dim(message.ruleId || ""),
+					message.ruleId ? styleText("dim", message.ruleId) : "",
 				];
 			}),
 			{
@@ -78,7 +96,7 @@ module.exports = function (results) {
 			.split("\n")
 			.map(el =>
 				el.replace(/(\d+)\s+(\d+)/u, (m, p1, p2) =>
-					chalk.dim(`${p1}:${p2}`),
+					styleText("dim", `${p1}:${p2}`),
 				),
 			)
 			.join("\n")}\n\n`;
@@ -86,37 +104,50 @@ module.exports = function (results) {
 
 	const total = errorCount + warningCount;
 
+	/*
+	 * We can't use a single `styleText` call like `styleText([summaryColor, "bold"], text)` here.
+	 * This is a bug in `util.styleText` in Node.js versions earlier than v22.15.0 (https://github.com/nodejs/node/issues/56717).
+	 * As a workaround, we use nested `styleText` calls.
+	 */
 	if (total > 0) {
-		output += chalk[summaryColor].bold(
-			[
-				"\u2716 ",
-				total,
-				pluralize(" problem", total),
-				" (",
-				errorCount,
-				pluralize(" error", errorCount),
-				", ",
-				warningCount,
-				pluralize(" warning", warningCount),
-				")\n",
-			].join(""),
-		);
-
-		if (fixableErrorCount > 0 || fixableWarningCount > 0) {
-			output += chalk[summaryColor].bold(
+		output += `${styleText(
+			summaryColor,
+			styleText(
+				"bold",
 				[
-					"  ",
-					fixableErrorCount,
-					pluralize(" error", fixableErrorCount),
-					" and ",
-					fixableWarningCount,
-					pluralize(" warning", fixableWarningCount),
-					" potentially fixable with the `--fix` option.\n",
+					"\u2716 ",
+					total,
+					pluralize(" problem", total),
+					" (",
+					errorCount,
+					pluralize(" error", errorCount),
+					", ",
+					warningCount,
+					pluralize(" warning", warningCount),
+					")",
 				].join(""),
-			);
+			),
+		)}\n`;
+
+		if (fixableErrorCount > 0 || fixableWarningCount > 0) {
+			output += `${styleText(
+				summaryColor,
+				styleText(
+					"bold",
+					[
+						"  ",
+						fixableErrorCount,
+						pluralize(" error", fixableErrorCount),
+						" and ",
+						fixableWarningCount,
+						pluralize(" warning", fixableWarningCount),
+						" potentially fixable with the `--fix` option.",
+					].join(""),
+				),
+			)}\n`;
 		}
 	}
 
 	// Resets output color, for prevent change on top level
-	return total > 0 ? chalk.reset(output) : "";
+	return total > 0 ? styleText("reset", output) : "";
 };

package/lib/cli.js

@@ -454,14 +454,24 @@ const cli = {
 		const tooManyWarnings =
 			options.maxWarnings >= 0 &&
 			resultCounts.warningCount > options.maxWarnings;
-		const resultsMeta = tooManyWarnings
-			? {
-					maxWarningsExceeded: {
-						maxWarnings: options.maxWarnings,
-						foundWarnings: resultCounts.warningCount,
-					},
-				}
-			: {};
+		const resultsMeta = /** @type {ResultsMeta} */ ({});
+
+		/*
+		 * `--color` was set, `options.color` is `true`.
+		 * `--no-color` was set, `options.color` is `false`.
+		 * Neither option was provided, `options.color` is omitted, so `undefined`.
+		 */
+		if (options.color !== void 0) {
+			debug(`Color setting for output: ${options.color}`);
+			resultsMeta.color = options.color;
+		}
+
+		if (tooManyWarnings) {
+			resultsMeta.maxWarningsExceeded = {
+				maxWarnings: options.maxWarnings,
+				foundWarnings: resultCounts.warningCount,
+			};
+		}
 
 		if (
 			await printResults(

package/lib/eslint/eslint.js

@@ -1207,6 +1207,7 @@ class ESLint {
 		const { cwd } = privateMembers.get(this).options;
 
 		let formatterPath;
+		let isBuiltInFormatter = false;
 
 		// if there's a slash, then it's a file (TODO: this check seems dubious for scoped npm packages)
 		if (!namespace && normalizedFormatName.includes("/")) {
@@ -1228,6 +1229,7 @@ class ESLint {
 					"formatters",
 					`${normalizedFormatName}.js`,
 				);
+				isBuiltInFormatter = true;
 			}
 		}
 
@@ -1237,7 +1239,7 @@ class ESLint {
 			formatter = (await import(pathToFileURL(formatterPath))).default;
 		} catch (ex) {
 			// check for formatters that have been removed
-			if (removedFormatters.has(name)) {
+			if (isBuiltInFormatter && removedFormatters.has(name)) {
 				ex.message = `The ${name} formatter is no longer part of core ESLint. Install it manually with \`npm install -D eslint-formatter-${name}\``;
 			} else {
 				ex.message = `There was a problem loading formatter: ${formatterPath}\nError: ${ex.message}`;
@@ -1344,7 +1346,7 @@ class ESLint {
 
 /**
  * Returns whether flat config should be used.
- * @returns {Promise<boolean>} Whether flat config should be used.
+ * @returns {Promise<true>} Whether flat config should be used.
  */
 async function shouldUseFlatConfig() {
 	return true;

package/lib/languages/js/index.js

@@ -55,6 +55,7 @@ function analyzeScope(ast, languageOptions, visitorKeys) {
 		sourceType: languageOptions.sourceType || "script",
 		childVisitorKeys: visitorKeys || evk.KEYS,
 		fallback: evk.getKeys,
+		jsx: ecmaFeatures.jsx,
 	});
 }
 
@@ -248,7 +249,6 @@ module.exports = {
 			{
 				loc: true,
 				range: true,
-				raw: true,
 				tokens: true,
 				comment: true,
 				eslintVisitorKeys: true,

package/lib/linter/linter.js

@@ -54,10 +54,7 @@ const { FileReport, updateLocationInformation } = require("./file-report");
 
 /** @import { Language, LanguageOptions, RuleConfig, RuleDefinition } from "@eslint/core" */
 
-/** @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.Config} ConfigObject */
 /** @typedef {import("../types").Linter.LanguageOptions} JSLanguageOptions */
 /** @typedef {import("../types").Linter.LintMessage} LintMessage */
 /** @typedef {import("../types").Linter.Parser} Parser */
@@ -87,7 +84,7 @@ const { FileReport, updateLocationInformation } = require("./file-report");
 /**
  * The private data for `Linter` instance.
  * @typedef {Object} LinterInternalSlots
- * @property {ConfigArray|null} lastConfigArray The `ConfigArray` instance that the last `verify()` call used.
+ * @property {FlatConfigArray|null} lastConfigArray The `ConfigArray` instance that the last `verify()` call used.
  * @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 {{ passes: TimePass[]; }} times The times spent on applying a rule to a file (see `stats` option).
@@ -349,7 +346,7 @@ function normalizeFilename(filename) {
  * Normalizes the possible options for `linter.verify` and `linter.verifyAndFix` to a
  * consistent shape.
  * @param {VerifyOptions} providedOptions Options
- * @param {Config|ConfigData} config Config.
+ * @param {Config} config Config.
  * @returns {Required<VerifyOptions> & InternalOptions} Normalized options
  */
 function normalizeVerifyOptions(providedOptions, config) {
@@ -473,6 +470,7 @@ function analyzeScope(ast, languageOptions, visitorKeys) {
 		sourceType: languageOptions.sourceType || "script",
 		childVisitorKeys: visitorKeys || evk.KEYS,
 		fallback: Traverser.getKeys,
+		jsx: ecmaFeatures.jsx,
 	});
 }
 
@@ -822,7 +820,7 @@ class Linter {
 	/**
 	 * Verifies the text against the rules specified by the second argument.
 	 * @param {string|SourceCode} textOrSourceCode The text to parse or a SourceCode object.
-	 * @param {ConfigData|ConfigArray} config An ESLintConfig instance to configure everything.
+	 * @param {ConfigObject|ConfigObject[]} config The ESLint config object or array to use.
 	 * @param {(string|(VerifyOptions&ProcessorOptions))} [filenameOrOptions] The optional filename of the file being checked.
 	 *      If this is not set, the filename will default to '<input>' in the rule context. If
 	 *      an object, then it has "filename", "allowInlineConfig", and some properties.
@@ -1466,12 +1464,12 @@ class Linter {
 	 * Performs multiple autofix passes over the text until as many fixes as possible
 	 * have been applied.
 	 * @param {string} text The source text to apply fixes to.
-	 * @param {ConfigData|ConfigArray|FlatConfigArray} config The ESLint config object to use.
-	 * @param {VerifyOptions&ProcessorOptions&FixOptions} options The ESLint options object to use.
+	 * @param {ConfigObject|ConfigObject[]} config The ESLint config object or array to use.
+	 * @param {string|(VerifyOptions&ProcessorOptions&FixOptions)} [filenameOrOptions] The filename or ESLint options object to use.
 	 * @returns {{fixed:boolean,messages:LintMessage[],output:string}} The result of the fix operation as returned from the
 	 *      SourceCodeFixer.
 	 */
-	verifyAndFix(text, config, options) {
+	verifyAndFix(text, config, filenameOrOptions) {
 		let messages,
 			fixedResult,
 			fixed = false,
@@ -1479,10 +1477,14 @@ class Linter {
 			currentText = text,
 			secondPreviousText,
 			previousText;
+		const options =
+			typeof filenameOrOptions === "string"
+				? { filename: filenameOrOptions }
+				: filenameOrOptions || {};
 		const debugTextDescription =
-			(options && options.filename) || `${text.slice(0, 10)}...`;
+			options.filename || `${text.slice(0, 10)}...`;
 		const shouldFix =
-			options && typeof options.fix !== "undefined" ? options.fix : true;
+			typeof options.fix !== "undefined" ? options.fix : true;
 		const stats = options?.stats;
 
 		const slots = internalSlotsMap.get(this);
@@ -1574,7 +1576,7 @@ class Linter {
 					`Circular fixes detected after pass ${passNumber}. Exiting fix loop.`,
 				);
 				slots.warningService.emitCircularFixesWarning(
-					options?.filename ?? "text",
+					options.filename ?? "text",
 				);
 				break;
 			}
@@ -1609,13 +1611,4 @@ class Linter {
 
 module.exports = {
 	Linter,
-
-	/**
-	 * Get the internal slots of a given Linter instance for tests.
-	 * @param {Linter} instance The Linter instance to get.
-	 * @returns {LinterInternalSlots} The internal slots.
-	 */
-	getLinterInternalSlots(instance) {
-		return internalSlotsMap.get(instance);
-	},
 };