eslint 8.22.0 → 8.33.0

package/lib/rules/no-underscore-dangle.js

@@ -53,6 +53,14 @@ module.exports = {
                     enforceInClassFields: {
                         type: "boolean",
                         default: false
+                    },
+                    allowInArrayDestructuring: {
+                        type: "boolean",
+                        default: true
+                    },
+                    allowInObjectDestructuring: {
+                        type: "boolean",
+                        default: true
                     }
                 },
                 additionalProperties: false
@@ -74,6 +82,8 @@ module.exports = {
         const enforceInMethodNames = typeof options.enforceInMethodNames !== "undefined" ? options.enforceInMethodNames : false;
         const enforceInClassFields = typeof options.enforceInClassFields !== "undefined" ? options.enforceInClassFields : false;
         const allowFunctionParams = typeof options.allowFunctionParams !== "undefined" ? options.allowFunctionParams : true;
+        const allowInArrayDestructuring = typeof options.allowInArrayDestructuring !== "undefined" ? options.allowInArrayDestructuring : true;
+        const allowInObjectDestructuring = typeof options.allowInObjectDestructuring !== "undefined" ? options.allowInObjectDestructuring : true;
 
         //-------------------------------------------------------------------------
         // Helpers
@@ -195,6 +205,7 @@ module.exports = {
             checkForDanglingUnderscoreInFunctionParameters(node);
         }
 
+
         /**
          * Check if variable expression has a dangling underscore
          * @param {ASTNode} node node to evaluate
@@ -202,18 +213,32 @@ module.exports = {
          * @private
          */
         function checkForDanglingUnderscoreInVariableExpression(node) {
-            const identifier = node.id.name;
+            context.getDeclaredVariables(node).forEach(variable => {
+                const definition = variable.defs.find(def => def.node === node);
+                const identifierNode = definition.name;
+                const identifier = identifierNode.name;
+                let parent = identifierNode.parent;
+
+                while (!["VariableDeclarator", "ArrayPattern", "ObjectPattern"].includes(parent.type)) {
+                    parent = parent.parent;
+                }
 
-            if (typeof identifier !== "undefined" && hasDanglingUnderscore(identifier) &&
-                !isSpecialCaseIdentifierInVariableExpression(identifier) && !isAllowed(identifier)) {
-                context.report({
-                    node,
-                    messageId: "unexpectedUnderscore",
-                    data: {
-                        identifier
-                    }
-                });
-            }
+                if (
+                    hasDanglingUnderscore(identifier) &&
+                    !isSpecialCaseIdentifierInVariableExpression(identifier) &&
+                    !isAllowed(identifier) &&
+                    !(allowInArrayDestructuring && parent.type === "ArrayPattern") &&
+                    !(allowInObjectDestructuring && parent.type === "ObjectPattern")
+                ) {
+                    context.report({
+                        node,
+                        messageId: "unexpectedUnderscore",
+                        data: {
+                            identifier
+                        }
+                    });
+                }
+            });
         }
 
         /**

package/lib/rules/no-unneeded-ternary.js

@@ -144,7 +144,7 @@ module.exports = {
                     context.report({
                         node,
                         messageId: "unnecessaryConditionalAssignment",
-                        fix: fixer => {
+                        fix(fixer) {
                             const shouldParenthesizeAlternate =
                                 (
                                     astUtils.getPrecedence(node.alternate) < OR_PRECEDENCE ||

package/lib/rules/no-use-before-define.js

@@ -68,7 +68,7 @@ function isInClassStaticInitializerRange(node, location) {
 }
 
 /**
- * Checks whether a given scope is the scope of a a class static initializer.
+ * Checks whether a given scope is the scope of a class static initializer.
  * Static initializers are static blocks and initializers of static fields.
  * @param {eslint-scope.Scope} scope A scope to check.
  * @returns {boolean} `true` if the scope is a class static initializer scope.

package/lib/rules/no-useless-computed-key.js

@@ -74,7 +74,7 @@ function hasUselessComputedKey(node) {
 
             return value !== "constructor";
 
-        /* istanbul ignore next */
+        /* c8 ignore next */
         default:
             throw new Error(`Unexpected node type: ${node.type}`);
     }

package/lib/rules/no-var.js

@@ -90,7 +90,7 @@ function getScopeNode(node) {
         }
     }
 
-    /* istanbul ignore next : unreachable */
+    /* c8 ignore next */
     return null;
 }
 
@@ -159,7 +159,7 @@ function hasReferenceInTDZ(node) {
             return !reference.init && (
                 start < idStart ||
                 (defaultValue !== null && start >= defaultStart && end <= defaultEnd) ||
-                (start >= initStart && end <= initEnd)
+                (!astUtils.isFunction(node) && start >= initStart && end <= initEnd)
             );
         });
     };

package/lib/rules/no-warning-comments.js

@@ -37,6 +37,15 @@ module.exports = {
                     },
                     location: {
                         enum: ["start", "anywhere"]
+                    },
+                    decoration: {
+                        type: "array",
+                        items: {
+                            type: "string",
+                            pattern: "^\\S$"
+                        },
+                        minItems: 1,
+                        uniqueItems: true
                     }
                 },
                 additionalProperties: false
@@ -53,6 +62,7 @@ module.exports = {
             configuration = context.options[0] || {},
             warningTerms = configuration.terms || ["todo", "fixme", "xxx"],
             location = configuration.location || "start",
+            decoration = [...configuration.decoration || []].join(""),
             selfConfigRegEx = /\bno-warning-comments\b/u;
 
         /**
@@ -64,6 +74,7 @@ module.exports = {
          */
         function convertToRegExp(term) {
             const escaped = escapeRegExp(term);
+            const escapedDecoration = escapeRegExp(decoration);
 
             /*
              * When matching at the start, ignore leading whitespace, and
@@ -74,18 +85,23 @@ module.exports = {
              *     e.g. terms ["TODO"] matches `//TODO something`
              * $   handles any terms at the end of a comment
              *     e.g. terms ["TODO"] matches `// something TODO`
-             * \s* handles optional leading spaces (for "start" location only)
-             *     e.g. terms ["TODO"] matches `//    TODO something`
              * \b  handles terms preceded/followed by word boundary
              *     e.g. terms: ["!FIX", "FIX!"] matches `// FIX!something` or `// something!FIX`
              *          terms: ["FIX"] matches `// FIX!` or `// !FIX`, but not `// fixed or affix`
+             *
+             * For location start:
+             * [\s]* handles optional leading spaces
+             *     e.g. terms ["TODO"] matches `//    TODO something`
+             * [\s\*]* (where "\*" is the escaped string of decoration)
+             *     handles optional leading spaces or decoration characters (for "start" location only)
+             *     e.g. terms ["TODO"] matches `/**** TODO something ... `
              */
             const wordBoundary = "\\b";
 
             let prefix = "";
 
             if (location === "start") {
-                prefix = "^\\s*";
+                prefix = `^[\\s${escapedDecoration}]*`;
             } else if (/^\w/u.test(term)) {
                 prefix = wordBoundary;
             }
@@ -95,12 +111,15 @@ module.exports = {
 
             /*
              * For location "start", the typical regex is:
-             *   /^\s*ESCAPED_TERM\b/iu.
+             *   /^[\s]*ESCAPED_TERM\b/iu.
+             * Or if decoration characters are specified (e.g. "*"), then any of
+             * those characters may appear in any order at the start:
+             *   /^[\s\*]*ESCAPED_TERM\b/iu.
              *
              * For location "anywhere" the typical regex is
              *   /\bESCAPED_TERM\b/iu
              *
-             * If it starts or ends with non-word character, the prefix and suffix empty, respectively.
+             * If it starts or ends with non-word character, the prefix and suffix are empty, respectively.
              */
             return new RegExp(`${prefix}${escaped}${suffix}`, flags);
         }

package/lib/rules/padded-blocks.js

@@ -186,7 +186,7 @@ module.exports = {
                 case "ClassBody":
                     return options.classes;
 
-                /* istanbul ignore next */
+                /* c8 ignore next */
                 default:
                     throw new Error("unreachable");
             }

package/lib/rules/prefer-arrow-callback.js

@@ -53,7 +53,7 @@ function getVariableOfArguments(scope) {
         }
     }
 
-    /* istanbul ignore next */
+    /* c8 ignore next */
     return null;
 }
 
@@ -126,7 +126,7 @@ function getCallbackInfo(node) {
         parent = parent.parent;
     }
 
-    /* istanbul ignore next */
+    /* c8 ignore next */
     throw new Error("unreachable");
 }
 
@@ -335,6 +335,7 @@ module.exports = {
                             // Convert the function expression to an arrow function.
                             const functionToken = sourceCode.getFirstToken(node, node.async ? 1 : 0);
                             const leftParenToken = sourceCode.getTokenAfter(functionToken, astUtils.isOpeningParenToken);
+                            const tokenBeforeBody = sourceCode.getTokenBefore(node.body);
 
                             if (sourceCode.commentsExistBetween(functionToken, leftParenToken)) {
 
@@ -348,7 +349,7 @@ module.exports = {
                                 // Remove extra tokens and spaces.
                                 yield fixer.removeRange([functionToken.range[0], leftParenToken.range[0]]);
                             }
-                            yield fixer.insertTextBefore(node.body, "=> ");
+                            yield fixer.insertTextAfter(tokenBeforeBody, " =>");
 
                             // Get the node that will become the new arrow function.
                             let replacedNode = callbackInfo.isLexicalThis ? node.parent.parent : node;

package/lib/rules/prefer-const.js

@@ -446,7 +446,19 @@ module.exports = {
 
                         reportCount += nodesToReport.length;
 
-                        shouldFix = shouldFix && (reportCount === varDeclParent.declarations.length);
+                        let totalDeclarationsCount = 0;
+
+                        varDeclParent.declarations.forEach(declaration => {
+                            if (declaration.id.type === "ObjectPattern") {
+                                totalDeclarationsCount += declaration.id.properties.length;
+                            } else if (declaration.id.type === "ArrayPattern") {
+                                totalDeclarationsCount += declaration.id.elements.length;
+                            } else {
+                                totalDeclarationsCount += 1;
+                            }
+                        });
+
+                        shouldFix = shouldFix && (reportCount === totalDeclarationsCount);
                     }
                 }
 

package/lib/rules/prefer-named-capture-group.js

@@ -23,6 +23,61 @@ const regexpp = require("regexpp");
 
 const parser = new regexpp.RegExpParser();
 
+/**
+ * Creates fixer suggestions for the regex, if statically determinable.
+ * @param {number} groupStart Starting index of the regex group.
+ * @param {string} pattern The regular expression pattern to be checked.
+ * @param {string} rawText Source text of the regexNode.
+ * @param {ASTNode} regexNode AST node which contains the regular expression.
+ * @returns {Array<SuggestionResult>} Fixer suggestions for the regex, if statically determinable.
+ */
+function suggestIfPossible(groupStart, pattern, rawText, regexNode) {
+    switch (regexNode.type) {
+        case "Literal":
+            if (typeof regexNode.value === "string" && rawText.includes("\\")) {
+                return null;
+            }
+            break;
+        case "TemplateLiteral":
+            if (regexNode.expressions.length || rawText.slice(1, -1) !== pattern) {
+                return null;
+            }
+            break;
+        default:
+            return null;
+    }
+
+    const start = regexNode.range[0] + groupStart + 2;
+
+    return [
+        {
+            fix(fixer) {
+                const existingTemps = pattern.match(/temp\d+/gu) || [];
+                const highestTempCount = existingTemps.reduce(
+                    (previous, next) =>
+                        Math.max(previous, Number(next.slice("temp".length))),
+                    0
+                );
+
+                return fixer.insertTextBeforeRange(
+                    [start, start],
+                    `?<temp${highestTempCount + 1}>`
+                );
+            },
+            messageId: "addGroupName"
+        },
+        {
+            fix(fixer) {
+                return fixer.insertTextBeforeRange(
+                    [start, start],
+                    "?:"
+                );
+            },
+            messageId: "addNonCapture"
+        }
+    ];
+}
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -38,23 +93,29 @@ module.exports = {
             url: "https://eslint.org/docs/rules/prefer-named-capture-group"
         },
 
+        hasSuggestions: true,
+
         schema: [],
 
         messages: {
+            addGroupName: "Add name to capture group.",
+            addNonCapture: "Convert group to non-capturing.",
             required: "Capture group '{{group}}' should be converted to a named or non-capturing group."
         }
     },
 
     create(context) {
+        const sourceCode = context.getSourceCode();
 
         /**
          * Function to check regular expression.
-         * @param {string} pattern The regular expression pattern to be check.
-         * @param {ASTNode} node AST node which contains regular expression.
+         * @param {string} pattern The regular expression pattern to be checked.
+         * @param {ASTNode} node AST node which contains the regular expression or a call/new expression.
+         * @param {ASTNode} regexNode AST node which contains the regular expression.
          * @param {boolean} uFlag Flag indicates whether unicode mode is enabled or not.
          * @returns {void}
          */
-        function checkRegex(pattern, node, uFlag) {
+        function checkRegex(pattern, node, regexNode, uFlag) {
             let ast;
 
             try {
@@ -68,12 +129,16 @@ module.exports = {
             regexpp.visitRegExpAST(ast, {
                 onCapturingGroupEnter(group) {
                     if (!group.name) {
+                        const rawText = sourceCode.getText(regexNode);
+                        const suggest = suggestIfPossible(group.start, pattern, rawText, regexNode);
+
                         context.report({
                             node,
                             messageId: "required",
                             data: {
                                 group: group.raw
-                            }
+                            },
+                            suggest
                         });
                     }
                 }
@@ -83,7 +148,7 @@ module.exports = {
         return {
             Literal(node) {
                 if (node.regex) {
-                    checkRegex(node.regex.pattern, node, node.regex.flags.includes("u"));
+                    checkRegex(node.regex.pattern, node, node, node.regex.flags.includes("u"));
                 }
             },
             Program() {
@@ -101,7 +166,7 @@ module.exports = {
                     const flags = getStringIfConstant(node.arguments[1]);
 
                     if (regex) {
-                        checkRegex(regex, node, flags && flags.includes("u"));
+                        checkRegex(regex, node, node.arguments[0], flags && flags.includes("u"));
                     }
                 }
             }

package/lib/rules/prefer-object-spread.js

@@ -247,7 +247,7 @@ module.exports = {
 
         docs: {
             description:
-                "Disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead.",
+                "Disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead",
             recommended: false,
             url: "https://eslint.org/docs/rules/prefer-object-spread"
         },

package/lib/rules/prefer-regex-literals.js

@@ -146,6 +146,8 @@ module.exports = {
         messages: {
             unexpectedRegExp: "Use a regular expression literal instead of the 'RegExp' constructor.",
             replaceWithLiteral: "Replace with an equivalent regular expression literal.",
+            replaceWithLiteralAndFlags: "Replace with an equivalent regular expression literal with flags '{{ flags }}'.",
+            replaceWithIntendedLiteralAndFlags: "Replace with a regular expression literal with flags '{{ flags }}'.",
             unexpectedRedundantRegExp: "Regular expression literal is unnecessarily wrapped within a 'RegExp' constructor.",
             unexpectedRedundantRegExpWithFlags: "Use regular expression literal with flags instead of the 'RegExp' constructor."
         }
@@ -248,16 +250,18 @@ module.exports = {
 
         /**
          * Returns a ecmaVersion compatible for regexpp.
-         * @param {any} ecmaVersion The ecmaVersion to convert.
+         * @param {number} ecmaVersion The ecmaVersion to convert.
          * @returns {import("regexpp/ecma-versions").EcmaVersion} The resulting ecmaVersion compatible for regexpp.
          */
         function getRegexppEcmaVersion(ecmaVersion) {
-            if (typeof ecmaVersion !== "number" || ecmaVersion <= 5) {
+            if (ecmaVersion <= 5) {
                 return 5;
             }
-            return Math.min(ecmaVersion + 2009, REGEXPP_LATEST_ECMA_VERSION);
+            return Math.min(ecmaVersion, REGEXPP_LATEST_ECMA_VERSION);
         }
 
+        const regexppEcmaVersion = getRegexppEcmaVersion(context.languageOptions.ecmaVersion);
+
         /**
          * Makes a character escaped or else returns null.
          * @param {string} character The character to escape.
@@ -293,6 +297,83 @@ module.exports = {
             }
         }
 
+        /**
+         * Checks whether the given regex and flags are valid for the ecma version or not.
+         * @param {string} pattern The regex pattern to check.
+         * @param {string | undefined} flags The regex flags to check.
+         * @returns {boolean} True if the given regex pattern and flags are valid for the ecma version.
+         */
+        function isValidRegexForEcmaVersion(pattern, flags) {
+            const validator = new RegExpValidator({ ecmaVersion: regexppEcmaVersion });
+
+            try {
+                validator.validatePattern(pattern, 0, pattern.length, flags ? flags.includes("u") : false);
+                if (flags) {
+                    validator.validateFlags(flags);
+                }
+                return true;
+            } catch {
+                return false;
+            }
+        }
+
+        /**
+         * Checks whether two given regex flags contain the same flags or not.
+         * @param {string} flagsA The regex flags.
+         * @param {string} flagsB The regex flags.
+         * @returns {boolean} True if two regex flags contain same flags.
+         */
+        function areFlagsEqual(flagsA, flagsB) {
+            return [...flagsA].sort().join("") === [...flagsB].sort().join("");
+        }
+
+
+        /**
+         * Merges two regex flags.
+         * @param {string} flagsA The regex flags.
+         * @param {string} flagsB The regex flags.
+         * @returns {string} The merged regex flags.
+         */
+        function mergeRegexFlags(flagsA, flagsB) {
+            const flagsSet = new Set([
+                ...flagsA,
+                ...flagsB
+            ]);
+
+            return [...flagsSet].join("");
+        }
+
+        /**
+         * Checks whether a give node can be fixed to the given regex pattern and flags.
+         * @param {ASTNode} node The node to check.
+         * @param {string} pattern The regex pattern to check.
+         * @param {string} flags The regex flags
+         * @returns {boolean} True if a node can be fixed to the given regex pattern and flags.
+         */
+        function canFixTo(node, pattern, flags) {
+            const tokenBefore = sourceCode.getTokenBefore(node);
+
+            return sourceCode.getCommentsInside(node).length === 0 &&
+                (!tokenBefore || validPrecedingTokens.has(tokenBefore.value)) &&
+                isValidRegexForEcmaVersion(pattern, flags);
+        }
+
+        /**
+         * Returns a safe output code considering the before and after tokens.
+         * @param {ASTNode} node The regex node.
+         * @param {string} newRegExpValue The new regex expression value.
+         * @returns {string} The output code.
+         */
+        function getSafeOutput(node, newRegExpValue) {
+            const tokenBefore = sourceCode.getTokenBefore(node);
+            const tokenAfter = sourceCode.getTokenAfter(node);
+
+            return (tokenBefore && !canTokensBeAdjacent(tokenBefore, newRegExpValue) && tokenBefore.range[1] === node.range[0] ? " " : "") +
+                newRegExpValue +
+            (tokenAfter && !canTokensBeAdjacent(newRegExpValue, tokenAfter) && node.range[1] === tokenAfter.range[0] ? " " : "");
+
+        }
+
         return {
             Program() {
                 const scope = context.getScope();
@@ -306,10 +387,69 @@ module.exports = {
 
                 for (const { node } of tracker.iterateGlobalReferences(traceMap)) {
                     if (disallowRedundantWrapping && isUnnecessarilyWrappedRegexLiteral(node)) {
+                        const regexNode = node.arguments[0];
+
                         if (node.arguments.length === 2) {
-                            context.report({ node, messageId: "unexpectedRedundantRegExpWithFlags" });
+                            const suggests = [];
+
+                            const argFlags = getStringValue(node.arguments[1]) || "";
+
+                            if (canFixTo(node, regexNode.regex.pattern, argFlags)) {
+                                suggests.push({
+                                    messageId: "replaceWithLiteralAndFlags",
+                                    pattern: regexNode.regex.pattern,
+                                    flags: argFlags
+                                });
+                            }
+
+                            const literalFlags = regexNode.regex.flags || "";
+                            const mergedFlags = mergeRegexFlags(literalFlags, argFlags);
+
+                            if (
+                                !areFlagsEqual(mergedFlags, argFlags) &&
+                                canFixTo(node, regexNode.regex.pattern, mergedFlags)
+                            ) {
+                                suggests.push({
+                                    messageId: "replaceWithIntendedLiteralAndFlags",
+                                    pattern: regexNode.regex.pattern,
+                                    flags: mergedFlags
+                                });
+                            }
+
+                            context.report({
+                                node,
+                                messageId: "unexpectedRedundantRegExpWithFlags",
+                                suggest: suggests.map(({ flags, pattern, messageId }) => ({
+                                    messageId,
+                                    data: {
+                                        flags
+                                    },
+                                    fix(fixer) {
+                                        return fixer.replaceText(node, getSafeOutput(node, `/${pattern}/${flags}`));
+                                    }
+                                }))
+                            });
                         } else {
-                            context.report({ node, messageId: "unexpectedRedundantRegExp" });
+                            const outputs = [];
+
+                            if (canFixTo(node, regexNode.regex.pattern, regexNode.regex.flags)) {
+                                outputs.push(sourceCode.getText(regexNode));
+                            }
+
+
+                            context.report({
+                                node,
+                                messageId: "unexpectedRedundantRegExp",
+                                suggest: outputs.map(output => ({
+                                    messageId: "replaceWithLiteral",
+                                    fix(fixer) {
+                                        return fixer.replaceText(
+                                            node,
+                                            getSafeOutput(node, output)
+                                        );
+                                    }
+                                }))
+                            });
                         }
                     } else if (hasOnlyStaticStringArguments(node)) {
                         let regexContent = getStringValue(node.arguments[0]);
@@ -320,21 +460,7 @@ module.exports = {
                             flags = getStringValue(node.arguments[1]);
                         }
 
-                        const regexppEcmaVersion = getRegexppEcmaVersion(context.parserOptions.ecmaVersion);
-                        const RegExpValidatorInstance = new RegExpValidator({ ecmaVersion: regexppEcmaVersion });
-
-                        try {
-                            RegExpValidatorInstance.validatePattern(regexContent, 0, regexContent.length, flags ? flags.includes("u") : false);
-                            if (flags) {
-                                RegExpValidatorInstance.validateFlags(flags);
-                            }
-                        } catch {
-                            noFix = true;
-                        }
-
-                        const tokenBefore = sourceCode.getTokenBefore(node);
-
-                        if (tokenBefore && !validPrecedingTokens.has(tokenBefore.value)) {
+                        if (!canFixTo(node, regexContent, flags)) {
                             noFix = true;
                         }
 
@@ -342,10 +468,6 @@ module.exports = {
                             noFix = true;
                         }
 
-                        if (sourceCode.getCommentsInside(node).length > 0) {
-                            noFix = true;
-                        }
-
                         if (regexContent && !noFix) {
                             let charIncrease = 0;
 
@@ -377,14 +499,7 @@ module.exports = {
                             suggest: noFix ? [] : [{
                                 messageId: "replaceWithLiteral",
                                 fix(fixer) {
-                                    const tokenAfter = sourceCode.getTokenAfter(node);
-
-                                    return fixer.replaceText(
-                                        node,
-                                        (tokenBefore && !canTokensBeAdjacent(tokenBefore, newRegExpValue) && tokenBefore.range[1] === node.range[0] ? " " : "") +
-                                            newRegExpValue +
-                                            (tokenAfter && !canTokensBeAdjacent(newRegExpValue, tokenAfter) && node.range[1] === tokenAfter.range[0] ? " " : "")
-                                    );
+                                    return fixer.replaceText(node, getSafeOutput(node, newRegExpValue));
                                 }
                             }]
                         });

package/lib/rules/prefer-rest-params.js

@@ -30,7 +30,7 @@ function getVariableOfArguments(scope) {
         }
     }
 
-    /* istanbul ignore next : unreachable */
+    /* c8 ignore next */
     return null;
 }
 

package/lib/rules/require-yield.js

@@ -68,7 +68,6 @@ module.exports = {
             // Increases the count of `yield` keyword.
             YieldExpression() {
 
-                /* istanbul ignore else */
                 if (stack.length > 0) {
                     stack[stack.length - 1] += 1;
                 }