eslint 8.47.0 → 8.57.0

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

@@ -18,15 +18,6 @@ const astUtils = require("./utils/ast-utils");
 const TARGET_NODE_TYPE = /^(?:Arrow)?FunctionExpression$/u;
 const TARGET_METHODS = /^(?:every|filter|find(?:Last)?(?:Index)?|flatMap|forEach|map|reduce(?:Right)?|some|sort|toSorted)$/u;
 
-/**
- * Checks a given code path segment is reachable.
- * @param {CodePathSegment} segment A segment to check.
- * @returns {boolean} `true` if the segment is reachable.
- */
-function isReachable(segment) {
-    return segment.reachable;
-}
-
 /**
  * Checks a given node is a member access which has the specified name's
  * property.
@@ -38,6 +29,22 @@ function isTargetMethod(node) {
     return astUtils.isSpecificMemberAccess(node, null, TARGET_METHODS);
 }
 
+/**
+ * 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;
+}
+
 /**
  * Returns a human-legible description of an array method
  * @param {string} arrayMethodName A method name to fully qualify
@@ -129,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
 //------------------------------------------------------------------------------
@@ -144,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",
@@ -155,6 +235,10 @@ module.exports = {
                     checkForEach: {
                         type: "boolean",
                         default: false
+                    },
+                    allowVoid: {
+                        type: "boolean",
+                        default: false
                     }
                 },
                 additionalProperties: false
@@ -165,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 = {
@@ -198,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" && funcInfo.codePath.currentSegments.some(isReachable)) {
-                    messageId = funcInfo.hasReturn ? "expectedAtEnd" : "expectedInside";
+                if (node.body.type === "BlockStatement" && isAnySegmentReachable(funcInfo.currentSegments)) {
+                    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
                 });
             }
         }
@@ -242,7 +358,8 @@ module.exports = {
                         methodName &&
                         !node.async &&
                         !node.generator,
-                    node
+                    node,
+                    currentSegments: new Set()
                 };
             },
 
@@ -251,6 +368,23 @@ module.exports = {
                 funcInfo = funcInfo.upper;
             },
 
+            onUnreachableCodePathSegmentStart(segment) {
+                funcInfo.currentSegments.add(segment);
+            },
+
+            onUnreachableCodePathSegmentEnd(segment) {
+                funcInfo.currentSegments.delete(segment);
+            },
+
+            onCodePathSegmentStart(segment) {
+                funcInfo.currentSegments.add(segment);
+            },
+
+            onCodePathSegmentEnd(segment) {
+                funcInfo.currentSegments.delete(segment);
+            },
+
+
             // Checks the return statement is valid.
             ReturnStatement(node) {
 
@@ -260,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/array-element-newline.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Rule to enforce line breaks after each array element
  * @author Jan Peer Stöcklmair <https://github.com/JPeer264>
+ * @deprecated in ESLint v8.53.0
  */
 
 "use strict";
@@ -14,6 +15,8 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/arrow-parens.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Rule to require parens in arrow function arguments.
  * @author Jxck
+ * @deprecated in ESLint v8.53.0
  */
 "use strict";
 
@@ -30,6 +31,8 @@ function hasBlockBody(node) {
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/arrow-spacing.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Rule to define spacing before/after arrow function's arrow.
  * @author Jxck
+ * @deprecated in ESLint v8.53.0
  */
 "use strict";
 
@@ -17,6 +18,8 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/block-spacing.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview A rule to disallow or enforce spaces inside of single line blocks.
  * @author Toru Nagashima
+ * @deprecated in ESLint v8.53.0
  */
 
 "use strict";
@@ -14,6 +15,8 @@ const util = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/brace-style.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Rule to flag block statements that do not use the one true brace style
  * @author Ian Christian Myers
+ * @deprecated in ESLint v8.53.0
  */
 
 "use strict";
@@ -14,6 +15,8 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/comma-dangle.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Rule to forbid or enforce dangling commas.
  * @author Ian Christian Myers
+ * @deprecated in ESLint v8.53.0
  */
 
 "use strict";
@@ -73,6 +74,8 @@ function normalizeOptions(optionValue, ecmaVersion) {
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/comma-spacing.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Comma spacing - validates spacing before and after comma
  * @author Vignesh Anand aka vegetableman.
+ * @deprecated in ESLint v8.53.0
  */
 "use strict";
 
@@ -13,6 +14,8 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/comma-style.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Comma style - enforces comma styles of two types: last and first
  * @author Vignesh Anand aka vegetableman
+ * @deprecated in ESLint v8.53.0
  */
 
 "use strict";
@@ -14,6 +15,8 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/computed-property-spacing.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Disallows or enforces spaces inside computed properties.
  * @author Jamund Ferguson
+ * @deprecated in ESLint v8.53.0
  */
 "use strict";
 
@@ -13,6 +14,8 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/consistent-return.js

@@ -16,12 +16,19 @@ const { upperCaseFirst } = require("../shared/string-utils");
 //------------------------------------------------------------------------------
 
 /**
- * Checks whether or not a given code path segment is unreachable.
- * @param {CodePathSegment} segment A CodePathSegment to check.
- * @returns {boolean} `true` if the segment is unreachable.
+ * Checks all segments in a set and returns true if all are unreachable.
+ * @param {Set<CodePathSegment>} segments The segments to check.
+ * @returns {boolean} True if all segments are unreachable; false otherwise.
  */
-function isUnreachable(segment) {
-    return !segment.reachable;
+function areAllSegmentsUnreachable(segments) {
+
+    for (const segment of segments) {
+        if (segment.reachable) {
+            return false;
+        }
+    }
+
+    return true;
 }
 
 /**
@@ -88,7 +95,7 @@ module.exports = {
              * When unreachable, all paths are returned or thrown.
              */
             if (!funcInfo.hasReturnValue ||
-                funcInfo.codePath.currentSegments.every(isUnreachable) ||
+                areAllSegmentsUnreachable(funcInfo.currentSegments) ||
                 astUtils.isES5Constructor(node) ||
                 isClassConstructor(node)
             ) {
@@ -141,13 +148,31 @@ module.exports = {
                     hasReturn: false,
                     hasReturnValue: false,
                     messageId: "",
-                    node
+                    node,
+                    currentSegments: new Set()
                 };
             },
             onCodePathEnd() {
                 funcInfo = funcInfo.upper;
             },
 
+            onUnreachableCodePathSegmentStart(segment) {
+                funcInfo.currentSegments.add(segment);
+            },
+
+            onUnreachableCodePathSegmentEnd(segment) {
+                funcInfo.currentSegments.delete(segment);
+            },
+
+            onCodePathSegmentStart(segment) {
+                funcInfo.currentSegments.add(segment);
+            },
+
+            onCodePathSegmentEnd(segment) {
+                funcInfo.currentSegments.delete(segment);
+            },
+
+
             // Reports a given return statement if it's inconsistent.
             ReturnStatement(node) {
                 const argument = node.argument;

package/lib/rules/constructor-super.js

@@ -10,12 +10,19 @@
 //------------------------------------------------------------------------------
 
 /**
- * Checks whether a given code path segment is reachable or not.
- * @param {CodePathSegment} segment A code path segment to check.
- * @returns {boolean} `true` if the segment is reachable.
+ * 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 isReachable(segment) {
-    return segment.reachable;
+function isAnySegmentReachable(segments) {
+
+    for (const segment of segments) {
+        if (segment.reachable) {
+            return true;
+        }
+    }
+
+    return false;
 }
 
 /**
@@ -210,7 +217,8 @@ module.exports = {
                         isConstructor: true,
                         hasExtends: Boolean(superClass),
                         superIsConstructor: isPossibleConstructor(superClass),
-                        codePath
+                        codePath,
+                        currentSegments: new Set()
                     };
                 } else {
                     funcInfo = {
@@ -218,7 +226,8 @@ module.exports = {
                         isConstructor: false,
                         hasExtends: false,
                         superIsConstructor: false,
-                        codePath
+                        codePath,
+                        currentSegments: new Set()
                     };
                 }
             },
@@ -261,6 +270,9 @@ module.exports = {
              * @returns {void}
              */
             onCodePathSegmentStart(segment) {
+
+                funcInfo.currentSegments.add(segment);
+
                 if (!(funcInfo && funcInfo.isConstructor && funcInfo.hasExtends)) {
                     return;
                 }
@@ -281,6 +293,19 @@ module.exports = {
                 }
             },
 
+            onUnreachableCodePathSegmentStart(segment) {
+                funcInfo.currentSegments.add(segment);
+            },
+
+            onUnreachableCodePathSegmentEnd(segment) {
+                funcInfo.currentSegments.delete(segment);
+            },
+
+            onCodePathSegmentEnd(segment) {
+                funcInfo.currentSegments.delete(segment);
+            },
+
+
             /**
              * Update information of the code path segment when a code path was
              * looped.
@@ -344,12 +369,11 @@ module.exports = {
 
                 // Reports if needed.
                 if (funcInfo.hasExtends) {
-                    const segments = funcInfo.codePath.currentSegments;
+                    const segments = funcInfo.currentSegments;
                     let duplicate = false;
                     let info = null;
 
-                    for (let i = 0; i < segments.length; ++i) {
-                        const segment = segments[i];
+                    for (const segment of segments) {
 
                         if (segment.reachable) {
                             info = segInfoMap[segment.id];
@@ -374,7 +398,7 @@ module.exports = {
                             info.validNodes.push(node);
                         }
                     }
-                } else if (funcInfo.codePath.currentSegments.some(isReachable)) {
+                } else if (isAnySegmentReachable(funcInfo.currentSegments)) {
                     context.report({
                         messageId: "unexpected",
                         node
@@ -398,10 +422,9 @@ module.exports = {
                 }
 
                 // Returning argument is a substitute of 'super()'.
-                const segments = funcInfo.codePath.currentSegments;
+                const segments = funcInfo.currentSegments;
 
-                for (let i = 0; i < segments.length; ++i) {
-                    const segment = segments[i];
+                for (const segment of segments) {
 
                     if (segment.reachable) {
                         const info = segInfoMap[segment.id];

package/lib/rules/dot-location.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Validates newlines before and after dots
  * @author Greg Cochard
+ * @deprecated in ESLint v8.53.0
  */
 
 "use strict";
@@ -14,6 +15,8 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

package/lib/rules/eol-last.js

@@ -1,6 +1,7 @@
 /**
  * @fileoverview Require or disallow newline at the end of files
  * @author Nodeca Team <https://github.com/nodeca>
+ * @deprecated in ESLint v8.53.0
  */
 "use strict";
 
@@ -11,6 +12,8 @@
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {