eslint 8.48.0 → 8.49.0

package/lib/rules/lines-between-class-members.js

@@ -10,6 +10,21 @@
 
 const astUtils = require("./utils/ast-utils");
 
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Types of class members.
+ * Those have `test` method to check it matches to the given class member.
+ * @private
+ */
+const ClassMemberTypes = {
+    "*": { test: () => true },
+    field: { test: node => node.type === "PropertyDefinition" },
+    method: { test: node => node.type === "MethodDefinition" }
+};
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -29,7 +44,32 @@ module.exports = {
 
         schema: [
             {
-                enum: ["always", "never"]
+                anyOf: [
+                    {
+                        type: "object",
+                        properties: {
+                            enforce: {
+                                type: "array",
+                                items: {
+                                    type: "object",
+                                    properties: {
+                                        blankLine: { enum: ["always", "never"] },
+                                        prev: { enum: ["method", "field", "*"] },
+                                        next: { enum: ["method", "field", "*"] }
+                                    },
+                                    additionalProperties: false,
+                                    required: ["blankLine", "prev", "next"]
+                                },
+                                minItems: 1
+                            }
+                        },
+                        additionalProperties: false,
+                        required: ["enforce"]
+                    },
+                    {
+                        enum: ["always", "never"]
+                    }
+                ]
             },
             {
                 type: "object",
@@ -55,6 +95,7 @@ module.exports = {
         options[0] = context.options[0] || "always";
         options[1] = context.options[1] || { exceptAfterSingleLine: false };
 
+        const configureList = typeof options[0] === "object" ? options[0].enforce : [{ blankLine: options[0], prev: "*", next: "*" }];
         const sourceCode = context.sourceCode;
 
         /**
@@ -144,6 +185,38 @@ module.exports = {
             return sourceCode.getTokensBetween(before, after, { includeComments: true }).length !== 0;
         }
 
+        /**
+         * Checks whether the given node matches the given type.
+         * @param {ASTNode} node The class member node to check.
+         * @param {string} type The class member type to check.
+         * @returns {boolean} `true` if the class member node matched the type.
+         * @private
+         */
+        function match(node, type) {
+            return ClassMemberTypes[type].test(node);
+        }
+
+        /**
+         * Finds the last matched configuration from the configureList.
+         * @param {ASTNode} prevNode The previous node to match.
+         * @param {ASTNode} nextNode The current node to match.
+         * @returns {string|null} Padding type or `null` if no matches were found.
+         * @private
+         */
+        function getPaddingType(prevNode, nextNode) {
+            for (let i = configureList.length - 1; i >= 0; --i) {
+                const configure = configureList[i];
+                const matched =
+                    match(prevNode, configure.prev) &&
+                    match(nextNode, configure.next);
+
+                if (matched) {
+                    return configure.blankLine;
+                }
+            }
+            return null;
+        }
+
         return {
             ClassBody(node) {
                 const body = node.body;
@@ -158,22 +231,34 @@ module.exports = {
                     const isPadded = afterPadding.loc.start.line - beforePadding.loc.end.line > 1;
                     const hasTokenInPadding = hasTokenOrCommentBetween(beforePadding, afterPadding);
                     const curLineLastToken = findLastConsecutiveTokenAfter(curLast, nextFirst, 0);
+                    const paddingType = getPaddingType(body[i], body[i + 1]);
+
+                    if (paddingType === "never" && isPadded) {
+                        context.report({
+                            node: body[i + 1],
+                            messageId: "never",
 
-                    if ((options[0] === "always" && !skip && !isPadded) ||
-                        (options[0] === "never" && isPadded)) {
+                            fix(fixer) {
+                                if (hasTokenInPadding) {
+                                    return null;
+                                }
+                                return fixer.replaceTextRange([beforePadding.range[1], afterPadding.range[0]], "\n");
+                            }
+                        });
+                    } else if (paddingType === "always" && !skip && !isPadded) {
                         context.report({
                             node: body[i + 1],
-                            messageId: isPadded ? "never" : "always",
+                            messageId: "always",
+
                             fix(fixer) {
                                 if (hasTokenInPadding) {
                                     return null;
                                 }
-                                return isPadded
-                                    ? fixer.replaceTextRange([beforePadding.range[1], afterPadding.range[0]], "\n")
-                                    : fixer.insertTextAfter(curLineLastToken, "\n");
+                                return fixer.insertTextAfter(curLineLastToken, "\n");
                             }
                         });
                     }
+
                 }
             }
         };

package/lib/rules/no-fallthrough.js

@@ -16,6 +16,22 @@ const { directivesPattern } = require("../shared/directives");
 
 const DEFAULT_FALLTHROUGH_COMMENT = /falls?\s?through/iu;
 
+/**
+ * Checks all segments in a set and returns true if any are reachable.
+ * @param {Set<CodePathSegment>} segments The segments to check.
+ * @returns {boolean} True if any segment is reachable; false otherwise.
+ */
+function isAnySegmentReachable(segments) {
+
+    for (const segment of segments) {
+        if (segment.reachable) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
 /**
  * Checks whether or not a given comment string is really a fallthrough comment and not an ESLint directive.
  * @param {string} comment The comment string to check.
@@ -51,15 +67,6 @@ function hasFallthroughComment(caseWhichFallsThrough, subsequentCase, context, f
     return Boolean(comment && isFallThroughComment(comment.value, fallthroughCommentPattern));
 }
 
-/**
- * Checks whether or not a given code path segment is reachable.
- * @param {CodePathSegment} segment A CodePathSegment to check.
- * @returns {boolean} `true` if the segment is reachable.
- */
-function isReachable(segment) {
-    return segment.reachable;
-}
-
 /**
  * Checks whether a node and a token are separated by blank lines
  * @param {ASTNode} node The node to check
@@ -109,7 +116,8 @@ module.exports = {
 
     create(context) {
         const options = context.options[0] || {};
-        let currentCodePath = null;
+        const codePathSegments = [];
+        let currentCodePathSegments = new Set();
         const sourceCode = context.sourceCode;
         const allowEmptyCase = options.allowEmptyCase || false;
 
@@ -126,13 +134,33 @@ module.exports = {
             fallthroughCommentPattern = DEFAULT_FALLTHROUGH_COMMENT;
         }
         return {
-            onCodePathStart(codePath) {
-                currentCodePath = codePath;
+
+            onCodePathStart() {
+                codePathSegments.push(currentCodePathSegments);
+                currentCodePathSegments = new Set();
             },
+
             onCodePathEnd() {
-                currentCodePath = currentCodePath.upper;
+                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) {
 
                 /*
@@ -157,7 +185,7 @@ module.exports = {
                  * `break`, `return`, or `throw` are unreachable.
                  * And allows empty cases and the last case.
                  */
-                if (currentCodePath.currentSegments.some(isReachable) &&
+                if (isAnySegmentReachable(currentCodePathSegments) &&
                     (node.consequent.length > 0 || (!allowEmptyCase && hasBlankLinesBetween(node, nextToken))) &&
                     node.parent.cases[node.parent.cases.length - 1] !== node) {
                     fallthroughCase = node;

package/lib/rules/no-this-before-super.js

@@ -90,6 +90,21 @@ module.exports = {
             return Boolean(funcInfo && funcInfo.isConstructor && funcInfo.hasExtends);
         }
 
+        /**
+         * Determines if every segment in a set has been called.
+         * @param {Set<CodePathSegment>} segments The segments to search.
+         * @returns {boolean} True if every segment has been called; false otherwise.
+         */
+        function isEverySegmentCalled(segments) {
+            for (const segment of segments) {
+                if (!isCalled(segment)) {
+                    return false;
+                }
+            }
+
+            return true;
+        }
+
         /**
          * Checks whether or not this is before `super()` is called.
          * @returns {boolean} `true` if this is before `super()` is called.
@@ -97,7 +112,7 @@ module.exports = {
         function isBeforeCallOfSuper() {
             return (
                 isInConstructorOfDerivedClass() &&
-                !funcInfo.codePath.currentSegments.every(isCalled)
+                !isEverySegmentCalled(funcInfo.currentSegments)
             );
         }
 
@@ -108,11 +123,9 @@ module.exports = {
          * @returns {void}
          */
         function setInvalid(node) {
-            const segments = funcInfo.codePath.currentSegments;
-
-            for (let i = 0; i < segments.length; ++i) {
-                const segment = segments[i];
+            const segments = funcInfo.currentSegments;
 
+            for (const segment of segments) {
                 if (segment.reachable) {
                     segInfoMap[segment.id].invalidNodes.push(node);
                 }
@@ -124,11 +137,9 @@ module.exports = {
          * @returns {void}
          */
         function setSuperCalled() {
-            const segments = funcInfo.codePath.currentSegments;
-
-            for (let i = 0; i < segments.length; ++i) {
-                const segment = segments[i];
+            const segments = funcInfo.currentSegments;
 
+            for (const segment of segments) {
                 if (segment.reachable) {
                     segInfoMap[segment.id].superCalled = true;
                 }
@@ -156,14 +167,16 @@ module.exports = {
                             classNode.superClass &&
                             !astUtils.isNullOrUndefined(classNode.superClass)
                         ),
-                        codePath
+                        codePath,
+                        currentSegments: new Set()
                     };
                 } else {
                     funcInfo = {
                         upper: funcInfo,
                         isConstructor: false,
                         hasExtends: false,
-                        codePath
+                        codePath,
+                        currentSegments: new Set()
                     };
                 }
             },
@@ -211,6 +224,8 @@ module.exports = {
              * @returns {void}
              */
             onCodePathSegmentStart(segment) {
+                funcInfo.currentSegments.add(segment);
+
                 if (!isInConstructorOfDerivedClass()) {
                     return;
                 }
@@ -225,6 +240,18 @@ module.exports = {
                 };
             },
 
+            onUnreachableCodePathSegmentStart(segment) {
+                funcInfo.currentSegments.add(segment);
+            },
+
+            onUnreachableCodePathSegmentEnd(segment) {
+                funcInfo.currentSegments.delete(segment);
+            },
+
+            onCodePathSegmentEnd(segment) {
+                funcInfo.currentSegments.delete(segment);
+            },
+
             /**
              * Update information of the code path segment when a code path was
              * looped.

package/lib/rules/no-unreachable-loop.js

@@ -11,6 +11,22 @@
 
 const allLoopTypes = ["WhileStatement", "DoWhileStatement", "ForStatement", "ForInStatement", "ForOfStatement"];
 
+/**
+ * Checks all segments in a set and returns true if any are reachable.
+ * @param {Set<CodePathSegment>} segments The segments to check.
+ * @returns {boolean} True if any segment is reachable; false otherwise.
+ */
+function isAnySegmentReachable(segments) {
+
+    for (const segment of segments) {
+        if (segment.reachable) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
 /**
  * Determines whether the given node is the first node in the code path to which a loop statement
  * 'loops' for the next iteration.
@@ -90,29 +106,36 @@ module.exports = {
             loopsByTargetSegments = new Map(),
             loopsToReport = new Set();
 
-        let currentCodePath = null;
+        const codePathSegments = [];
+        let currentCodePathSegments = new Set();
 
         return {
-            onCodePathStart(codePath) {
-                currentCodePath = codePath;
+
+            onCodePathStart() {
+                codePathSegments.push(currentCodePathSegments);
+                currentCodePathSegments = new Set();
             },
 
             onCodePathEnd() {
-                currentCodePath = currentCodePath.upper;
+                currentCodePathSegments = codePathSegments.pop();
             },
 
-            [loopSelector](node) {
+            onUnreachableCodePathSegmentStart(segment) {
+                currentCodePathSegments.add(segment);
+            },
 
-                /**
-                 * Ignore unreachable loop statements to avoid unnecessary complexity in the implementation, or false positives otherwise.
-                 * For unreachable segments, the code path analysis does not raise events required for this implementation.
-                 */
-                if (currentCodePath.currentSegments.some(segment => segment.reachable)) {
-                    loopsToReport.add(node);
-                }
+            onUnreachableCodePathSegmentEnd(segment) {
+                currentCodePathSegments.delete(segment);
+            },
+
+            onCodePathSegmentEnd(segment) {
+                currentCodePathSegments.delete(segment);
             },
 
             onCodePathSegmentStart(segment, node) {
+
+                currentCodePathSegments.add(segment);
+
                 if (isLoopingTarget(node)) {
                     const loop = node.parent;
 
@@ -140,6 +163,18 @@ module.exports = {
                 }
             },
 
+            [loopSelector](node) {
+
+                /**
+                 * Ignore unreachable loop statements to avoid unnecessary complexity in the implementation, or false positives otherwise.
+                 * For unreachable segments, the code path analysis does not raise events required for this implementation.
+                 */
+                if (isAnySegmentReachable(currentCodePathSegments)) {
+                    loopsToReport.add(node);
+                }
+            },
+
+
             "Program:exit"() {
                 loopsToReport.forEach(
                     node => context.report({ node, messageId: "invalid" })

package/lib/rules/no-unreachable.js

@@ -24,12 +24,19 @@ function isInitialized(node) {
 }
 
 /**
- * Checks whether or not a given code path segment is unreachable.
- * @param {CodePathSegment} segment A CodePathSegment to check.
- * @returns {boolean} `true` if the segment is unreachable.
+ * Checks all segments in a set and returns true if all are unreachable.
+ * @param {Set<CodePathSegment>} segments The segments to check.
+ * @returns {boolean} True if all segments are unreachable; false otherwise.
  */
-function isUnreachable(segment) {
-    return !segment.reachable;
+function areAllSegmentsUnreachable(segments) {
+
+    for (const segment of segments) {
+        if (segment.reachable) {
+            return false;
+        }
+    }
+
+    return true;
 }
 
 /**
@@ -124,7 +131,6 @@ module.exports = {
     },
 
     create(context) {
-        let currentCodePath = null;
 
         /** @type {ConstructorInfo | null} */
         let constructorInfo = null;
@@ -132,6 +138,12 @@ module.exports = {
         /** @type {ConsecutiveRange} */
         const range = new ConsecutiveRange(context.sourceCode);
 
+        /** @type {Array<Set<CodePathSegment>>} */
+        const codePathSegments = [];
+
+        /** @type {Set<CodePathSegment>} */
+        let currentCodePathSegments = new Set();
+
         /**
          * Reports a given node if it's unreachable.
          * @param {ASTNode} node A statement node to report.
@@ -140,7 +152,7 @@ module.exports = {
         function reportIfUnreachable(node) {
             let nextNode = null;
 
-            if (node && (node.type === "PropertyDefinition" || currentCodePath.currentSegments.every(isUnreachable))) {
+            if (node && (node.type === "PropertyDefinition" || areAllSegmentsUnreachable(currentCodePathSegments))) {
 
                 // Store this statement to distinguish consecutive statements.
                 if (range.isEmpty) {
@@ -181,12 +193,29 @@ module.exports = {
         return {
 
             // Manages the current code path.
-            onCodePathStart(codePath) {
-                currentCodePath = codePath;
+            onCodePathStart() {
+                codePathSegments.push(currentCodePathSegments);
+                currentCodePathSegments = new Set();
             },
 
             onCodePathEnd() {
-                currentCodePath = currentCodePath.upper;
+                currentCodePathSegments = codePathSegments.pop();
+            },
+
+            onUnreachableCodePathSegmentStart(segment) {
+                currentCodePathSegments.add(segment);
+            },
+
+            onUnreachableCodePathSegmentEnd(segment) {
+                currentCodePathSegments.delete(segment);
+            },
+
+            onCodePathSegmentEnd(segment) {
+                currentCodePathSegments.delete(segment);
+            },
+
+            onCodePathSegmentStart(segment) {
+                currentCodePathSegments.add(segment);
             },
 
             // Registers for all statement nodes (excludes FunctionDeclaration).

package/lib/rules/no-useless-return.js

@@ -57,6 +57,22 @@ function isInFinally(node) {
     return false;
 }
 
+/**
+ * Checks all segments in a set and returns true if any are reachable.
+ * @param {Set<CodePathSegment>} segments The segments to check.
+ * @returns {boolean} True if any segment is reachable; false otherwise.
+ */
+function isAnySegmentReachable(segments) {
+
+    for (const segment of segments) {
+        if (segment.reachable) {
+            return true;
+        }
+    }
+
+    return false;
+}
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -205,7 +221,6 @@ module.exports = {
          */
         function markReturnStatementsOnCurrentSegmentsAsUsed() {
             scopeInfo
-                .codePath
                 .currentSegments
                 .forEach(segment => markReturnStatementsOnSegmentAsUsed(segment, new Set()));
         }
@@ -222,7 +237,8 @@ module.exports = {
                     upper: scopeInfo,
                     uselessReturns: [],
                     traversedTryBlockStatements: [],
-                    codePath
+                    codePath,
+                    currentSegments: new Set()
                 };
             },
 
@@ -259,6 +275,9 @@ module.exports = {
              * NOTE: This event is notified for only reachable segments.
              */
             onCodePathSegmentStart(segment) {
+
+                scopeInfo.currentSegments.add(segment);
+
                 const info = {
                     uselessReturns: getUselessReturns([], segment.allPrevSegments),
                     returned: false
@@ -268,6 +287,18 @@ module.exports = {
                 segmentInfoMap.set(segment, info);
             },
 
+            onUnreachableCodePathSegmentStart(segment) {
+                scopeInfo.currentSegments.add(segment);
+            },
+
+            onUnreachableCodePathSegmentEnd(segment) {
+                scopeInfo.currentSegments.delete(segment);
+            },
+
+            onCodePathSegmentEnd(segment) {
+                scopeInfo.currentSegments.delete(segment);
+            },
+
             // Adds ReturnStatement node to check whether it's useless or not.
             ReturnStatement(node) {
                 if (node.argument) {
@@ -279,12 +310,12 @@ module.exports = {
                     isInFinally(node) ||
 
                     // Ignore `return` statements in unreachable places (https://github.com/eslint/eslint/issues/11647).
-                    !scopeInfo.codePath.currentSegments.some(s => s.reachable)
+                    !isAnySegmentReachable(scopeInfo.currentSegments)
                 ) {
                     return;
                 }
 
-                for (const segment of scopeInfo.codePath.currentSegments) {
+                for (const segment of scopeInfo.currentSegments) {
                     const info = segmentInfoMap.get(segment);
 
                     if (info) {

package/lib/rules/require-atomic-updates.js

@@ -213,7 +213,8 @@ module.exports = {
                 stack = {
                     upper: stack,
                     codePath,
-                    referenceMap: shouldVerify ? createReferenceMap(scope) : null
+                    referenceMap: shouldVerify ? createReferenceMap(scope) : null,
+                    currentSegments: new Set()
                 };
             },
             onCodePathEnd() {
@@ -223,11 +224,25 @@ module.exports = {
             // Initialize the segment information.
             onCodePathSegmentStart(segment) {
                 segmentInfo.initialize(segment);
+                stack.currentSegments.add(segment);
             },
 
+            onUnreachableCodePathSegmentStart(segment) {
+                stack.currentSegments.add(segment);
+            },
+
+            onUnreachableCodePathSegmentEnd(segment) {
+                stack.currentSegments.delete(segment);
+            },
+
+            onCodePathSegmentEnd(segment) {
+                stack.currentSegments.delete(segment);
+            },
+
+
             // Handle references to prepare verification.
             Identifier(node) {
-                const { codePath, referenceMap } = stack;
+                const { referenceMap } = stack;
                 const reference = referenceMap && referenceMap.get(node);
 
                 // Ignore if this is not a valid variable reference.
@@ -240,7 +255,7 @@ module.exports = {
 
                 // Add a fresh read variable.
                 if (reference.isRead() && !(writeExpr && writeExpr.parent.operator === "=")) {
-                    segmentInfo.markAsRead(codePath.currentSegments, variable);
+                    segmentInfo.markAsRead(stack.currentSegments, variable);
                 }
 
                 /*
@@ -267,16 +282,15 @@ module.exports = {
              * If the reference exists in `outdatedReadVariables` list, report it.
              */
             ":expression:exit"(node) {
-                const { codePath, referenceMap } = stack;
 
                 // referenceMap exists if this is in a resumable function scope.
-                if (!referenceMap) {
+                if (!stack.referenceMap) {
                     return;
                 }
 
                 // Mark the read variables on this code path as outdated.
                 if (node.type === "AwaitExpression" || node.type === "YieldExpression") {
-                    segmentInfo.makeOutdated(codePath.currentSegments);
+                    segmentInfo.makeOutdated(stack.currentSegments);
                 }
 
                 // Verify.
@@ -288,7 +302,7 @@ module.exports = {
                     for (const reference of references) {
                         const variable = reference.resolved;
 
-                        if (segmentInfo.isOutdated(codePath.currentSegments, variable)) {
+                        if (segmentInfo.isOutdated(stack.currentSegments, variable)) {
                             if (node.parent.left === reference.identifier) {
                                 context.report({
                                     node: node.parent,