eslint 9.0.0-rc.0 → 9.0.0

package/lib/rules/constructor-super.js

@@ -9,22 +9,6 @@
 // Helpers
 //------------------------------------------------------------------------------
 
-/**
- * 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 node is a constructor.
  * @param {ASTNode} node A node to check. This node type is one of
@@ -165,8 +149,7 @@ module.exports = {
             missingAll: "Expected to call 'super()'.",
 
             duplicate: "Unexpected duplicate 'super()'.",
-            badSuper: "Unexpected 'super()' because 'super' is not a constructor.",
-            unexpected: "Unexpected 'super()'."
+            badSuper: "Unexpected 'super()' because 'super' is not a constructor."
         }
     },
 
@@ -186,7 +169,7 @@ module.exports = {
         /**
          * @type {Record<string, SegmentInfo>}
          */
-        let segInfoMap = Object.create(null);
+        const segInfoMap = Object.create(null);
 
         /**
          * Gets the flag which shows `super()` is called in some paths.
@@ -194,7 +177,7 @@ module.exports = {
          * @returns {boolean} The flag which shows `super()` is called in some paths
          */
         function isCalledInSomePath(segment) {
-            return segment.reachable && segInfoMap[segment.id]?.calledInSomePaths;
+            return segment.reachable && segInfoMap[segment.id].calledInSomePaths;
         }
 
         /**
@@ -212,17 +195,6 @@ module.exports = {
          * @returns {boolean} The flag which shows `super()` is called in all paths.
          */
         function isCalledInEveryPath(segment) {
-
-            /*
-             * If specific segment is the looped segment of the current segment,
-             * skip the segment.
-             * If not skipped, this never becomes true after a loop.
-             */
-            if (segment.nextSegments.length === 1 &&
-                segment.nextSegments[0]?.isLoopedPrevSegment(segment)) {
-                return true;
-            }
-
             return segment.reachable && segInfoMap[segment.id].calledInEveryPaths;
         }
 
@@ -279,9 +251,9 @@ module.exports = {
                 }
 
                 // Reports if `super()` lacked.
-                const seenSegments = codePath.returnedSegments.filter(hasSegmentBeenSeen);
-                const calledInEveryPaths = seenSegments.every(isCalledInEveryPath);
-                const calledInSomePaths = seenSegments.some(isCalledInSomePath);
+                const returnedSegments = codePath.returnedSegments;
+                const calledInEveryPaths = returnedSegments.every(isCalledInEveryPath);
+                const calledInSomePaths = returnedSegments.some(isCalledInSomePath);
 
                 if (!calledInEveryPaths) {
                     context.report({
@@ -296,28 +268,38 @@ module.exports = {
             /**
              * Initialize information of a given code path segment.
              * @param {CodePathSegment} segment A code path segment to initialize.
+             * @param {CodePathSegment} node Node that starts the segment.
              * @returns {void}
              */
-            onCodePathSegmentStart(segment) {
+            onCodePathSegmentStart(segment, node) {
 
                 funcInfo.currentSegments.add(segment);
 
-                if (!(funcInfo && funcInfo.isConstructor && funcInfo.hasExtends)) {
+                if (!(funcInfo.isConstructor && funcInfo.hasExtends)) {
                     return;
                 }
 
                 // Initialize info.
                 const info = segInfoMap[segment.id] = new SegmentInfo();
 
-                // When there are previous segments, aggregates these.
-                const prevSegments = segment.prevSegments;
-
-                if (prevSegments.length > 0) {
-                    const seenPrevSegments = prevSegments.filter(hasSegmentBeenSeen);
+                const seenPrevSegments = segment.prevSegments.filter(hasSegmentBeenSeen);
 
+                // When there are previous segments, aggregates these.
+                if (seenPrevSegments.length > 0) {
                     info.calledInSomePaths = seenPrevSegments.some(isCalledInSomePath);
                     info.calledInEveryPaths = seenPrevSegments.every(isCalledInEveryPath);
                 }
+
+                /*
+                 * ForStatement > *.update segments are a special case as they are created in advance,
+                 * without seen previous segments. Since they logically don't affect `calledInEveryPaths`
+                 * calculations, and they can never be a lone previous segment of another one, we'll set
+                 * their `calledInEveryPaths` to `true` to effectively ignore them in those calculations.
+                 * .
+                 */
+                if (node.parent && node.parent.type === "ForStatement" && node.parent.update === node) {
+                    info.calledInEveryPaths = true;
+                }
             },
 
             onUnreachableCodePathSegmentStart(segment) {
@@ -343,25 +325,30 @@ module.exports = {
              * @returns {void}
              */
             onCodePathSegmentLoop(fromSegment, toSegment) {
-                if (!(funcInfo && funcInfo.isConstructor && funcInfo.hasExtends)) {
+                if (!(funcInfo.isConstructor && funcInfo.hasExtends)) {
                     return;
                 }
 
-                // Update information inside of the loop.
-                const isRealLoop = toSegment.prevSegments.length >= 2;
-
                 funcInfo.codePath.traverseSegments(
                     { first: toSegment, last: fromSegment },
-                    segment => {
-                        const info = segInfoMap[segment.id] ?? new SegmentInfo();
+                    (segment, controller) => {
+                        const info = segInfoMap[segment.id];
+
+                        // skip segments after the loop
+                        if (!info) {
+                            controller.skip();
+                            return;
+                        }
+
                         const seenPrevSegments = segment.prevSegments.filter(hasSegmentBeenSeen);
+                        const calledInSomePreviousPaths = seenPrevSegments.some(isCalledInSomePath);
+                        const calledInEveryPreviousPaths = seenPrevSegments.every(isCalledInEveryPath);
 
-                        // Updates flags.
-                        info.calledInSomePaths = seenPrevSegments.some(isCalledInSomePath);
-                        info.calledInEveryPaths = seenPrevSegments.every(isCalledInEveryPath);
+                        info.calledInSomePaths ||= calledInSomePreviousPaths;
+                        info.calledInEveryPaths ||= calledInEveryPreviousPaths;
 
                         // If flags become true anew, reports the valid nodes.
-                        if (info.calledInSomePaths || isRealLoop) {
+                        if (calledInSomePreviousPaths) {
                             const nodes = info.validNodes;
 
                             info.validNodes = [];
@@ -375,9 +362,6 @@ module.exports = {
                                 });
                             }
                         }
-
-                        // save just in case we created a new SegmentInfo object
-                        segInfoMap[segment.id] = info;
                     }
                 );
             },
@@ -388,7 +372,7 @@ module.exports = {
              * @returns {void}
              */
             "CallExpression:exit"(node) {
-                if (!(funcInfo && funcInfo.isConstructor)) {
+                if (!(funcInfo.isConstructor && funcInfo.hasExtends)) {
                     return;
                 }
 
@@ -398,41 +382,34 @@ module.exports = {
                 }
 
                 // Reports if needed.
-                if (funcInfo.hasExtends) {
-                    const segments = funcInfo.currentSegments;
-                    let duplicate = false;
-                    let info = null;
+                const segments = funcInfo.currentSegments;
+                let duplicate = false;
+                let info = null;
 
-                    for (const segment of segments) {
+                for (const segment of segments) {
 
-                        if (segment.reachable) {
-                            info = segInfoMap[segment.id];
+                    if (segment.reachable) {
+                        info = segInfoMap[segment.id];
 
-                            duplicate = duplicate || info.calledInSomePaths;
-                            info.calledInSomePaths = info.calledInEveryPaths = true;
-                        }
+                        duplicate = duplicate || info.calledInSomePaths;
+                        info.calledInSomePaths = info.calledInEveryPaths = true;
                     }
+                }
 
-                    if (info) {
-                        if (duplicate) {
-                            context.report({
-                                messageId: "duplicate",
-                                node
-                            });
-                        } else if (!funcInfo.superIsConstructor) {
-                            context.report({
-                                messageId: "badSuper",
-                                node
-                            });
-                        } else {
-                            info.validNodes.push(node);
-                        }
+                if (info) {
+                    if (duplicate) {
+                        context.report({
+                            messageId: "duplicate",
+                            node
+                        });
+                    } else if (!funcInfo.superIsConstructor) {
+                        context.report({
+                            messageId: "badSuper",
+                            node
+                        });
+                    } else {
+                        info.validNodes.push(node);
                     }
-                } else if (isAnySegmentReachable(funcInfo.currentSegments)) {
-                    context.report({
-                        messageId: "unexpected",
-                        node
-                    });
                 }
             },
 
@@ -442,7 +419,7 @@ module.exports = {
              * @returns {void}
              */
             ReturnStatement(node) {
-                if (!(funcInfo && funcInfo.isConstructor && funcInfo.hasExtends)) {
+                if (!(funcInfo.isConstructor && funcInfo.hasExtends)) {
                     return;
                 }
 
@@ -462,14 +439,6 @@ module.exports = {
                         info.calledInSomePaths = info.calledInEveryPaths = true;
                     }
                 }
-            },
-
-            /**
-             * Resets state.
-             * @returns {void}
-             */
-            "Program:exit"() {
-                segInfoMap = Object.create(null);
             }
         };
     }

package/lib/rules/no-lone-blocks.js

@@ -117,7 +117,7 @@ module.exports = {
             };
 
             ruleDef.VariableDeclaration = function(node) {
-                if (node.kind === "let" || node.kind === "const") {
+                if (node.kind !== "var") {
                     markLoneBlock(node);
                 }
             };

package/lib/rules/no-unused-vars.js

@@ -15,6 +15,11 @@ const astUtils = require("./utils/ast-utils");
 // Typedefs
 //------------------------------------------------------------------------------
 
+/**
+ * A simple name for the types of variables that this rule supports
+ * @typedef {'array-destructure'|'catch-clause'|'parameter'|'variable'} VariableType
+ */
+
 /**
  * Bag of data used for formatting the `unusedVar` lint message.
  * @typedef {Object} UnusedVarMessageData
@@ -23,6 +28,13 @@ const astUtils = require("./utils/ast-utils");
  * @property {string} additional Any additional info to be appended at the end.
  */
 
+/**
+ * Bag of data used for formatting the `usedIgnoredVar` lint message.
+ * @typedef {Object} UsedIgnoredVarMessageData
+ * @property {string} varName The name of the unused var.
+ * @property {string} additional Any additional info to be appended at the end.
+ */
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -73,6 +85,9 @@ module.exports = {
                             },
                             ignoreClassWithStaticInitBlock: {
                                 type: "boolean"
+                            },
+                            reportUsedIgnorePattern: {
+                                type: "boolean"
                             }
                         },
                         additionalProperties: false
@@ -82,7 +97,8 @@ module.exports = {
         ],
 
         messages: {
-            unusedVar: "'{{varName}}' is {{action}} but never used{{additional}}."
+            unusedVar: "'{{varName}}' is {{action}} but never used{{additional}}.",
+            usedIgnoredVar: "'{{varName}}' is marked as ignored but is used{{additional}}."
         }
     },
 
@@ -96,7 +112,8 @@ module.exports = {
             args: "after-used",
             ignoreRestSiblings: false,
             caughtErrors: "all",
-            ignoreClassWithStaticInitBlock: false
+            ignoreClassWithStaticInitBlock: false,
+            reportUsedIgnorePattern: false
         };
 
         const firstOption = context.options[0];
@@ -110,6 +127,7 @@ module.exports = {
                 config.ignoreRestSiblings = firstOption.ignoreRestSiblings || config.ignoreRestSiblings;
                 config.caughtErrors = firstOption.caughtErrors || config.caughtErrors;
                 config.ignoreClassWithStaticInitBlock = firstOption.ignoreClassWithStaticInitBlock || config.ignoreClassWithStaticInitBlock;
+                config.reportUsedIgnorePattern = firstOption.reportUsedIgnorePattern || config.reportUsedIgnorePattern;
 
                 if (firstOption.varsIgnorePattern) {
                     config.varsIgnorePattern = new RegExp(firstOption.varsIgnorePattern, "u");
@@ -129,6 +147,50 @@ module.exports = {
             }
         }
 
+        /**
+         * Gets a given variable's description and configured ignore pattern
+         * based on the provided variableType
+         * @param {VariableType} variableType a simple name for the types of variables that this rule supports
+         * @throws {Error} (Unreachable)
+         * @returns {[string | undefined, string | undefined]} the given variable's description and
+         * ignore pattern
+         */
+        function getVariableDescription(variableType) {
+            let pattern;
+            let variableDescription;
+
+            switch (variableType) {
+                case "array-destructure":
+                    pattern = config.destructuredArrayIgnorePattern;
+                    variableDescription = "elements of array destructuring";
+                    break;
+
+                case "catch-clause":
+                    pattern = config.caughtErrorsIgnorePattern;
+                    variableDescription = "args";
+                    break;
+
+                case "parameter":
+                    pattern = config.argsIgnorePattern;
+                    variableDescription = "args";
+                    break;
+
+                case "variable":
+                    pattern = config.varsIgnorePattern;
+                    variableDescription = "vars";
+                    break;
+
+                default:
+                    throw new Error(`Unexpected variable type: ${variableType}`);
+            }
+
+            if (pattern) {
+                pattern = pattern.toString();
+            }
+
+            return [variableDescription, pattern];
+        }
+
         /**
          * Generates the message data about the variable being defined and unused,
          * including the ignore pattern if configured.
@@ -136,27 +198,42 @@ module.exports = {
          * @returns {UnusedVarMessageData} The message data to be used with this unused variable.
          */
         function getDefinedMessageData(unusedVar) {
-            const defType = unusedVar.defs && unusedVar.defs[0] && unusedVar.defs[0].type;
-            let type;
-            let pattern;
+            const def = unusedVar.defs && unusedVar.defs[0];
+            let additionalMessageData = "";
 
-            if (defType === "CatchClause" && config.caughtErrorsIgnorePattern) {
-                type = "args";
-                pattern = config.caughtErrorsIgnorePattern.toString();
-            } else if (defType === "Parameter" && config.argsIgnorePattern) {
-                type = "args";
-                pattern = config.argsIgnorePattern.toString();
-            } else if (defType !== "Parameter" && defType !== "CatchClause" && config.varsIgnorePattern) {
-                type = "vars";
-                pattern = config.varsIgnorePattern.toString();
-            }
+            if (def) {
+                let pattern;
+                let variableDescription;
+
+                switch (def.type) {
+                    case "CatchClause":
+                        if (config.caughtErrorsIgnorePattern) {
+                            [variableDescription, pattern] = getVariableDescription("catch-clause");
+                        }
+                        break;
 
-            const additional = type ? `. Allowed unused ${type} must match ${pattern}` : "";
+                    case "Parameter":
+                        if (config.argsIgnorePattern) {
+                            [variableDescription, pattern] = getVariableDescription("parameter");
+                        }
+                        break;
+
+                    default:
+                        if (config.varsIgnorePattern) {
+                            [variableDescription, pattern] = getVariableDescription("variable");
+                        }
+                        break;
+                }
+
+                if (pattern && variableDescription) {
+                    additionalMessageData = `. Allowed unused ${variableDescription} must match ${pattern}`;
+                }
+            }
 
             return {
                 varName: unusedVar.name,
                 action: "defined",
-                additional
+                additional: additionalMessageData
             };
         }
 
@@ -167,19 +244,51 @@ module.exports = {
          * @returns {UnusedVarMessageData} The message data to be used with this unused variable.
          */
         function getAssignedMessageData(unusedVar) {
-            const def = unusedVar.defs[0];
-            let additional = "";
+            const def = unusedVar.defs && unusedVar.defs[0];
+            let additionalMessageData = "";
+
+            if (def) {
+                let pattern;
+                let variableDescription;
 
-            if (config.destructuredArrayIgnorePattern && def && def.name.parent.type === "ArrayPattern") {
-                additional = `. Allowed unused elements of array destructuring patterns must match ${config.destructuredArrayIgnorePattern.toString()}`;
-            } else if (config.varsIgnorePattern) {
-                additional = `. Allowed unused vars must match ${config.varsIgnorePattern.toString()}`;
+                if (def.name.parent.type === "ArrayPattern" && config.destructuredArrayIgnorePattern) {
+                    [variableDescription, pattern] = getVariableDescription("array-destructure");
+                } else if (config.varsIgnorePattern) {
+                    [variableDescription, pattern] = getVariableDescription("variable");
+                }
+
+                if (pattern && variableDescription) {
+                    additionalMessageData = `. Allowed unused ${variableDescription} must match ${pattern}`;
+                }
             }
 
             return {
                 varName: unusedVar.name,
                 action: "assigned a value",
-                additional
+                additional: additionalMessageData
+            };
+        }
+
+        /**
+         * Generate the warning message about a variable being used even though
+         * it is marked as being ignored.
+         * @param {Variable} variable eslint-scope variable object
+         * @param {VariableType} variableType a simple name for the types of variables that this rule supports
+         * @returns {UsedIgnoredVarMessageData} The message data to be used with
+         * this used ignored variable.
+         */
+        function getUsedIgnoredMessageData(variable, variableType) {
+            const [variableDescription, pattern] = getVariableDescription(variableType);
+
+            let additionalMessageData = "";
+
+            if (pattern && variableDescription) {
+                additionalMessageData = `. Used ${variableDescription} must not match ${pattern}`;
+            }
+
+            return {
+                varName: variable.name,
+                additional: additionalMessageData
             };
         }
 
@@ -532,8 +641,13 @@ module.exports = {
          * @private
          */
         function isUsedVariable(variable) {
-            const functionNodes = getFunctionDefinitions(variable),
-                isFunctionDefinition = functionNodes.length > 0;
+            if (variable.eslintUsed) {
+                return true;
+            }
+
+            const functionNodes = getFunctionDefinitions(variable);
+            const isFunctionDefinition = functionNodes.length > 0;
+
             let rhsNode = null;
 
             return variable.references.some(ref => {
@@ -589,8 +703,13 @@ module.exports = {
                         continue;
                     }
 
-                    // skip function expression names and variables marked with markVariableAsUsed()
-                    if (scope.functionExpressionScope || variable.eslintUsed) {
+                    // skip function expression names
+                    if (scope.functionExpressionScope) {
+                        continue;
+                    }
+
+                    // skip variables marked with markVariableAsUsed()
+                    if (!config.reportUsedIgnorePattern && variable.eslintUsed) {
                         continue;
                     }
 
@@ -615,6 +734,14 @@ module.exports = {
                             config.destructuredArrayIgnorePattern &&
                             config.destructuredArrayIgnorePattern.test(def.name.name)
                         ) {
+                            if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {
+                                context.report({
+                                    node: def.name,
+                                    messageId: "usedIgnoredVar",
+                                    data: getUsedIgnoredMessageData(variable, "array-destructure")
+                                });
+                            }
+
                             continue;
                         }
 
@@ -634,6 +761,14 @@ module.exports = {
 
                             // skip ignored parameters
                             if (config.caughtErrorsIgnorePattern && config.caughtErrorsIgnorePattern.test(def.name.name)) {
+                                if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {
+                                    context.report({
+                                        node: def.name,
+                                        messageId: "usedIgnoredVar",
+                                        data: getUsedIgnoredMessageData(variable, "catch-clause")
+                                    });
+                                }
+
                                 continue;
                             }
                         } else if (type === "Parameter") {
@@ -650,6 +785,14 @@ module.exports = {
 
                             // skip ignored parameters
                             if (config.argsIgnorePattern && config.argsIgnorePattern.test(def.name.name)) {
+                                if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {
+                                    context.report({
+                                        node: def.name,
+                                        messageId: "usedIgnoredVar",
+                                        data: getUsedIgnoredMessageData(variable, "parameter")
+                                    });
+                                }
+
                                 continue;
                             }
 
@@ -661,6 +804,14 @@ module.exports = {
 
                             // skip ignored variables
                             if (config.varsIgnorePattern && config.varsIgnorePattern.test(def.name.name)) {
+                                if (config.reportUsedIgnorePattern && isUsedVariable(variable)) {
+                                    context.report({
+                                        node: def.name,
+                                        messageId: "usedIgnoredVar",
+                                        data: getUsedIgnoredMessageData(variable, "variable")
+                                    });
+                                }
+
                                 continue;
                             }
                         }
@@ -724,6 +875,5 @@ module.exports = {
                 }
             }
         };
-
     }
 };

package/lib/rules/use-isnan.js

@@ -182,7 +182,7 @@ module.exports = {
 
                 if (
                     (methodName === "indexOf" || methodName === "lastIndexOf") &&
-                    node.arguments.length === 1 &&
+                    node.arguments.length <= 2 &&
                     isNaNIdentifier(node.arguments[0])
                 ) {
 
@@ -190,7 +190,7 @@ module.exports = {
                      * To retain side effects, it's essential to address `NaN` beforehand, which
                      * is not possible with fixes like `arr.findIndex(Number.isNaN)`.
                      */
-                    const isSuggestable = node.arguments[0].type !== "SequenceExpression";
+                    const isSuggestable = node.arguments[0].type !== "SequenceExpression" && !node.arguments[1];
                     const suggestedFixes = [];
 
                     if (isSuggestable) {

package/lib/shared/stats.js

@@ -0,0 +1,30 @@
+/**
+ * @fileoverview Provides helper functions to start/stop the time measurements
+ * that are provided by the ESLint 'stats' option.
+ * @author Mara Kiefer <http://github.com/mnkiefer>
+ */
+"use strict";
+
+/**
+ * Start time measurement
+ * @returns {[number, number]} t variable for tracking time
+ */
+function startTime() {
+    return process.hrtime();
+}
+
+/**
+ * End time measurement
+ * @param {[number, number]} t Variable for tracking time
+ * @returns {number} The measured time in milliseconds
+ */
+function endTime(t) {
+    const time = process.hrtime(t);
+
+    return time[0] * 1e3 + time[1] / 1e6;
+}
+
+module.exports = {
+    startTime,
+    endTime
+};