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

package/lib/rules/require-yield.js

@@ -5,6 +5,12 @@
 
 "use strict";
 
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const astUtils = require("./utils/ast-utils");
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -29,6 +35,7 @@ module.exports = {
 
 	create(context) {
 		const stack = [];
+		const sourceCode = context.sourceCode;
 
 		/**
 		 * If the node is a generator function, start counting `yield` keywords.
@@ -55,7 +62,10 @@ module.exports = {
 			const countYield = stack.pop();
 
 			if (countYield === 0 && node.body.body.length > 0) {
-				context.report({ node, messageId: "missingYield" });
+				context.report({
+					loc: astUtils.getFunctionHeadLoc(node, sourceCode),
+					messageId: "missingYield",
+				});
 			}
 		}
 

package/lib/rules/rest-spread-spacing.js

@@ -74,10 +74,7 @@ module.exports = {
 		function checkWhiteSpace(node) {
 			const operator = sourceCode.getFirstToken(node),
 				nextToken = sourceCode.getTokenAfter(operator),
-				hasWhitespace = sourceCode.isSpaceBetweenTokens(
-					operator,
-					nextToken,
-				);
+				hasWhitespace = sourceCode.isSpaceBetween(operator, nextToken);
 			let type;
 
 			switch (node.type) {

package/lib/rules/semi-spacing.js

@@ -95,7 +95,7 @@ module.exports = {
 			return (
 				tokenBefore &&
 				astUtils.isTokenOnSameLine(tokenBefore, token) &&
-				sourceCode.isSpaceBetweenTokens(tokenBefore, token)
+				sourceCode.isSpaceBetween(tokenBefore, token)
 			);
 		}
 
@@ -110,7 +110,7 @@ module.exports = {
 			return (
 				tokenAfter &&
 				astUtils.isTokenOnSameLine(token, tokenAfter) &&
-				sourceCode.isSpaceBetweenTokens(token, tokenAfter)
+				sourceCode.isSpaceBetween(token, tokenAfter)
 			);
 		}
 

package/lib/rules/space-before-blocks.js

@@ -164,7 +164,7 @@ module.exports = {
 				!isConflicted(precedingToken, node) &&
 				astUtils.isTokenOnSameLine(precedingToken, node)
 			) {
-				const hasSpace = sourceCode.isSpaceBetweenTokens(
+				const hasSpace = sourceCode.isSpaceBetween(
 					precedingToken,
 					node,
 				);

package/lib/rules/space-before-function-paren.js

@@ -155,10 +155,7 @@ module.exports = {
 				astUtils.isOpeningParenToken,
 			);
 			const leftToken = sourceCode.getTokenBefore(rightToken);
-			const hasSpacing = sourceCode.isSpaceBetweenTokens(
-				leftToken,
-				rightToken,
-			);
+			const hasSpacing = sourceCode.isSpaceBetween(leftToken, rightToken);
 
 			if (hasSpacing && functionConfig === "never") {
 				context.report({

package/lib/rules/space-in-parens.js

@@ -153,7 +153,7 @@ module.exports = {
 		 */
 		function openerMissingSpace(openingParenToken, tokenAfterOpeningParen) {
 			if (
-				sourceCode.isSpaceBetweenTokens(
+				sourceCode.isSpaceBetween(
 					openingParenToken,
 					tokenAfterOpeningParen,
 				)
@@ -195,7 +195,7 @@ module.exports = {
 			}
 
 			if (
-				!sourceCode.isSpaceBetweenTokens(
+				!sourceCode.isSpaceBetween(
 					openingParenToken,
 					tokenAfterOpeningParen,
 				)
@@ -220,7 +220,7 @@ module.exports = {
 			closingParenToken,
 		) {
 			if (
-				sourceCode.isSpaceBetweenTokens(
+				sourceCode.isSpaceBetween(
 					tokenBeforeClosingParen,
 					closingParenToken,
 				)
@@ -261,7 +261,7 @@ module.exports = {
 			}
 
 			if (
-				!sourceCode.isSpaceBetweenTokens(
+				!sourceCode.isSpaceBetween(
 					tokenBeforeClosingParen,
 					closingParenToken,
 				)

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

@@ -87,8 +87,8 @@ module.exports = {
 			const next = sourceCode.getTokenAfter(operator);
 
 			if (
-				!sourceCode.isSpaceBetweenTokens(prev, operator) ||
-				!sourceCode.isSpaceBetweenTokens(operator, next)
+				!sourceCode.isSpaceBetween(prev, operator) ||
+				!sourceCode.isSpaceBetween(operator, next)
 			) {
 				return operator;
 			}
@@ -238,11 +238,8 @@ module.exports = {
 				const rightToken = sourceCode.getTokenAfter(operatorToken);
 
 				if (
-					!sourceCode.isSpaceBetweenTokens(
-						leftToken,
-						operatorToken,
-					) ||
-					!sourceCode.isSpaceBetweenTokens(operatorToken, rightToken)
+					!sourceCode.isSpaceBetween(leftToken, operatorToken) ||
+					!sourceCode.isSpaceBetween(operatorToken, rightToken)
 				) {
 					report(node, operatorToken);
 				}

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

@@ -84,7 +84,7 @@ module.exports = {
 			return (
 				astUtils.isClosingBraceToken(right) ||
 				!astUtils.isTokenOnSameLine(left, right) ||
-				sourceCode.isSpaceBetweenTokens(left, right) === expected
+				sourceCode.isSpaceBetween(left, right) === expected
 			);
 		}
 

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

@@ -66,7 +66,7 @@ module.exports = {
 		function checkSpacing(node) {
 			const tagToken = sourceCode.getTokenBefore(node.quasi);
 			const literalToken = sourceCode.getFirstToken(node.quasi);
-			const hasWhitespace = sourceCode.isSpaceBetweenTokens(
+			const hasWhitespace = sourceCode.isSpaceBetween(
 				tagToken,
 				literalToken,
 			);

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

@@ -544,28 +544,6 @@ function negate(f) {
 	return token => !f(token);
 }
 
-/**
- * Checks whether or not a node has a `@this` tag in its comments.
- * @param {ASTNode} node A node to check.
- * @param {SourceCode} sourceCode A SourceCode instance to get comments.
- * @returns {boolean} Whether or not the node has a `@this` tag in its comments.
- */
-function hasJSDocThisTag(node, sourceCode) {
-	const jsdocComment = sourceCode.getJSDocComment(node);
-
-	if (jsdocComment && thisTagPattern.test(jsdocComment.value)) {
-		return true;
-	}
-
-	// Checks `@this` in its leading comments for callbacks,
-	// because callbacks don't have its JSDoc comment.
-	// e.g.
-	//     sinon.test(/* @this sinon.Sandbox */function() { this.spy(); });
-	return sourceCode
-		.getCommentsBefore(node)
-		.some(comment => thisTagPattern.test(comment.value));
-}
-
 /**
  * Determines if a node is surrounded by parentheses.
  * @param {SourceCode} sourceCode The ESLint source code object
@@ -725,6 +703,123 @@ function isKeywordToken(token) {
 	return token.type === "Keyword";
 }
 
+/**
+ * Checks whether the given node represents an ES6 export declaration.
+ * @param {ASTNode} node A node to check.
+ * @returns {boolean} `true` if the node is an export declaration.
+ * @private
+ */
+function isExportDeclaration(node) {
+	return (
+		node.type === "ExportDefaultDeclaration" ||
+		node.type === "ExportNamedDeclaration" ||
+		node.type === "ExportAllDeclaration"
+	);
+}
+
+/**
+ * Checks for the presence of a JSDoc comment for the given node and returns it.
+ * @param {ASTNode} node The node to get the comment for.
+ * @param {SourceCode} sourceCode A SourceCode instance to get comments.
+ * @returns {Token|null} The Block comment token containing the JSDoc comment for the given node or null if not found.
+ * @private
+ */
+function findJSDocComment(node, sourceCode) {
+	const tokenBefore = sourceCode.getTokenBefore(node, {
+		includeComments: true,
+	});
+
+	if (
+		tokenBefore &&
+		tokenBefore.type === "Block" &&
+		tokenBefore.value.charAt(0) === "*" &&
+		node.loc.start.line - tokenBefore.loc.end.line <= 1
+	) {
+		return tokenBefore;
+	}
+
+	return null;
+}
+
+/**
+ * Retrieves the JSDoc comment for a given node.
+ * @param {ASTNode} node The node to get the comment for.
+ * @param {SourceCode} sourceCode A SourceCode instance to get comments.
+ * @returns {Token|null} The Block comment token containing the JSDoc comment for the given node or null if not found.
+ * @private
+ */
+function getJSDocComment(node, sourceCode) {
+	let parent = node.parent;
+
+	switch (node.type) {
+		case "ClassDeclaration":
+		case "FunctionDeclaration":
+			return findJSDocComment(
+				isExportDeclaration(parent) ? parent : node,
+				sourceCode,
+			);
+
+		case "ClassExpression":
+			return findJSDocComment(parent.parent, sourceCode);
+
+		case "ArrowFunctionExpression":
+		case "FunctionExpression":
+			if (
+				parent.type !== "CallExpression" &&
+				parent.type !== "NewExpression"
+			) {
+				while (
+					!sourceCode.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, sourceCode);
+				}
+			}
+
+			return findJSDocComment(node, sourceCode);
+
+		// falls through
+		default:
+			return null;
+	}
+}
+
+/**
+ * Checks whether or not a node has a `@this` tag in its comments.
+ * @param {ASTNode} node A node to check.
+ * @param {SourceCode} sourceCode A SourceCode instance to get comments.
+ * @returns {boolean} Whether or not the node has a `@this` tag in its comments.
+ */
+function hasJSDocThisTag(node, sourceCode) {
+	const jsdocComment = getJSDocComment(node, sourceCode);
+
+	if (jsdocComment && thisTagPattern.test(jsdocComment.value)) {
+		return true;
+	}
+
+	// Checks `@this` in its leading comments for callbacks,
+	// because callbacks don't have its JSDoc comment.
+	// e.g.
+	//     sinon.test(/* @this sinon.Sandbox */function() { this.spy(); });
+	return sourceCode
+		.getCommentsBefore(node)
+		.some(comment => thisTagPattern.test(comment.value));
+}
+
 /**
  * Gets the `(` token of the given function node.
  * @param {ASTNode} node The function node to get.

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

@@ -96,8 +96,7 @@ module.exports = {
 		 */
 		function checkSpacing(side, leftToken, rightToken) {
 			if (
-				sourceCode.isSpaceBetweenTokens(leftToken, rightToken) !==
-				mode[side]
+				sourceCode.isSpaceBetween(leftToken, rightToken) !== mode[side]
 			) {
 				const after = leftToken.value === "*";
 				const spaceRequired = mode[side];

package/lib/types/index.d.ts

@@ -115,7 +115,7 @@ export namespace AST {
 		end: ESTree.Position;
 	}
 
-	type Range = [number, number];
+	type Range = SourceRange;
 
 	interface Program extends ESTree.Program {
 		comments: ESTree.Comment[];
@@ -125,6 +125,11 @@ export namespace AST {
 	}
 }
 
+interface JSXIdentifier extends ESTree.BaseNode {
+	type: "JSXIdentifier";
+	name: string;
+}
+
 export namespace Scope {
 	interface ScopeManager {
 		scopes: Scope[];
@@ -177,7 +182,7 @@ export namespace Scope {
 	}
 
 	interface Reference {
-		identifier: ESTree.Identifier;
+		identifier: ESTree.Identifier | JSXIdentifier;
 		from: Scope;
 		resolved: Variable | null;
 		writeExpr: ESTree.Node | null;
@@ -281,17 +286,8 @@ export class SourceCode
 
 	getDeclaredVariables(node: ESTree.Node): Scope.Variable[];
 
-	/** @deprecated */
-	getJSDocComment(node: ESTree.Node): ESTree.Comment | null;
-
 	getNodeByRangeIndex(index: number): ESTree.Node | null;
 
-	/** @deprecated Use `isSpaceBetween()` instead. */
-	isSpaceBetweenTokens(
-		first: ESTree.Node | AST.Token,
-		second: ESTree.Node | AST.Token,
-	): boolean;
-
 	getLocFromIndex(index: number): ESTree.Position;
 
 	getIndexFromLoc(location: ESTree.Position): number;
@@ -324,18 +320,6 @@ export class SourceCode
 
 	getTokensAfter: SourceCode.UnaryCursorWithCountOptions;
 
-	/** @deprecated Use `getTokenBefore()` instead. */
-	getTokenOrCommentBefore(
-		node: ESTree.Node | AST.Token | ESTree.Comment,
-		skip?: number | undefined,
-	): AST.Token | ESTree.Comment | null;
-
-	/** @deprecated Use `getTokenAfter()` instead. */
-	getTokenOrCommentAfter(
-		node: ESTree.Node | AST.Token | ESTree.Comment,
-		skip?: number | undefined,
-	): AST.Token | ESTree.Comment | null;
-
 	getFirstTokenBetween: SourceCode.BinaryCursorWithSkipOptions;
 
 	getFirstTokensBetween: SourceCode.BinaryCursorWithCountOptions;
@@ -1277,9 +1261,8 @@ export namespace ESLint {
 		foundWarnings: number;
 	}
 
-	interface LintResultData {
+	interface LintResultData extends ResultsMeta {
 		cwd: string;
-		maxWarningsExceeded?: MaxWarningsExceeded | undefined;
 		rulesMeta: {
 			[ruleId: string]: Rule.RuleMetaData;
 		};
@@ -1311,6 +1294,14 @@ export namespace ESLint {
 	 * Metadata about results for formatters.
 	 */
 	interface ResultsMeta {
+		/**
+		 * Whether or not to use color in the formatter output.
+		 * - If `--color` was set, this property is `true`.
+		 * - If `--no-color` was set, it is `false`.
+		 * - If neither option was provided, the property is omitted.
+		 */
+		color?: boolean | undefined;
+
 		/**
 		 * Present if the maxWarnings threshold was exceeded.
 		 */
@@ -1322,9 +1313,9 @@ export namespace ESLint {
 		/**
 		 * Used to call the underlying formatter.
 		 * @param results An array of lint results to format.
-		 * @param resultsMeta An object with an optional `maxWarningsExceeded` property that will be
+		 * @param resultsMeta An object with optional `color` and `maxWarningsExceeded` properties that will be
 		 * passed to the underlying formatter function along with other properties set by ESLint.
-		 * This argument can be omitted if `maxWarningsExceeded` is not needed.
+		 * This argument can be omitted if `color` and `maxWarningsExceeded` are not needed.
 		 * @return The formatter output.
 		 */
 		format(
@@ -1353,9 +1344,10 @@ export namespace ESLint {
 
 // #endregion
 
-export function loadESLint(options?: {
-	useFlatConfig?: boolean | undefined;
-}): Promise<typeof ESLint>;
+/**
+ * Loads the correct `ESLint` constructor.
+ */
+export function loadESLint(): Promise<typeof ESLint>;
 
 // #region RuleTester
 
@@ -1363,6 +1355,9 @@ export class RuleTester {
 	static describe: ((...args: any) => any) | null;
 	static it: ((...args: any) => any) | null;
 	static itOnly: ((...args: any) => any) | null;
+	static setDefaultConfig(config: Linter.Config): void;
+	static getDefaultConfig(): Linter.Config;
+	static resetDefaultConfig(): void;
 
 	constructor(config?: Linter.Config);
 
@@ -1372,6 +1367,26 @@ export class RuleTester {
 		tests: {
 			valid: Array<string | RuleTester.ValidTestCase>;
 			invalid: RuleTester.InvalidTestCase[];
+			/**
+			 * Additional assertions for the "error" matchers of invalid test cases to enforce consistency.
+			 */
+			assertionOptions?: {
+				/**
+				 * If true, each `errors` block must check the expected error
+				 * message, either via a string in the `errors` array, or via
+				 * `message`/`messageId` in an errors object.
+				 * `"message"`/`"messageId"` can be used to further limit the
+				 * message assertions to the respective versions.
+				 */
+				requireMessage?: boolean | "message" | "messageId";
+				/**
+				 * If true, each `errors` block must be an array of objects,
+				 * that each check all location properties `line`, `column`,
+				 * `endLine`, `endColumn`, the later may be omitted, if the
+				 * error does not contain them.
+				 */
+				requireLocation?: boolean;
+			};
 		},
 	): void;
 
@@ -1381,14 +1396,22 @@ export class RuleTester {
 }
 
 export namespace RuleTester {
-	interface ValidTestCase {
+	interface ValidTestCase
+		extends Omit<
+			Linter.Config,
+			| "name"
+			| "basePath"
+			| "files"
+			| "ignores"
+			| "linterOptions"
+			| "plugins"
+			| "rules"
+		> {
 		name?: string;
 		code: string;
-		options?: any;
+		options?: any[];
 		filename?: string | undefined;
 		only?: boolean;
-		languageOptions?: Linter.LanguageOptions | undefined;
-		settings?: { [name: string]: any } | undefined;
 		before?: () => void;
 		after?: () => void;
 	}
@@ -1401,7 +1424,7 @@ export namespace RuleTester {
 	}
 
 	interface InvalidTestCase extends ValidTestCase {
-		errors: number | Array<TestCaseError | string>;
+		errors: number | Array<TestCaseError | string | RegExp>;
 		output?: string | null | undefined;
 	}
 
@@ -1413,7 +1436,7 @@ export namespace RuleTester {
 		column?: number | undefined;
 		endLine?: number | undefined;
 		endColumn?: number | undefined;
-		suggestions?: SuggestionOutput[] | undefined;
+		suggestions?: SuggestionOutput[] | number | undefined;
 	}
 }
 

package/lib/types/use-at-your-own-risk.d.ts

@@ -31,4 +31,4 @@ import { Rule } from "./index.js";
 export const builtinRules: Map<string, Rule.RuleModule>;
 
 /** @deprecated */
-export function shouldUseFlatConfig(): Promise<boolean>;
+export function shouldUseFlatConfig(): Promise<true>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint",
-  "version": "10.0.0-alpha.0",
+  "version": "10.0.0-beta.0",
   "author": "Nicholas C. Zakas <nicholas+npm@nczconsulting.com>",
   "description": "An AST-based pattern checker for JavaScript.",
   "type": "commonjs",
@@ -107,8 +107,8 @@
   "bugs": "https://github.com/eslint/eslint/issues/",
   "dependencies": {
     "@eslint-community/eslint-utils": "^4.8.0",
-    "@eslint-community/regexpp": "^4.12.1",
-    "@eslint/config-array": "^0.22.0",
+    "@eslint-community/regexpp": "^4.12.2",
+    "@eslint/config-array": "^0.23.0",
     "@eslint/config-helpers": "^0.5.0",
     "@eslint/core": "^1.0.0",
     "@eslint/plugin-kit": "^0.5.0",
@@ -117,7 +117,6 @@
     "@humanwhocodes/retry": "^0.4.2",
     "@types/estree": "^1.0.6",
     "ajv": "^6.12.4",
-    "chalk": "^4.0.0",
     "cross-spawn": "^7.0.6",
     "debug": "^4.3.2",
     "escape-string-regexp": "^4.0.0",
@@ -134,7 +133,7 @@
     "imurmurhash": "^0.1.4",
     "is-glob": "^4.0.0",
     "json-stable-stringify-without-jsonify": "^1.0.1",
-    "minimatch": "^3.1.2",
+    "minimatch": "^10.1.1",
     "natural-compare": "^1.4.0",
     "optionator": "^0.9.3"
   },
@@ -144,7 +143,7 @@
     "@babel/preset-env": "^7.4.3",
     "@cypress/webpack-preprocessor": "^6.0.2",
     "@eslint/json": "^0.14.0",
-    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/eslintrc": "^3.3.3",
     "@trunkio/launcher": "^1.3.4",
     "@types/esquery": "^1.5.4",
     "@types/node": "^22.13.14",