eslint 8.57.1 → 9.39.1

package/lib/rules/no-extra-semi.js

@@ -17,131 +17,151 @@ const astUtils = require("./utils/ast-utils");
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
-    meta: {
-        deprecated: true,
-        replacedBy: [],
-        type: "suggestion",
-
-        docs: {
-            description: "Disallow unnecessary semicolons",
-            recommended: true,
-            url: "https://eslint.org/docs/latest/rules/no-extra-semi"
-        },
-
-        fixable: "code",
-        schema: [],
-
-        messages: {
-            unexpected: "Unnecessary semicolon."
-        }
-    },
-
-    create(context) {
-        const sourceCode = context.sourceCode;
-
-        /**
-         * Checks if a node or token is fixable.
-         * A node is fixable if it can be removed without turning a subsequent statement into a directive after fixing other nodes.
-         * @param {Token} nodeOrToken The node or token to check.
-         * @returns {boolean} Whether or not the node is fixable.
-         */
-        function isFixable(nodeOrToken) {
-            const nextToken = sourceCode.getTokenAfter(nodeOrToken);
-
-            if (!nextToken || nextToken.type !== "String") {
-                return true;
-            }
-            const stringNode = sourceCode.getNodeByRangeIndex(nextToken.range[0]);
-
-            return !astUtils.isTopLevelExpressionStatement(stringNode.parent);
-        }
-
-        /**
-         * Reports an unnecessary semicolon error.
-         * @param {Node|Token} nodeOrToken A node or a token to be reported.
-         * @returns {void}
-         */
-        function report(nodeOrToken) {
-            context.report({
-                node: nodeOrToken,
-                messageId: "unexpected",
-                fix: isFixable(nodeOrToken)
-                    ? fixer =>
-
-                        /*
-                         * Expand the replacement range to include the surrounding
-                         * tokens to avoid conflicting with semi.
-                         * https://github.com/eslint/eslint/issues/7928
-                         */
-                        new FixTracker(fixer, context.sourceCode)
-                            .retainSurroundingTokens(nodeOrToken)
-                            .remove(nodeOrToken)
-                    : null
-            });
-        }
-
-        /**
-         * Checks for a part of a class body.
-         * This checks tokens from a specified token to a next MethodDefinition or the end of class body.
-         * @param {Token} firstToken The first token to check.
-         * @returns {void}
-         */
-        function checkForPartOfClassBody(firstToken) {
-            for (let token = firstToken;
-                token.type === "Punctuator" && !astUtils.isClosingBraceToken(token);
-                token = sourceCode.getTokenAfter(token)
-            ) {
-                if (astUtils.isSemicolonToken(token)) {
-                    report(token);
-                }
-            }
-        }
-
-        return {
-
-            /**
-             * Reports this empty statement, except if the parent node is a loop.
-             * @param {Node} node A EmptyStatement node to be reported.
-             * @returns {void}
-             */
-            EmptyStatement(node) {
-                const parent = node.parent,
-                    allowedParentTypes = [
-                        "ForStatement",
-                        "ForInStatement",
-                        "ForOfStatement",
-                        "WhileStatement",
-                        "DoWhileStatement",
-                        "IfStatement",
-                        "LabeledStatement",
-                        "WithStatement"
-                    ];
-
-                if (!allowedParentTypes.includes(parent.type)) {
-                    report(node);
-                }
-            },
-
-            /**
-             * Checks tokens from the head of this class body to the first MethodDefinition or the end of this class body.
-             * @param {Node} node A ClassBody node to check.
-             * @returns {void}
-             */
-            ClassBody(node) {
-                checkForPartOfClassBody(sourceCode.getFirstToken(node, 1)); // 0 is `{`.
-            },
-
-            /**
-             * Checks tokens from this MethodDefinition to the next MethodDefinition or the end of this class body.
-             * @param {Node} node A MethodDefinition node of the start point.
-             * @returns {void}
-             */
-            "MethodDefinition, PropertyDefinition, StaticBlock"(node) {
-                checkForPartOfClassBody(sourceCode.getTokenAfter(node));
-            }
-        };
-
-    }
+	meta: {
+		deprecated: {
+			message: "Formatting rules are being moved out of ESLint core.",
+			url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
+			deprecatedSince: "8.53.0",
+			availableUntil: "11.0.0",
+			replacedBy: [
+				{
+					message:
+						"ESLint Stylistic now maintains deprecated stylistic core rules.",
+					url: "https://eslint.style/guide/migration",
+					plugin: {
+						name: "@stylistic/eslint-plugin",
+						url: "https://eslint.style",
+					},
+					rule: {
+						name: "no-extra-semi",
+						url: "https://eslint.style/rules/no-extra-semi",
+					},
+				},
+			],
+		},
+		type: "suggestion",
+
+		docs: {
+			description: "Disallow unnecessary semicolons",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/no-extra-semi",
+		},
+
+		fixable: "code",
+		schema: [],
+
+		messages: {
+			unexpected: "Unnecessary semicolon.",
+		},
+	},
+
+	create(context) {
+		const sourceCode = context.sourceCode;
+
+		/**
+		 * Checks if a node or token is fixable.
+		 * A node is fixable if it can be removed without turning a subsequent statement into a directive after fixing other nodes.
+		 * @param {Token} nodeOrToken The node or token to check.
+		 * @returns {boolean} Whether or not the node is fixable.
+		 */
+		function isFixable(nodeOrToken) {
+			const nextToken = sourceCode.getTokenAfter(nodeOrToken);
+
+			if (!nextToken || nextToken.type !== "String") {
+				return true;
+			}
+			const stringNode = sourceCode.getNodeByRangeIndex(
+				nextToken.range[0],
+			);
+
+			return !astUtils.isTopLevelExpressionStatement(stringNode.parent);
+		}
+
+		/**
+		 * Reports an unnecessary semicolon error.
+		 * @param {Node|Token} nodeOrToken A node or a token to be reported.
+		 * @returns {void}
+		 */
+		function report(nodeOrToken) {
+			context.report({
+				node: nodeOrToken,
+				messageId: "unexpected",
+				fix: isFixable(nodeOrToken)
+					? fixer =>
+							/*
+							 * Expand the replacement range to include the surrounding
+							 * tokens to avoid conflicting with semi.
+							 * https://github.com/eslint/eslint/issues/7928
+							 */
+							new FixTracker(fixer, context.sourceCode)
+								.retainSurroundingTokens(nodeOrToken)
+								.remove(nodeOrToken)
+					: null,
+			});
+		}
+
+		/**
+		 * Checks for a part of a class body.
+		 * This checks tokens from a specified token to a next MethodDefinition or the end of class body.
+		 * @param {Token} firstToken The first token to check.
+		 * @returns {void}
+		 */
+		function checkForPartOfClassBody(firstToken) {
+			for (
+				let token = firstToken;
+				token.type === "Punctuator" &&
+				!astUtils.isClosingBraceToken(token);
+				token = sourceCode.getTokenAfter(token)
+			) {
+				if (astUtils.isSemicolonToken(token)) {
+					report(token);
+				}
+			}
+		}
+
+		return {
+			/**
+			 * Reports this empty statement, except if the parent node is a loop.
+			 * @param {Node} node A EmptyStatement node to be reported.
+			 * @returns {void}
+			 */
+			EmptyStatement(node) {
+				const parent = node.parent,
+					allowedParentTypes = [
+						"ForStatement",
+						"ForInStatement",
+						"ForOfStatement",
+						"WhileStatement",
+						"DoWhileStatement",
+						"IfStatement",
+						"LabeledStatement",
+						"WithStatement",
+					];
+
+				if (!allowedParentTypes.includes(parent.type)) {
+					report(node);
+				}
+			},
+
+			/**
+			 * Checks tokens from the head of this class body to the first MethodDefinition or the end of this class body.
+			 * @param {Node} node A ClassBody node to check.
+			 * @returns {void}
+			 */
+			ClassBody(node) {
+				checkForPartOfClassBody(sourceCode.getFirstToken(node, 1)); // 0 is `{`.
+			},
+
+			/**
+			 * Checks tokens from this MethodDefinition to the next MethodDefinition or the end of this class body.
+			 * @param {Node} node A MethodDefinition node of the start point.
+			 * @returns {void}
+			 */
+			"MethodDefinition, PropertyDefinition, StaticBlock"(node) {
+				checkForPartOfClassBody(sourceCode.getTokenAfter(node));
+			},
+		};
+	},
 };

package/lib/rules/no-fallthrough.js

@@ -22,14 +22,13 @@ const DEFAULT_FALLTHROUGH_COMMENT = /falls?\s?through/iu;
  * @returns {boolean} True if any segment is reachable; false otherwise.
  */
 function isAnySegmentReachable(segments) {
+	for (const segment of segments) {
+		if (segment.reachable) {
+			return true;
+		}
+	}
 
-    for (const segment of segments) {
-        if (segment.reachable) {
-            return true;
-        }
-    }
-
-    return false;
+	return false;
 }
 
 /**
@@ -39,7 +38,10 @@ function isAnySegmentReachable(segments) {
  * @returns {boolean} `true` if the comment string is truly a fallthrough comment.
  */
 function isFallThroughComment(comment, fallthroughCommentPattern) {
-    return fallthroughCommentPattern.test(comment) && !directivesPattern.test(comment.trim());
+	return (
+		fallthroughCommentPattern.test(comment) &&
+		!directivesPattern.test(comment.trim())
+	);
 }
 
 /**
@@ -48,23 +50,48 @@ function isFallThroughComment(comment, fallthroughCommentPattern) {
  * @param {ASTNode} subsequentCase The case after caseWhichFallsThrough.
  * @param {RuleContext} context A rule context which stores comments.
  * @param {RegExp} fallthroughCommentPattern A pattern to match comment to.
- * @returns {boolean} `true` if the case has a valid fallthrough comment.
+ * @returns {null | object} the comment if the case has a valid fallthrough comment, otherwise null
  */
-function hasFallthroughComment(caseWhichFallsThrough, subsequentCase, context, fallthroughCommentPattern) {
-    const sourceCode = context.sourceCode;
-
-    if (caseWhichFallsThrough.consequent.length === 1 && caseWhichFallsThrough.consequent[0].type === "BlockStatement") {
-        const trailingCloseBrace = sourceCode.getLastToken(caseWhichFallsThrough.consequent[0]);
-        const commentInBlock = sourceCode.getCommentsBefore(trailingCloseBrace).pop();
-
-        if (commentInBlock && isFallThroughComment(commentInBlock.value, fallthroughCommentPattern)) {
-            return true;
-        }
-    }
-
-    const comment = sourceCode.getCommentsBefore(subsequentCase).pop();
-
-    return Boolean(comment && isFallThroughComment(comment.value, fallthroughCommentPattern));
+function getFallthroughComment(
+	caseWhichFallsThrough,
+	subsequentCase,
+	context,
+	fallthroughCommentPattern,
+) {
+	const sourceCode = context.sourceCode;
+
+	if (
+		caseWhichFallsThrough.consequent.length === 1 &&
+		caseWhichFallsThrough.consequent[0].type === "BlockStatement"
+	) {
+		const trailingCloseBrace = sourceCode.getLastToken(
+			caseWhichFallsThrough.consequent[0],
+		);
+		const commentInBlock = sourceCode
+			.getCommentsBefore(trailingCloseBrace)
+			.pop();
+
+		if (
+			commentInBlock &&
+			isFallThroughComment(
+				commentInBlock.value,
+				fallthroughCommentPattern,
+			)
+		) {
+			return commentInBlock;
+		}
+	}
+
+	const comment = sourceCode.getCommentsBefore(subsequentCase).pop();
+
+	if (
+		comment &&
+		isFallThroughComment(comment.value, fallthroughCommentPattern)
+	) {
+		return comment;
+	}
+
+	return null;
 }
 
 /**
@@ -74,123 +101,160 @@ function hasFallthroughComment(caseWhichFallsThrough, subsequentCase, context, f
  * @returns {boolean} `true` if there are blank lines between node and token
  */
 function hasBlankLinesBetween(node, token) {
-    return token.loc.start.line > node.loc.end.line + 1;
+	return token.loc.start.line > node.loc.end.line + 1;
 }
 
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
-    meta: {
-        type: "problem",
-
-        docs: {
-            description: "Disallow fallthrough of `case` statements",
-            recommended: true,
-            url: "https://eslint.org/docs/latest/rules/no-fallthrough"
-        },
-
-        schema: [
-            {
-                type: "object",
-                properties: {
-                    commentPattern: {
-                        type: "string",
-                        default: ""
-                    },
-                    allowEmptyCase: {
-                        type: "boolean",
-                        default: false
-                    }
-                },
-                additionalProperties: false
-            }
-        ],
-        messages: {
-            case: "Expected a 'break' statement before 'case'.",
-            default: "Expected a 'break' statement before 'default'."
-        }
-    },
-
-    create(context) {
-        const options = context.options[0] || {};
-        const codePathSegments = [];
-        let currentCodePathSegments = new Set();
-        const sourceCode = context.sourceCode;
-        const allowEmptyCase = options.allowEmptyCase || false;
-
-        /*
-         * We need to use leading comments of the next SwitchCase node because
-         * trailing comments is wrong if semicolons are omitted.
-         */
-        let fallthroughCase = null;
-        let fallthroughCommentPattern = null;
-
-        if (options.commentPattern) {
-            fallthroughCommentPattern = new RegExp(options.commentPattern, "u");
-        } else {
-            fallthroughCommentPattern = DEFAULT_FALLTHROUGH_COMMENT;
-        }
-        return {
-
-            onCodePathStart() {
-                codePathSegments.push(currentCodePathSegments);
-                currentCodePathSegments = new Set();
-            },
-
-            onCodePathEnd() {
-                currentCodePathSegments = codePathSegments.pop();
-            },
-
-            onUnreachableCodePathSegmentStart(segment) {
-                currentCodePathSegments.add(segment);
-            },
-
-            onUnreachableCodePathSegmentEnd(segment) {
-                currentCodePathSegments.delete(segment);
-            },
-
-            onCodePathSegmentStart(segment) {
-                currentCodePathSegments.add(segment);
-            },
-
-            onCodePathSegmentEnd(segment) {
-                currentCodePathSegments.delete(segment);
-            },
-
-
-            SwitchCase(node) {
-
-                /*
-                 * Checks whether or not there is a fallthrough comment.
-                 * And reports the previous fallthrough node if that does not exist.
-                 */
-
-                if (fallthroughCase && (!hasFallthroughComment(fallthroughCase, node, context, fallthroughCommentPattern))) {
-                    context.report({
-                        messageId: node.test ? "case" : "default",
-                        node
-                    });
-                }
-                fallthroughCase = null;
-            },
-
-            "SwitchCase:exit"(node) {
-                const nextToken = sourceCode.getTokenAfter(node);
-
-                /*
-                 * `reachable` meant fall through because statements preceded by
-                 * `break`, `return`, or `throw` are unreachable.
-                 * And allows empty cases and the last case.
-                 */
-                if (isAnySegmentReachable(currentCodePathSegments) &&
-                    (node.consequent.length > 0 || (!allowEmptyCase && hasBlankLinesBetween(node, nextToken))) &&
-                    node.parent.cases[node.parent.cases.length - 1] !== node) {
-                    fallthroughCase = node;
-                }
-            }
-        };
-    }
+	meta: {
+		type: "problem",
+
+		defaultOptions: [
+			{
+				allowEmptyCase: false,
+				reportUnusedFallthroughComment: false,
+			},
+		],
+
+		docs: {
+			description: "Disallow fallthrough of `case` statements",
+			recommended: true,
+			url: "https://eslint.org/docs/latest/rules/no-fallthrough",
+		},
+
+		schema: [
+			{
+				type: "object",
+				properties: {
+					commentPattern: {
+						type: "string",
+					},
+					allowEmptyCase: {
+						type: "boolean",
+					},
+					reportUnusedFallthroughComment: {
+						type: "boolean",
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+		messages: {
+			unusedFallthroughComment:
+				"Found a comment that would permit fallthrough, but case cannot fall through.",
+			case: "Expected a 'break' statement before 'case'.",
+			default: "Expected a 'break' statement before 'default'.",
+		},
+	},
+
+	create(context) {
+		const codePathSegments = [];
+		let currentCodePathSegments = new Set();
+		const sourceCode = context.sourceCode;
+		const [
+			{ allowEmptyCase, commentPattern, reportUnusedFallthroughComment },
+		] = context.options;
+		const fallthroughCommentPattern = commentPattern
+			? new RegExp(commentPattern, "u")
+			: DEFAULT_FALLTHROUGH_COMMENT;
+
+		/*
+		 * We need to use leading comments of the next SwitchCase node because
+		 * trailing comments is wrong if semicolons are omitted.
+		 */
+		let previousCase = null;
+
+		return {
+			onCodePathStart() {
+				codePathSegments.push(currentCodePathSegments);
+				currentCodePathSegments = new Set();
+			},
+
+			onCodePathEnd() {
+				currentCodePathSegments = codePathSegments.pop();
+			},
+
+			onUnreachableCodePathSegmentStart(segment) {
+				currentCodePathSegments.add(segment);
+			},
+
+			onUnreachableCodePathSegmentEnd(segment) {
+				currentCodePathSegments.delete(segment);
+			},
+
+			onCodePathSegmentStart(segment) {
+				currentCodePathSegments.add(segment);
+			},
+
+			onCodePathSegmentEnd(segment) {
+				currentCodePathSegments.delete(segment);
+			},
+
+			SwitchCase(node) {
+				/*
+				 * Checks whether or not there is a fallthrough comment.
+				 * And reports the previous fallthrough node if that does not exist.
+				 */
+
+				if (previousCase && previousCase.node.parent === node.parent) {
+					const previousCaseFallthroughComment =
+						getFallthroughComment(
+							previousCase.node,
+							node,
+							context,
+							fallthroughCommentPattern,
+						);
+
+					if (
+						previousCase.isFallthrough &&
+						!previousCaseFallthroughComment
+					) {
+						context.report({
+							messageId: node.test ? "case" : "default",
+							node,
+						});
+					} else if (
+						reportUnusedFallthroughComment &&
+						!previousCase.isSwitchExitReachable &&
+						previousCaseFallthroughComment
+					) {
+						context.report({
+							messageId: "unusedFallthroughComment",
+							node: previousCaseFallthroughComment,
+						});
+					}
+				}
+				previousCase = null;
+			},
+
+			"SwitchCase:exit"(node) {
+				const nextToken = sourceCode.getTokenAfter(node);
+
+				/*
+				 * `reachable` meant fall through because statements preceded by
+				 * `break`, `return`, or `throw` are unreachable.
+				 * And allows empty cases and the last case.
+				 */
+				const isSwitchExitReachable = isAnySegmentReachable(
+					currentCodePathSegments,
+				);
+				const isFallthrough =
+					isSwitchExitReachable &&
+					(node.consequent.length > 0 ||
+						(!allowEmptyCase &&
+							hasBlankLinesBetween(node, nextToken))) &&
+					node.parent.cases.at(-1) !== node;
+
+				previousCase = {
+					node,
+					isSwitchExitReachable,
+					isFallthrough,
+				};
+			},
+		};
+	},
 };