eslint 8.49.0 → 8.50.0

package/lib/rules/array-callback-return.js

@@ -136,6 +136,76 @@ function getArrayMethodName(node) {
     return null;
 }
 
+/**
+ * Checks if the given node is a void expression.
+ * @param {ASTNode} node The node to check.
+ * @returns {boolean} - `true` if the node is a void expression
+ */
+function isExpressionVoid(node) {
+    return node.type === "UnaryExpression" && node.operator === "void";
+}
+
+/**
+ * Fixes the linting error by prepending "void " to the given node
+ * @param {Object} sourceCode context given by context.sourceCode
+ * @param {ASTNode} node The node to fix.
+ * @param {Object} fixer The fixer object provided by ESLint.
+ * @returns {Array<Object>} - An array of fix objects to apply to the node.
+ */
+function voidPrependFixer(sourceCode, node, fixer) {
+
+    const requiresParens =
+
+        // prepending `void ` will fail if the node has a lower precedence than void
+        astUtils.getPrecedence(node) < astUtils.getPrecedence({ type: "UnaryExpression", operator: "void" }) &&
+
+        // check if there are parentheses around the node to avoid redundant parentheses
+        !astUtils.isParenthesised(sourceCode, node);
+
+    // avoid parentheses issues
+    const returnOrArrowToken = sourceCode.getTokenBefore(
+        node,
+        node.parent.type === "ArrowFunctionExpression"
+            ? astUtils.isArrowToken
+
+            // isReturnToken
+            : token => token.type === "Keyword" && token.value === "return"
+    );
+
+    const firstToken = sourceCode.getTokenAfter(returnOrArrowToken);
+
+    const prependSpace =
+
+        // is return token, as => allows void to be adjacent
+        returnOrArrowToken.value === "return" &&
+
+        // If two tokens (return and "(") are adjacent
+        returnOrArrowToken.range[1] === firstToken.range[0];
+
+    return [
+        fixer.insertTextBefore(firstToken, `${prependSpace ? " " : ""}void ${requiresParens ? "(" : ""}`),
+        fixer.insertTextAfter(node, requiresParens ? ")" : "")
+    ];
+}
+
+/**
+ * Fixes the linting error by `wrapping {}` around the given node's body.
+ * @param {Object} sourceCode context given by context.sourceCode
+ * @param {ASTNode} node The node to fix.
+ * @param {Object} fixer The fixer object provided by ESLint.
+ * @returns {Array<Object>} - An array of fix objects to apply to the node.
+ */
+function curlyWrapFixer(sourceCode, node, fixer) {
+    const arrowToken = sourceCode.getTokenBefore(node.body, astUtils.isArrowToken);
+    const firstToken = sourceCode.getTokenAfter(arrowToken);
+    const lastToken = sourceCode.getLastToken(node);
+
+    return [
+        fixer.insertTextBefore(firstToken, "{"),
+        fixer.insertTextAfter(lastToken, "}")
+    ];
+}
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -151,6 +221,9 @@ module.exports = {
             url: "https://eslint.org/docs/latest/rules/array-callback-return"
         },
 
+        // eslint-disable-next-line eslint-plugin/require-meta-has-suggestions -- false positive
+        hasSuggestions: true,
+
         schema: [
             {
                 type: "object",
@@ -162,6 +235,10 @@ module.exports = {
                     checkForEach: {
                         type: "boolean",
                         default: false
+                    },
+                    allowVoid: {
+                        type: "boolean",
+                        default: false
                     }
                 },
                 additionalProperties: false
@@ -172,13 +249,15 @@ module.exports = {
             expectedAtEnd: "{{arrayMethodName}}() expects a value to be returned at the end of {{name}}.",
             expectedInside: "{{arrayMethodName}}() expects a return value from {{name}}.",
             expectedReturnValue: "{{arrayMethodName}}() expects a return value from {{name}}.",
-            expectedNoReturnValue: "{{arrayMethodName}}() expects no useless return value from {{name}}."
+            expectedNoReturnValue: "{{arrayMethodName}}() expects no useless return value from {{name}}.",
+            wrapBraces: "Wrap the expression in `{}`.",
+            prependVoid: "Prepend `void` to the expression."
         }
     },
 
     create(context) {
 
-        const options = context.options[0] || { allowImplicit: false, checkForEach: false };
+        const options = context.options[0] || { allowImplicit: false, checkForEach: false, allowVoid: false };
         const sourceCode = context.sourceCode;
 
         let funcInfo = {
@@ -205,26 +284,56 @@ module.exports = {
                 return;
             }
 
-            let messageId = null;
+            const messageAndSuggestions = { messageId: "", suggest: [] };
 
             if (funcInfo.arrayMethodName === "forEach") {
                 if (options.checkForEach && node.type === "ArrowFunctionExpression" && node.expression) {
-                    messageId = "expectedNoReturnValue";
+
+                    if (options.allowVoid) {
+                        if (isExpressionVoid(node.body)) {
+                            return;
+                        }
+
+                        messageAndSuggestions.messageId = "expectedNoReturnValue";
+                        messageAndSuggestions.suggest = [
+                            {
+                                messageId: "wrapBraces",
+                                fix(fixer) {
+                                    return curlyWrapFixer(sourceCode, node, fixer);
+                                }
+                            },
+                            {
+                                messageId: "prependVoid",
+                                fix(fixer) {
+                                    return voidPrependFixer(sourceCode, node.body, fixer);
+                                }
+                            }
+                        ];
+                    } else {
+                        messageAndSuggestions.messageId = "expectedNoReturnValue";
+                        messageAndSuggestions.suggest = [{
+                            messageId: "wrapBraces",
+                            fix(fixer) {
+                                return curlyWrapFixer(sourceCode, node, fixer);
+                            }
+                        }];
+                    }
                 }
             } else {
                 if (node.body.type === "BlockStatement" && isAnySegmentReachable(funcInfo.currentSegments)) {
-                    messageId = funcInfo.hasReturn ? "expectedAtEnd" : "expectedInside";
+                    messageAndSuggestions.messageId = funcInfo.hasReturn ? "expectedAtEnd" : "expectedInside";
                 }
             }
 
-            if (messageId) {
+            if (messageAndSuggestions.messageId) {
                 const name = astUtils.getFunctionNameWithKind(node);
 
                 context.report({
                     node,
                     loc: astUtils.getFunctionHeadLoc(node, sourceCode),
-                    messageId,
-                    data: { name, arrayMethodName: fullMethodName(funcInfo.arrayMethodName) }
+                    messageId: messageAndSuggestions.messageId,
+                    data: { name, arrayMethodName: fullMethodName(funcInfo.arrayMethodName) },
+                    suggest: messageAndSuggestions.suggest.length !== 0 ? messageAndSuggestions.suggest : null
                 });
             }
         }
@@ -285,30 +394,46 @@ module.exports = {
 
                 funcInfo.hasReturn = true;
 
-                let messageId = null;
+                const messageAndSuggestions = { messageId: "", suggest: [] };
 
                 if (funcInfo.arrayMethodName === "forEach") {
 
                     // if checkForEach: true, returning a value at any path inside a forEach is not allowed
                     if (options.checkForEach && node.argument) {
-                        messageId = "expectedNoReturnValue";
+
+                        if (options.allowVoid) {
+                            if (isExpressionVoid(node.argument)) {
+                                return;
+                            }
+
+                            messageAndSuggestions.messageId = "expectedNoReturnValue";
+                            messageAndSuggestions.suggest = [{
+                                messageId: "prependVoid",
+                                fix(fixer) {
+                                    return voidPrependFixer(sourceCode, node.argument, fixer);
+                                }
+                            }];
+                        } else {
+                            messageAndSuggestions.messageId = "expectedNoReturnValue";
+                        }
                     }
                 } else {
 
                     // if allowImplicit: false, should also check node.argument
                     if (!options.allowImplicit && !node.argument) {
-                        messageId = "expectedReturnValue";
+                        messageAndSuggestions.messageId = "expectedReturnValue";
                     }
                 }
 
-                if (messageId) {
+                if (messageAndSuggestions.messageId) {
                     context.report({
                         node,
-                        messageId,
+                        messageId: messageAndSuggestions.messageId,
                         data: {
                             name: astUtils.getFunctionNameWithKind(funcInfo.node),
                             arrayMethodName: fullMethodName(funcInfo.arrayMethodName)
-                        }
+                        },
+                        suggest: messageAndSuggestions.suggest.length !== 0 ? messageAndSuggestions.suggest : null
                     });
                 }
             },

package/lib/rules/index.js

@@ -175,6 +175,7 @@ module.exports = new LazyLoadingRuleMap(Object.entries({
     "no-new-wrappers": () => require("./no-new-wrappers"),
     "no-nonoctal-decimal-escape": () => require("./no-nonoctal-decimal-escape"),
     "no-obj-calls": () => require("./no-obj-calls"),
+    "no-object-constructor": () => require("./no-object-constructor"),
     "no-octal": () => require("./no-octal"),
     "no-octal-escape": () => require("./no-octal-escape"),
     "no-param-reassign": () => require("./no-param-reassign"),

package/lib/rules/no-misleading-character-class.js

@@ -13,27 +13,34 @@ const { isValidWithUnicodeFlag } = require("./utils/regular-expressions");
 // Helpers
 //------------------------------------------------------------------------------
 
+/**
+ * @typedef {import('@eslint-community/regexpp').AST.Character} Character
+ * @typedef {import('@eslint-community/regexpp').AST.CharacterClassElement} CharacterClassElement
+ */
+
 /**
  * Iterate character sequences of a given nodes.
  *
  * CharacterClassRange syntax can steal a part of character sequence,
  * so this function reverts CharacterClassRange syntax and restore the sequence.
- * @param {import('@eslint-community/regexpp').AST.CharacterClassElement[]} nodes The node list to iterate character sequences.
- * @returns {IterableIterator<number[]>} The list of character sequences.
+ * @param {CharacterClassElement[]} nodes The node list to iterate character sequences.
+ * @returns {IterableIterator<Character[]>} The list of character sequences.
  */
 function *iterateCharacterSequence(nodes) {
+
+    /** @type {Character[]} */
     let seq = [];
 
     for (const node of nodes) {
         switch (node.type) {
             case "Character":
-                seq.push(node.value);
+                seq.push(node);
                 break;
 
             case "CharacterClassRange":
-                seq.push(node.min.value);
+                seq.push(node.min);
                 yield seq;
-                seq = [node.max.value];
+                seq = [node.max];
                 break;
 
             case "CharacterSet":
@@ -55,32 +62,74 @@ function *iterateCharacterSequence(nodes) {
     }
 }
 
+
+/**
+ * Checks whether the given character node is a Unicode code point escape or not.
+ * @param {Character} char the character node to check.
+ * @returns {boolean} `true` if the character node is a Unicode code point escape.
+ */
+function isUnicodeCodePointEscape(char) {
+    return /^\\u\{[\da-f]+\}$/iu.test(char.raw);
+}
+
+/**
+ * Each function returns `true` if it detects that kind of problem.
+ * @type {Record<string, (chars: Character[]) => boolean>}
+ */
 const hasCharacterSequence = {
     surrogatePairWithoutUFlag(chars) {
-        return chars.some((c, i) => i !== 0 && isSurrogatePair(chars[i - 1], c));
+        return chars.some((c, i) => {
+            if (i === 0) {
+                return false;
+            }
+            const c1 = chars[i - 1];
+
+            return (
+                isSurrogatePair(c1.value, c.value) &&
+                !isUnicodeCodePointEscape(c1) &&
+                !isUnicodeCodePointEscape(c)
+            );
+        });
+    },
+
+    surrogatePair(chars) {
+        return chars.some((c, i) => {
+            if (i === 0) {
+                return false;
+            }
+            const c1 = chars[i - 1];
+
+            return (
+                isSurrogatePair(c1.value, c.value) &&
+                (
+                    isUnicodeCodePointEscape(c1) ||
+                    isUnicodeCodePointEscape(c)
+                )
+            );
+        });
     },
 
     combiningClass(chars) {
         return chars.some((c, i) => (
             i !== 0 &&
-            isCombiningCharacter(c) &&
-            !isCombiningCharacter(chars[i - 1])
+            isCombiningCharacter(c.value) &&
+            !isCombiningCharacter(chars[i - 1].value)
         ));
     },
 
     emojiModifier(chars) {
         return chars.some((c, i) => (
             i !== 0 &&
-            isEmojiModifier(c) &&
-            !isEmojiModifier(chars[i - 1])
+            isEmojiModifier(c.value) &&
+            !isEmojiModifier(chars[i - 1].value)
         ));
     },
 
     regionalIndicatorSymbol(chars) {
         return chars.some((c, i) => (
             i !== 0 &&
-            isRegionalIndicatorSymbol(c) &&
-            isRegionalIndicatorSymbol(chars[i - 1])
+            isRegionalIndicatorSymbol(c.value) &&
+            isRegionalIndicatorSymbol(chars[i - 1].value)
         ));
     },
 
@@ -90,9 +139,9 @@ const hasCharacterSequence = {
         return chars.some((c, i) => (
             i !== 0 &&
             i !== lastIndex &&
-            c === 0x200d &&
-            chars[i - 1] !== 0x200d &&
-            chars[i + 1] !== 0x200d
+            c.value === 0x200d &&
+            chars[i - 1].value !== 0x200d &&
+            chars[i + 1].value !== 0x200d
         ));
     }
 };
@@ -120,6 +169,7 @@ module.exports = {
 
         messages: {
             surrogatePairWithoutUFlag: "Unexpected surrogate pair in character class. Use 'u' flag.",
+            surrogatePair: "Unexpected surrogate pair in character class.",
             combiningClass: "Unexpected combined character in character class.",
             emojiModifier: "Unexpected modified Emoji in character class.",
             regionalIndicatorSymbol: "Unexpected national flag in character class.",

package/lib/rules/no-new-object.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview A rule to disallow calls to the Object constructor
  * @author Matt DuVall <http://www.mattduvall.com/>
+ * @deprecated in ESLint v8.50.0
  */
 
 "use strict";
@@ -26,6 +27,12 @@ module.exports = {
             url: "https://eslint.org/docs/latest/rules/no-new-object"
         },
 
+        deprecated: true,
+
+        replacedBy: [
+            "no-object-constructor"
+        ],
+
         schema: [],
 
         messages: {

package/lib/rules/no-object-constructor.js

@@ -0,0 +1,118 @@
+/**
+ * @fileoverview Rule to disallow calls to the `Object` constructor without an argument
+ * @author Francesco Trotta
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const { getVariableByName, isArrowToken } = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Tests if a node appears at the beginning of an ancestor ExpressionStatement node.
+ * @param {ASTNode} node The node to check.
+ * @returns {boolean} Whether the node appears at the beginning of an ancestor ExpressionStatement node.
+ */
+function isStartOfExpressionStatement(node) {
+    const start = node.range[0];
+    let ancestor = node;
+
+    while ((ancestor = ancestor.parent) && ancestor.range[0] === start) {
+        if (ancestor.type === "ExpressionStatement") {
+            return true;
+        }
+    }
+    return false;
+}
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../shared/types').Rule} */
+module.exports = {
+    meta: {
+        type: "suggestion",
+
+        docs: {
+            description: "Disallow calls to the `Object` constructor without an argument",
+            recommended: false,
+            url: "https://eslint.org/docs/latest/rules/no-object-constructor"
+        },
+
+        hasSuggestions: true,
+
+        schema: [],
+
+        messages: {
+            preferLiteral: "The object literal notation {} is preferable.",
+            useLiteral: "Replace with '{{replacement}}'."
+        }
+    },
+
+    create(context) {
+
+        const sourceCode = context.sourceCode;
+
+        /**
+         * Determines whether or not an object literal that replaces a specified node needs to be enclosed in parentheses.
+         * @param {ASTNode} node The node to be replaced.
+         * @returns {boolean} Whether or not parentheses around the object literal are required.
+         */
+        function needsParentheses(node) {
+            if (isStartOfExpressionStatement(node)) {
+                return true;
+            }
+
+            const prevToken = sourceCode.getTokenBefore(node);
+
+            if (prevToken && isArrowToken(prevToken)) {
+                return true;
+            }
+
+            return false;
+        }
+
+        /**
+         * Reports on nodes where the `Object` constructor is called without arguments.
+         * @param {ASTNode} node The node to evaluate.
+         * @returns {void}
+         */
+        function check(node) {
+            if (node.callee.type !== "Identifier" || node.callee.name !== "Object" || node.arguments.length) {
+                return;
+            }
+
+            const variable = getVariableByName(sourceCode.getScope(node), "Object");
+
+            if (variable && variable.identifiers.length === 0) {
+                const replacement = needsParentheses(node) ? "({})" : "{}";
+
+                context.report({
+                    node,
+                    messageId: "preferLiteral",
+                    suggest: [
+                        {
+                            messageId: "useLiteral",
+                            data: { replacement },
+                            fix: fixer => fixer.replaceText(node, replacement)
+                        }
+                    ]
+                });
+            }
+        }
+
+        return {
+            CallExpression: check,
+            NewExpression: check
+        };
+
+    }
+};