eslint 10.0.0-alpha.0 → 10.0.0-beta.0

package/README.md

@@ -343,7 +343,7 @@ to get your logo on our READMEs and [website](https://eslint.org/sponsors).
 <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://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://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,
 	});
 }
 

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

@@ -8,8 +8,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const { isCommentToken } = require("@eslint-community/eslint-utils"),
-	TokenStore = require("./token-store"),
+const TokenStore = require("./token-store"),
 	astUtils = require("../../../shared/ast-utils"),
 	Traverser = require("../../../shared/traverser"),
 	globals = require("../../../../conf/globals"),
@@ -90,21 +89,6 @@ function getGlobalsForEcmaVersion(ecmaVersion) {
 	}
 }
 
-/**
- * Check to see if its a ES6 export declaration.
- * @param {ASTNode} astNode An AST node.
- * @returns {boolean} whether the given node represents an export declaration.
- * @private
- */
-function looksLikeExport(astNode) {
-	return (
-		astNode.type === "ExportDefaultDeclaration" ||
-		astNode.type === "ExportNamedDeclaration" ||
-		astNode.type === "ExportAllDeclaration" ||
-		astNode.type === "ExportSpecifier"
-	);
-}
-
 /**
  * Merges two sorted lists into a larger sorted list in O(n) time.
  * @param {Token[]} tokens The list of tokens.
@@ -179,56 +163,6 @@ function nodesOrTokensOverlap(first, second) {
 	);
 }
 
-/**
- * Determines if two nodes or tokens have at least one whitespace character
- * between them. Order does not matter. Returns false if the given nodes or
- * tokens overlap.
- * @param {SourceCode} sourceCode The source code object.
- * @param {ASTNode|Token} first The first node or token to check between.
- * @param {ASTNode|Token} second The second node or token to check between.
- * @param {boolean} checkInsideOfJSXText If `true` is present, check inside of JSXText tokens for backward compatibility.
- * @returns {boolean} True if there is a whitespace character between
- * any of the tokens found between the two given nodes or tokens.
- * @public
- */
-function isSpaceBetween(sourceCode, first, second, checkInsideOfJSXText) {
-	if (nodesOrTokensOverlap(first, second)) {
-		return false;
-	}
-
-	const [startingNodeOrToken, endingNodeOrToken] =
-		first.range[1] <= second.range[0] ? [first, second] : [second, first];
-	const firstToken =
-		sourceCode.getLastToken(startingNodeOrToken) || startingNodeOrToken;
-	const finalToken =
-		sourceCode.getFirstToken(endingNodeOrToken) || endingNodeOrToken;
-	let currentToken = firstToken;
-
-	while (currentToken !== finalToken) {
-		const nextToken = sourceCode.getTokenAfter(currentToken, {
-			includeComments: true,
-		});
-
-		if (
-			currentToken.range[1] !== nextToken.range[0] ||
-			/*
-			 * For backward compatibility, check spaces in JSXText.
-			 * https://github.com/eslint/eslint/issues/12614
-			 */
-			(checkInsideOfJSXText &&
-				nextToken !== finalToken &&
-				nextToken.type === "JSXText" &&
-				/\s/u.test(nextToken.value))
-		) {
-			return true;
-		}
-
-		currentToken = nextToken;
-	}
-
-	return false;
-}
-
 /**
  * Performs binary search to find the line number containing a given character index.
  * Returns the lower bound - the index of the first element greater than the target.
@@ -529,87 +463,6 @@ class SourceCode extends TokenStore {
 		return this.ast.comments;
 	}
 
-	/**
-	 * Retrieves the JSDoc comment for a given node.
-	 * @param {ASTNode} node The AST node to get the comment for.
-	 * @returns {Token|null} The Block comment token containing the JSDoc comment
-	 *      for the given node or null if not found.
-	 * @public
-	 * @deprecated
-	 */
-	getJSDocComment(node) {
-		/**
-		 * Checks for the presence of a JSDoc comment for the given node and returns it.
-		 * @param {ASTNode} astNode The AST node to get the comment for.
-		 * @returns {Token|null} The Block comment token containing the JSDoc comment
-		 *      for the given node or null if not found.
-		 * @private
-		 */
-		const findJSDocComment = astNode => {
-			const tokenBefore = this.getTokenBefore(astNode, {
-				includeComments: true,
-			});
-
-			if (
-				tokenBefore &&
-				isCommentToken(tokenBefore) &&
-				tokenBefore.type === "Block" &&
-				tokenBefore.value.charAt(0) === "*" &&
-				astNode.loc.start.line - tokenBefore.loc.end.line <= 1
-			) {
-				return tokenBefore;
-			}
-
-			return null;
-		};
-		let parent = node.parent;
-
-		switch (node.type) {
-			case "ClassDeclaration":
-			case "FunctionDeclaration":
-				return findJSDocComment(
-					looksLikeExport(parent) ? parent : node,
-				);
-
-			case "ClassExpression":
-				return findJSDocComment(parent.parent);
-
-			case "ArrowFunctionExpression":
-			case "FunctionExpression":
-				if (
-					parent.type !== "CallExpression" &&
-					parent.type !== "NewExpression"
-				) {
-					while (
-						!this.getCommentsBefore(parent).length &&
-						!/Function/u.test(parent.type) &&
-						parent.type !== "MethodDefinition" &&
-						parent.type !== "Property"
-					) {
-						parent = parent.parent;
-
-						if (!parent) {
-							break;
-						}
-					}
-
-					if (
-						parent &&
-						parent.type !== "FunctionDeclaration" &&
-						parent.type !== "Program"
-					) {
-						return findJSDocComment(parent);
-					}
-				}
-
-				return findJSDocComment(node);
-
-			// falls through
-			default:
-				return null;
-		}
-	}
-
 	/**
 	 * Gets the deepest node containing a range index.
 	 * @param {number} index Range index of the desired node.
@@ -649,24 +502,33 @@ class SourceCode extends TokenStore {
 	 * @public
 	 */
 	isSpaceBetween(first, second) {
-		return isSpaceBetween(this, first, second, false);
-	}
+		if (nodesOrTokensOverlap(first, second)) {
+			return false;
+		}
 
-	/**
-	 * Determines if two nodes or tokens have at least one whitespace character
-	 * between them. Order does not matter. Returns false if the given nodes or
-	 * tokens overlap.
-	 * For backward compatibility, this method returns true if there are
-	 * `JSXText` tokens that contain whitespaces between the two.
-	 * @param {ASTNode|Token} first The first node or token to check between.
-	 * @param {ASTNode|Token} second The second node or token to check between.
-	 * @returns {boolean} True if there is a whitespace character between
-	 * any of the tokens found between the two given nodes or tokens.
-	 * @deprecated in favor of isSpaceBetween().
-	 * @public
-	 */
-	isSpaceBetweenTokens(first, second) {
-		return isSpaceBetween(this, first, second, true);
+		const [startingNodeOrToken, endingNodeOrToken] =
+			first.range[1] <= second.range[0]
+				? [first, second]
+				: [second, first];
+		const firstToken =
+			this.getLastToken(startingNodeOrToken) || startingNodeOrToken;
+		const finalToken =
+			this.getFirstToken(endingNodeOrToken) || endingNodeOrToken;
+		let currentToken = firstToken;
+
+		while (currentToken !== finalToken) {
+			const nextToken = this.getTokenAfter(currentToken, {
+				includeComments: true,
+			});
+
+			if (currentToken.range[1] !== nextToken.range[0]) {
+				return true;
+			}
+
+			currentToken = nextToken;
+		}
+
+		return false;
 	}
 
 	/**

package/lib/languages/js/source-code/token-store/index.js

@@ -444,32 +444,6 @@ module.exports = class TokenStore {
 		).getOneToken();
 	}
 
-	/**
-	 * Gets the token that precedes a given node or token in the token stream.
-	 * This is defined for backward compatibility. Use `includeComments` option instead.
-	 * TODO: We have a plan to remove this in a future major version.
-	 * @param {ASTNode|Token|Comment} node The AST node or token.
-	 * @param {number} [skip=0] A number of tokens to skip.
-	 * @returns {Token|null} An object representing the token.
-	 * @deprecated
-	 */
-	getTokenOrCommentBefore(node, skip) {
-		return this.getTokenBefore(node, { includeComments: true, skip });
-	}
-
-	/**
-	 * Gets the token that follows a given node or token in the token stream.
-	 * This is defined for backward compatibility. Use `includeComments` option instead.
-	 * TODO: We have a plan to remove this in a future major version.
-	 * @param {ASTNode|Token|Comment} node The AST node or token.
-	 * @param {number} [skip=0] A number of tokens to skip.
-	 * @returns {Token|null} An object representing the token.
-	 * @deprecated
-	 */
-	getTokenOrCommentAfter(node, skip) {
-		return this.getTokenAfter(node, { includeComments: true, skip });
-	}
-
 	//--------------------------------------------------------------------------
 	// Gets multiple tokens.
 	//--------------------------------------------------------------------------

package/lib/linter/linter.js

@@ -473,6 +473,7 @@ function analyzeScope(ast, languageOptions, visitorKeys) {
 		sourceType: languageOptions.sourceType || "script",
 		childVisitorKeys: visitorKeys || evk.KEYS,
 		fallback: Traverser.getKeys,
+		jsx: ecmaFeatures.jsx,
 	});
 }