eslint 8.39.0 → 8.47.0

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

@@ -6,7 +6,12 @@
 "use strict";
 
 const astUtils = require("./utils/ast-utils");
+const { RegExpParser, visitRegExpAST } = require("@eslint-community/regexpp");
 
+/**
+ * @typedef {import('@eslint-community/regexpp').AST.CharacterClass} CharacterClass
+ * @typedef {import('@eslint-community/regexpp').AST.ExpressionCharacterClass} ExpressionCharacterClass
+ */
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -28,55 +33,17 @@ const VALID_STRING_ESCAPES = union(new Set("\\nrvtbfux"), astUtils.LINEBREAKS);
 const REGEX_GENERAL_ESCAPES = new Set("\\bcdDfnpPrsStvwWxu0123456789]");
 const REGEX_NON_CHARCLASS_ESCAPES = union(REGEX_GENERAL_ESCAPES, new Set("^/.$*+?[{}|()Bk"));
 
-/**
- * Parses a regular expression into a list of characters with character class info.
- * @param {string} regExpText The raw text used to create the regular expression
- * @returns {Object[]} A list of characters, each with info on escaping and whether they're in a character class.
- * @example
- *
- * parseRegExp("a\\b[cd-]");
- *
- * // returns:
- * [
- *     { text: "a", index: 0, escaped: false, inCharClass: false, startsCharClass: false, endsCharClass: false },
- *     { text: "b", index: 2, escaped: true, inCharClass: false, startsCharClass: false, endsCharClass: false },
- *     { text: "c", index: 4, escaped: false, inCharClass: true, startsCharClass: true, endsCharClass: false },
- *     { text: "d", index: 5, escaped: false, inCharClass: true, startsCharClass: false, endsCharClass: false },
- *     { text: "-", index: 6, escaped: false, inCharClass: true, startsCharClass: false, endsCharClass: false }
- * ];
- *
+/*
+ * Set of characters that require escaping in character classes in `unicodeSets` mode.
+ * ( ) [ ] { } / - \ | are ClassSetSyntaxCharacter
  */
-function parseRegExp(regExpText) {
-    const charList = [];
+const REGEX_CLASSSET_CHARACTER_ESCAPES = union(REGEX_GENERAL_ESCAPES, new Set("q/[{}|()-"));
 
-    regExpText.split("").reduce((state, char, index) => {
-        if (!state.escapeNextChar) {
-            if (char === "\\") {
-                return Object.assign(state, { escapeNextChar: true });
-            }
-            if (char === "[" && !state.inCharClass) {
-                return Object.assign(state, { inCharClass: true, startingCharClass: true });
-            }
-            if (char === "]" && state.inCharClass) {
-                if (charList.length && charList[charList.length - 1].inCharClass) {
-                    charList[charList.length - 1].endsCharClass = true;
-                }
-                return Object.assign(state, { inCharClass: false, startingCharClass: false });
-            }
-        }
-        charList.push({
-            text: char,
-            index,
-            escaped: state.escapeNextChar,
-            inCharClass: state.inCharClass,
-            startsCharClass: state.startingCharClass,
-            endsCharClass: false
-        });
-        return Object.assign(state, { escapeNextChar: false, startingCharClass: false });
-    }, { escapeNextChar: false, inCharClass: false, startingCharClass: false });
-
-    return charList;
-}
+/*
+ * A single character set of ClassSetReservedDoublePunctuator.
+ * && !! ## $$ %% ** ++ ,, .. :: ;; << == >> ?? @@ ^^ `` ~~ are ClassSetReservedDoublePunctuator
+ */
+const REGEX_CLASS_SET_RESERVED_DOUBLE_PUNCTUATOR = new Set("!#$%&*+,.:;<=>?@^`~");
 
 /** @type {import('../shared/types').Rule} */
 module.exports = {
@@ -86,7 +53,7 @@ module.exports = {
         docs: {
             description: "Disallow unnecessary escape characters",
             recommended: true,
-            url: "https://eslint.org/docs/rules/no-useless-escape"
+            url: "https://eslint.org/docs/latest/rules/no-useless-escape"
         },
 
         hasSuggestions: true,
@@ -94,6 +61,7 @@ module.exports = {
         messages: {
             unnecessaryEscape: "Unnecessary escape character: \\{{character}}.",
             removeEscape: "Remove the `\\`. This maintains the current functionality.",
+            removeEscapeDoNotKeepSemantics: "Remove the `\\` if it was inserted by mistake.",
             escapeBackslash: "Replace the `\\` with `\\\\` to include the actual backslash character."
         },
 
@@ -101,16 +69,18 @@ module.exports = {
     },
 
     create(context) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
+        const parser = new RegExpParser();
 
         /**
          * Reports a node
          * @param {ASTNode} node The node to report
          * @param {number} startOffset The backslash's offset from the start of the node
          * @param {string} character The uselessly escaped character (not including the backslash)
+         * @param {boolean} [disableEscapeBackslashSuggest] `true` if escapeBackslash suggestion should be turned off.
          * @returns {void}
          */
-        function report(node, startOffset, character) {
+        function report(node, startOffset, character, disableEscapeBackslashSuggest) {
             const rangeStart = node.range[0] + startOffset;
             const range = [rangeStart, rangeStart + 1];
             const start = sourceCode.getLocFromIndex(rangeStart);
@@ -125,17 +95,24 @@ module.exports = {
                 data: { character },
                 suggest: [
                     {
-                        messageId: "removeEscape",
+
+                        // Removing unnecessary `\` characters in a directive is not guaranteed to maintain functionality.
+                        messageId: astUtils.isDirective(node.parent)
+                            ? "removeEscapeDoNotKeepSemantics" : "removeEscape",
                         fix(fixer) {
                             return fixer.removeRange(range);
                         }
                     },
-                    {
-                        messageId: "escapeBackslash",
-                        fix(fixer) {
-                            return fixer.insertTextBeforeRange(range, "\\");
-                        }
-                    }
+                    ...disableEscapeBackslashSuggest
+                        ? []
+                        : [
+                            {
+                                messageId: "escapeBackslash",
+                                fix(fixer) {
+                                    return fixer.insertTextBeforeRange(range, "\\");
+                                }
+                            }
+                        ]
                 ]
             });
         }
@@ -178,6 +155,133 @@ module.exports = {
             }
         }
 
+        /**
+         * Checks if the escape character in given regexp is unnecessary.
+         * @private
+         * @param {ASTNode} node node to validate.
+         * @returns {void}
+         */
+        function validateRegExp(node) {
+            const { pattern, flags } = node.regex;
+            let patternNode;
+            const unicode = flags.includes("u");
+            const unicodeSets = flags.includes("v");
+
+            try {
+                patternNode = parser.parsePattern(pattern, 0, pattern.length, { unicode, unicodeSets });
+            } catch {
+
+                // Ignore regular expressions with syntax errors
+                return;
+            }
+
+            /** @type {(CharacterClass | ExpressionCharacterClass)[]} */
+            const characterClassStack = [];
+
+            visitRegExpAST(patternNode, {
+                onCharacterClassEnter: characterClassNode => characterClassStack.unshift(characterClassNode),
+                onCharacterClassLeave: () => characterClassStack.shift(),
+                onExpressionCharacterClassEnter: characterClassNode => characterClassStack.unshift(characterClassNode),
+                onExpressionCharacterClassLeave: () => characterClassStack.shift(),
+                onCharacterEnter(characterNode) {
+                    if (!characterNode.raw.startsWith("\\")) {
+
+                        // It's not an escaped character.
+                        return;
+                    }
+
+                    const escapedChar = characterNode.raw.slice(1);
+
+                    if (escapedChar !== String.fromCodePoint(characterNode.value)) {
+
+                        // It's a valid escape.
+                        return;
+                    }
+                    let allowedEscapes;
+
+                    if (characterClassStack.length) {
+                        allowedEscapes = unicodeSets ? REGEX_CLASSSET_CHARACTER_ESCAPES : REGEX_GENERAL_ESCAPES;
+                    } else {
+                        allowedEscapes = REGEX_NON_CHARCLASS_ESCAPES;
+                    }
+                    if (allowedEscapes.has(escapedChar)) {
+                        return;
+                    }
+
+                    const reportedIndex = characterNode.start + 1;
+                    let disableEscapeBackslashSuggest = false;
+
+                    if (characterClassStack.length) {
+                        const characterClassNode = characterClassStack[0];
+
+                        if (escapedChar === "^") {
+
+                            /*
+                             * The '^' character is also a special case; it must always be escaped outside of character classes, but
+                             * it only needs to be escaped in character classes if it's at the beginning of the character class. To
+                             * account for this, consider it to be a valid escape character outside of character classes, and filter
+                             * out '^' characters that appear at the start of a character class.
+                             */
+                            if (characterClassNode.start + 1 === characterNode.start) {
+
+                                return;
+                            }
+                        }
+                        if (!unicodeSets) {
+                            if (escapedChar === "-") {
+
+                                /*
+                                 * The '-' character is a special case, because it's only valid to escape it if it's in a character
+                                 * class, and is not at either edge of the character class. To account for this, don't consider '-'
+                                 * characters to be valid in general, and filter out '-' characters that appear in the middle of a
+                                 * character class.
+                                 */
+                                if (characterClassNode.start + 1 !== characterNode.start && characterNode.end !== characterClassNode.end - 1) {
+
+                                    return;
+                                }
+                            }
+                        } else { // unicodeSets mode
+                            if (REGEX_CLASS_SET_RESERVED_DOUBLE_PUNCTUATOR.has(escapedChar)) {
+
+                                // Escaping is valid if it is a ClassSetReservedDoublePunctuator.
+                                if (pattern[characterNode.end] === escapedChar) {
+                                    return;
+                                }
+                                if (pattern[characterNode.start - 1] === escapedChar) {
+                                    if (escapedChar !== "^") {
+                                        return;
+                                    }
+
+                                    // If the previous character is a `negate` caret(`^`), escape to caret is unnecessary.
+
+                                    if (!characterClassNode.negate) {
+                                        return;
+                                    }
+                                    const negateCaretIndex = characterClassNode.start + 1;
+
+                                    if (negateCaretIndex < characterNode.start - 1) {
+                                        return;
+                                    }
+                                }
+                            }
+
+                            if (characterNode.parent.type === "ClassIntersection" || characterNode.parent.type === "ClassSubtraction") {
+                                disableEscapeBackslashSuggest = true;
+                            }
+                        }
+                    }
+
+                    report(
+                        node,
+                        reportedIndex,
+                        escapedChar,
+                        disableEscapeBackslashSuggest
+                    );
+                }
+            });
+        }
+
         /**
          * Checks if a node has an escape.
          * @param {ASTNode} node node to check.
@@ -216,32 +320,7 @@ module.exports = {
                     validateString(node, match);
                 }
             } else if (node.regex) {
-                parseRegExp(node.regex.pattern)
-
-                    /*
-                     * The '-' character is a special case, because it's only valid to escape it if it's in a character
-                     * class, and is not at either edge of the character class. To account for this, don't consider '-'
-                     * characters to be valid in general, and filter out '-' characters that appear in the middle of a
-                     * character class.
-                     */
-                    .filter(charInfo => !(charInfo.text === "-" && charInfo.inCharClass && !charInfo.startsCharClass && !charInfo.endsCharClass))
-
-                    /*
-                     * The '^' character is also a special case; it must always be escaped outside of character classes, but
-                     * it only needs to be escaped in character classes if it's at the beginning of the character class. To
-                     * account for this, consider it to be a valid escape character outside of character classes, and filter
-                     * out '^' characters that appear at the start of a character class.
-                     */
-                    .filter(charInfo => !(charInfo.text === "^" && charInfo.startsCharClass))
-
-                    // Filter out characters that aren't escaped.
-                    .filter(charInfo => charInfo.escaped)
-
-                    // Filter out characters that are valid to escape, based on their position in the regular expression.
-                    .filter(charInfo => !(charInfo.inCharClass ? REGEX_GENERAL_ESCAPES : REGEX_NON_CHARCLASS_ESCAPES).has(charInfo.text))
-
-                    // Report all the remaining characters.
-                    .forEach(charInfo => report(node, charInfo.index, charInfo.text));
+                validateRegExp(node);
             }
 
         }

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

@@ -23,7 +23,7 @@ module.exports = {
         docs: {
             description: "Disallow renaming import, export, and destructured assignments to the same name",
             recommended: false,
-            url: "https://eslint.org/docs/rules/no-useless-rename"
+            url: "https://eslint.org/docs/latest/rules/no-useless-rename"
         },
 
         fixable: "code",
@@ -46,7 +46,7 @@ module.exports = {
     },
 
     create(context) {
-        const sourceCode = context.getSourceCode(),
+        const sourceCode = context.sourceCode,
             options = context.options[0] || {},
             ignoreDestructuring = options.ignoreDestructuring === true,
             ignoreImport = options.ignoreImport === true,

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

@@ -69,7 +69,7 @@ module.exports = {
         docs: {
             description: "Disallow redundant return statements",
             recommended: false,
-            url: "https://eslint.org/docs/rules/no-useless-return"
+            url: "https://eslint.org/docs/latest/rules/no-useless-return"
         },
 
         fixable: "code",
@@ -82,8 +82,7 @@ module.exports = {
 
     create(context) {
         const segmentInfoMap = new WeakMap();
-        const usedUnreachableSegments = new WeakSet();
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         let scopeInfo = null;
 
         /**
@@ -152,24 +151,44 @@ module.exports = {
          * This behavior would simulate code paths for the case that the return
          * statement does not exist.
          * @param {CodePathSegment} segment The segment to get return statements.
+         * @param {Set<CodePathSegment>} usedUnreachableSegments A set of segments that have already been traversed in this call.
          * @returns {void}
          */
-        function markReturnStatementsOnSegmentAsUsed(segment) {
+        function markReturnStatementsOnSegmentAsUsed(segment, usedUnreachableSegments) {
             if (!segment.reachable) {
                 usedUnreachableSegments.add(segment);
                 segment.allPrevSegments
                     .filter(isReturned)
                     .filter(prevSegment => !usedUnreachableSegments.has(prevSegment))
-                    .forEach(markReturnStatementsOnSegmentAsUsed);
+                    .forEach(prevSegment => markReturnStatementsOnSegmentAsUsed(prevSegment, usedUnreachableSegments));
                 return;
             }
 
             const info = segmentInfoMap.get(segment);
 
-            for (const node of info.uselessReturns) {
+            info.uselessReturns = info.uselessReturns.filter(node => {
+                if (scopeInfo.traversedTryBlockStatements && scopeInfo.traversedTryBlockStatements.length > 0) {
+                    const returnInitialRange = node.range[0];
+                    const returnFinalRange = node.range[1];
+
+                    const areBlocksInRange = scopeInfo.traversedTryBlockStatements.some(tryBlockStatement => {
+                        const blockInitialRange = tryBlockStatement.range[0];
+                        const blockFinalRange = tryBlockStatement.range[1];
+
+                        return (
+                            returnInitialRange >= blockInitialRange &&
+                            returnFinalRange <= blockFinalRange
+                        );
+                    });
+
+                    if (areBlocksInRange) {
+                        return true;
+                    }
+                }
+
                 remove(scopeInfo.uselessReturns, node);
-            }
-            info.uselessReturns = [];
+                return false;
+            });
         }
 
         /**
@@ -188,7 +207,7 @@ module.exports = {
             scopeInfo
                 .codePath
                 .currentSegments
-                .forEach(markReturnStatementsOnSegmentAsUsed);
+                .forEach(segment => markReturnStatementsOnSegmentAsUsed(segment, new Set()));
         }
 
         //----------------------------------------------------------------------
@@ -202,6 +221,7 @@ module.exports = {
                 scopeInfo = {
                     upper: scopeInfo,
                     uselessReturns: [],
+                    traversedTryBlockStatements: [],
                     codePath
                 };
             },
@@ -275,6 +295,14 @@ module.exports = {
                 scopeInfo.uselessReturns.push(node);
             },
 
+            "TryStatement > BlockStatement.block:exit"(node) {
+                scopeInfo.traversedTryBlockStatements.push(node);
+            },
+
+            "TryStatement:exit"() {
+                scopeInfo.traversedTryBlockStatements.pop();
+            },
+
             /*
              * Registers for all statement nodes except FunctionDeclaration, BlockStatement, BreakStatement.
              * Removes return statements of the current segments from the useless return statement list.

package/lib/rules/no-var.js

@@ -187,7 +187,7 @@ module.exports = {
         docs: {
             description: "Require `let` or `const` instead of `var`",
             recommended: false,
-            url: "https://eslint.org/docs/rules/no-var"
+            url: "https://eslint.org/docs/latest/rules/no-var"
         },
 
         schema: [],
@@ -199,7 +199,7 @@ module.exports = {
     },
 
     create(context) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
 
         /**
          * Checks whether the variables which are defined by the given declarator node have their references in TDZ.

package/lib/rules/no-void.js

@@ -16,7 +16,7 @@ module.exports = {
         docs: {
             description: "Disallow `void` operators",
             recommended: false,
-            url: "https://eslint.org/docs/rules/no-void"
+            url: "https://eslint.org/docs/latest/rules/no-void"
         },
 
         messages: {

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

@@ -22,7 +22,7 @@ module.exports = {
         docs: {
             description: "Disallow specified warning terms in comments",
             recommended: false,
-            url: "https://eslint.org/docs/rules/no-warning-comments"
+            url: "https://eslint.org/docs/latest/rules/no-warning-comments"
         },
 
         schema: [
@@ -58,7 +58,7 @@ module.exports = {
     },
 
     create(context) {
-        const sourceCode = context.getSourceCode(),
+        const sourceCode = context.sourceCode,
             configuration = context.options[0] || {},
             warningTerms = configuration.terms || ["todo", "fixme", "xxx"],
             location = configuration.location || "start",

package/lib/rules/no-whitespace-before-property.js

@@ -22,7 +22,7 @@ module.exports = {
         docs: {
             description: "Disallow whitespace before properties",
             recommended: false,
-            url: "https://eslint.org/docs/rules/no-whitespace-before-property"
+            url: "https://eslint.org/docs/latest/rules/no-whitespace-before-property"
         },
 
         fixable: "whitespace",
@@ -34,7 +34,7 @@ module.exports = {
     },
 
     create(context) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
 
         //--------------------------------------------------------------------------
         // Helpers

package/lib/rules/no-with.js

@@ -17,7 +17,7 @@ module.exports = {
         docs: {
             description: "Disallow `with` statements",
             recommended: true,
-            url: "https://eslint.org/docs/rules/no-with"
+            url: "https://eslint.org/docs/latest/rules/no-with"
         },
 
         schema: [],

package/lib/rules/nonblock-statement-body-position.js

@@ -18,7 +18,7 @@ module.exports = {
         docs: {
             description: "Enforce the location of single-line statements",
             recommended: false,
-            url: "https://eslint.org/docs/rules/nonblock-statement-body-position"
+            url: "https://eslint.org/docs/latest/rules/nonblock-statement-body-position"
         },
 
         fixable: "whitespace",
@@ -49,7 +49,7 @@ module.exports = {
     },
 
     create(context) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
 
         //----------------------------------------------------------------------
         // Helpers

package/lib/rules/object-curly-newline.js

@@ -152,7 +152,7 @@ module.exports = {
         docs: {
             description: "Enforce consistent line breaks after opening and before closing braces",
             recommended: false,
-            url: "https://eslint.org/docs/rules/object-curly-newline"
+            url: "https://eslint.org/docs/latest/rules/object-curly-newline"
         },
 
         fixable: "whitespace",
@@ -185,7 +185,7 @@ module.exports = {
     },
 
     create(context) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
         const normalizedOptions = normalizeOptions(context.options[0]);
 
         /**

package/lib/rules/object-curly-spacing.js

@@ -18,7 +18,7 @@ module.exports = {
         docs: {
             description: "Enforce consistent spacing inside braces",
             recommended: false,
-            url: "https://eslint.org/docs/rules/object-curly-spacing"
+            url: "https://eslint.org/docs/latest/rules/object-curly-spacing"
         },
 
         fixable: "whitespace",
@@ -51,7 +51,7 @@ module.exports = {
 
     create(context) {
         const spaced = context.options[0] === "always",
-            sourceCode = context.getSourceCode();
+            sourceCode = context.sourceCode;
 
         /**
          * Determines whether an option is set, relative to the spacing option.
@@ -81,7 +81,7 @@ module.exports = {
          * @returns {void}
          */
         function reportNoBeginningSpace(node, token) {
-            const nextToken = context.getSourceCode().getTokenAfter(token, { includeComments: true });
+            const nextToken = context.sourceCode.getTokenAfter(token, { includeComments: true });
 
             context.report({
                 node,
@@ -103,7 +103,7 @@ module.exports = {
          * @returns {void}
          */
         function reportNoEndingSpace(node, token) {
-            const previousToken = context.getSourceCode().getTokenBefore(token, { includeComments: true });
+            const previousToken = context.sourceCode.getTokenBefore(token, { includeComments: true });
 
             context.report({
                 node,

package/lib/rules/object-property-newline.js

@@ -17,7 +17,7 @@ module.exports = {
         docs: {
             description: "Enforce placing object properties on separate lines",
             recommended: false,
-            url: "https://eslint.org/docs/rules/object-property-newline"
+            url: "https://eslint.org/docs/latest/rules/object-property-newline"
         },
 
         schema: [
@@ -53,7 +53,7 @@ module.exports = {
             ? "propertiesOnNewlineAll"
             : "propertiesOnNewline";
 
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
 
         return {
             ObjectExpression(node) {

package/lib/rules/object-shorthand.js

@@ -30,7 +30,7 @@ module.exports = {
         docs: {
             description: "Require or disallow method and property shorthand syntax for object literals",
             recommended: false,
-            url: "https://eslint.org/docs/rules/object-shorthand"
+            url: "https://eslint.org/docs/latest/rules/object-shorthand"
         },
 
         fixable: "code",
@@ -123,7 +123,7 @@ module.exports = {
             : null;
         const AVOID_QUOTES = PARAMS.avoidQuotes;
         const AVOID_EXPLICIT_RETURN_ARROWS = !!PARAMS.avoidExplicitReturnArrows;
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
 
         //--------------------------------------------------------------------------
         // Helpers

package/lib/rules/one-var-declaration-per-line.js

@@ -16,7 +16,7 @@ module.exports = {
         docs: {
             description: "Require or disallow newlines around variable declarations",
             recommended: false,
-            url: "https://eslint.org/docs/rules/one-var-declaration-per-line"
+            url: "https://eslint.org/docs/latest/rules/one-var-declaration-per-line"
         },
 
         schema: [

package/lib/rules/one-var.js

@@ -36,7 +36,7 @@ module.exports = {
         docs: {
             description: "Enforce variables to be declared either together or separately in functions",
             recommended: false,
-            url: "https://eslint.org/docs/rules/one-var"
+            url: "https://eslint.org/docs/latest/rules/one-var"
         },
 
         fixable: "code",
@@ -121,7 +121,7 @@ module.exports = {
             }
         }
 
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
 
         //--------------------------------------------------------------------------
         // Helpers

package/lib/rules/operator-assignment.js

@@ -65,7 +65,7 @@ module.exports = {
         docs: {
             description: "Require or disallow assignment operator shorthand where possible",
             recommended: false,
-            url: "https://eslint.org/docs/rules/operator-assignment"
+            url: "https://eslint.org/docs/latest/rules/operator-assignment"
         },
 
         schema: [
@@ -83,7 +83,7 @@ module.exports = {
 
     create(context) {
 
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode;
 
         /**
          * Returns the operator token of an AssignmentExpression or BinaryExpression