eslint 9.22.0 → 9.24.0

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

@@ -9,7 +9,7 @@
 //------------------------------------------------------------------------------
 
 const astUtils = require("./utils/ast-utils"),
-    FixTracker = require("./utils/fix-tracker");
+	FixTracker = require("./utils/fix-tracker");
 
 //------------------------------------------------------------------------------
 // Helpers
@@ -22,11 +22,11 @@ const astUtils = require("./utils/ast-utils"),
  * @returns {void}
  */
 function remove(array, element) {
-    const index = array.indexOf(element);
+	const index = array.indexOf(element);
 
-    if (index !== -1) {
-        array.splice(index, 1);
-    }
+	if (index !== -1) {
+		array.splice(index, 1);
+	}
 }
 
 /**
@@ -35,7 +35,7 @@ function remove(array, element) {
  * @returns {boolean} `true` if the node is removable.
  */
 function isRemovable(node) {
-    return astUtils.STATEMENT_LIST_PARENTS.has(node.parent.type);
+	return astUtils.STATEMENT_LIST_PARENTS.has(node.parent.type);
 }
 
 /**
@@ -44,17 +44,20 @@ function isRemovable(node) {
  * @returns {boolean} `true` if the node is in a `finally` block.
  */
 function isInFinally(node) {
-    for (
-        let currentNode = node;
-        currentNode && currentNode.parent && !astUtils.isFunction(currentNode);
-        currentNode = currentNode.parent
-    ) {
-        if (currentNode.parent.type === "TryStatement" && currentNode.parent.finalizer === currentNode) {
-            return true;
-        }
-    }
-
-    return false;
+	for (
+		let currentNode = node;
+		currentNode && currentNode.parent && !astUtils.isFunction(currentNode);
+		currentNode = currentNode.parent
+	) {
+		if (
+			currentNode.parent.type === "TryStatement" &&
+			currentNode.parent.finalizer === currentNode
+		) {
+			return true;
+		}
+	}
+
+	return false;
 }
 
 /**
@@ -63,307 +66,336 @@ function isInFinally(node) {
  * @returns {boolean} True if any segment is reachable; false otherwise.
  */
 function isAnySegmentReachable(segments) {
+	for (const segment of segments) {
+		if (segment.reachable) {
+			return true;
+		}
+	}
 
-    for (const segment of segments) {
-        if (segment.reachable) {
-            return true;
-        }
-    }
-
-    return false;
+	return false;
 }
 
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
-    meta: {
-        type: "suggestion",
-
-        docs: {
-            description: "Disallow redundant return statements",
-            recommended: false,
-            url: "https://eslint.org/docs/latest/rules/no-useless-return"
-        },
-
-        fixable: "code",
-        schema: [],
-
-        messages: {
-            unnecessaryReturn: "Unnecessary return statement."
-        }
-    },
-
-    create(context) {
-        const segmentInfoMap = new WeakMap();
-        const sourceCode = context.sourceCode;
-        let scopeInfo = null;
-
-        /**
-         * Checks whether the given segment is terminated by a return statement or not.
-         * @param {CodePathSegment} segment The segment to check.
-         * @returns {boolean} `true` if the segment is terminated by a return statement, or if it's still a part of unreachable.
-         */
-        function isReturned(segment) {
-            const info = segmentInfoMap.get(segment);
-
-            return !info || info.returned;
-        }
-
-        /**
-         * Collects useless return statements from the given previous segments.
-         *
-         * A previous segment may be an unreachable segment.
-         * In that case, the information object of the unreachable segment is not
-         * initialized because `onCodePathSegmentStart` event is not notified for
-         * unreachable segments.
-         * This goes to the previous segments of the unreachable segment recursively
-         * if the unreachable segment was generated by a return statement. Otherwise,
-         * this ignores the unreachable segment.
-         *
-         * This behavior would simulate code paths for the case that the return
-         * statement does not exist.
-         * @param {ASTNode[]} uselessReturns The collected return statements.
-         * @param {CodePathSegment[]} prevSegments The previous segments to traverse.
-         * @param {WeakSet<CodePathSegment>} [providedTraversedSegments] A set of segments that have already been traversed in this call
-         * @returns {ASTNode[]} `uselessReturns`.
-         */
-        function getUselessReturns(uselessReturns, prevSegments, providedTraversedSegments) {
-            const traversedSegments = providedTraversedSegments || new WeakSet();
-
-            for (const segment of prevSegments) {
-                if (!segment.reachable) {
-                    if (!traversedSegments.has(segment)) {
-                        traversedSegments.add(segment);
-                        getUselessReturns(
-                            uselessReturns,
-                            segment.allPrevSegments.filter(isReturned),
-                            traversedSegments
-                        );
-                    }
-                    continue;
-                }
-
-                if (segmentInfoMap.has(segment)) {
-                    uselessReturns.push(...segmentInfoMap.get(segment).uselessReturns);
-                }
-            }
-
-            return uselessReturns;
-        }
-
-        /**
-         * Removes the return statements on the given segment from the useless return
-         * statement list.
-         *
-         * This segment may be an unreachable segment.
-         * In that case, the information object of the unreachable segment is not
-         * initialized because `onCodePathSegmentStart` event is not notified for
-         * unreachable segments.
-         * This goes to the previous segments of the unreachable segment recursively
-         * if the unreachable segment was generated by a return statement. Otherwise,
-         * this ignores the unreachable segment.
-         *
-         * 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, usedUnreachableSegments) {
-            if (!segment.reachable) {
-                usedUnreachableSegments.add(segment);
-                segment.allPrevSegments
-                    .filter(isReturned)
-                    .filter(prevSegment => !usedUnreachableSegments.has(prevSegment))
-                    .forEach(prevSegment => markReturnStatementsOnSegmentAsUsed(prevSegment, usedUnreachableSegments));
-                return;
-            }
-
-            const info = segmentInfoMap.get(segment);
-
-            if (!info) {
-                return;
-            }
-
-            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);
-                return false;
-            });
-        }
-
-        /**
-         * Removes the return statements on the current segments from the useless
-         * return statement list.
-         *
-         * This function will be called at every statement except FunctionDeclaration,
-         * BlockStatement, and BreakStatement.
-         *
-         * - FunctionDeclarations are always executed whether it's returned or not.
-         * - BlockStatements do nothing.
-         * - BreakStatements go the next merely.
-         * @returns {void}
-         */
-        function markReturnStatementsOnCurrentSegmentsAsUsed() {
-            scopeInfo
-                .currentSegments
-                .forEach(segment => markReturnStatementsOnSegmentAsUsed(segment, new Set()));
-        }
-
-        //----------------------------------------------------------------------
-        // Public
-        //----------------------------------------------------------------------
-
-        return {
-
-            // Makes and pushes a new scope information.
-            onCodePathStart(codePath) {
-                scopeInfo = {
-                    upper: scopeInfo,
-                    uselessReturns: [],
-                    traversedTryBlockStatements: [],
-                    codePath,
-                    currentSegments: new Set()
-                };
-            },
-
-            // Reports useless return statements if exist.
-            onCodePathEnd() {
-                for (const node of scopeInfo.uselessReturns) {
-                    context.report({
-                        node,
-                        loc: node.loc,
-                        messageId: "unnecessaryReturn",
-                        fix(fixer) {
-                            if (isRemovable(node) && !sourceCode.getCommentsInside(node).length) {
-
-                                /*
-                                 * Extend the replacement range to include the
-                                 * entire function to avoid conflicting with
-                                 * no-else-return.
-                                 * https://github.com/eslint/eslint/issues/8026
-                                 */
-                                return new FixTracker(fixer, sourceCode)
-                                    .retainEnclosingFunction(node)
-                                    .remove(node);
-                            }
-                            return null;
-                        }
-                    });
-                }
-
-                scopeInfo = scopeInfo.upper;
-            },
-
-            /*
-             * Initializes segments.
-             * NOTE: This event is notified for only reachable segments.
-             */
-            onCodePathSegmentStart(segment) {
-                scopeInfo.currentSegments.add(segment);
-
-                const info = {
-                    uselessReturns: getUselessReturns([], segment.allPrevSegments),
-                    returned: false
-                };
-
-                // Stores the info.
-                segmentInfoMap.set(segment, info);
-            },
-
-            onUnreachableCodePathSegmentStart(segment) {
-                scopeInfo.currentSegments.add(segment);
-            },
-
-            onUnreachableCodePathSegmentEnd(segment) {
-                scopeInfo.currentSegments.delete(segment);
-            },
-
-            onCodePathSegmentEnd(segment) {
-                scopeInfo.currentSegments.delete(segment);
-            },
-
-            // Adds ReturnStatement node to check whether it's useless or not.
-            ReturnStatement(node) {
-                if (node.argument) {
-                    markReturnStatementsOnCurrentSegmentsAsUsed();
-                }
-                if (
-                    node.argument ||
-                    astUtils.isInLoop(node) ||
-                    isInFinally(node) ||
-
-                    // Ignore `return` statements in unreachable places (https://github.com/eslint/eslint/issues/11647).
-                    !isAnySegmentReachable(scopeInfo.currentSegments)
-                ) {
-                    return;
-                }
-
-                for (const segment of scopeInfo.currentSegments) {
-                    const info = segmentInfoMap.get(segment);
-
-                    if (info) {
-                        info.uselessReturns.push(node);
-                        info.returned = true;
-                    }
-                }
-                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.
-             */
-            ClassDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ContinueStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            DebuggerStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            DoWhileStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            EmptyStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ExpressionStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ForInStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ForOfStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ForStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            IfStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ImportDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
-            LabeledStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            SwitchStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ThrowStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            TryStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            VariableDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
-            WhileStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            WithStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ExportNamedDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ExportDefaultDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
-            ExportAllDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed
-        };
-    }
+	meta: {
+		type: "suggestion",
+
+		docs: {
+			description: "Disallow redundant return statements",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/no-useless-return",
+		},
+
+		fixable: "code",
+		schema: [],
+
+		messages: {
+			unnecessaryReturn: "Unnecessary return statement.",
+		},
+	},
+
+	create(context) {
+		const segmentInfoMap = new WeakMap();
+		const sourceCode = context.sourceCode;
+		let scopeInfo = null;
+
+		/**
+		 * Checks whether the given segment is terminated by a return statement or not.
+		 * @param {CodePathSegment} segment The segment to check.
+		 * @returns {boolean} `true` if the segment is terminated by a return statement, or if it's still a part of unreachable.
+		 */
+		function isReturned(segment) {
+			const info = segmentInfoMap.get(segment);
+
+			return !info || info.returned;
+		}
+
+		/**
+		 * Collects useless return statements from the given previous segments.
+		 *
+		 * A previous segment may be an unreachable segment.
+		 * In that case, the information object of the unreachable segment is not
+		 * initialized because `onCodePathSegmentStart` event is not notified for
+		 * unreachable segments.
+		 * This goes to the previous segments of the unreachable segment recursively
+		 * if the unreachable segment was generated by a return statement. Otherwise,
+		 * this ignores the unreachable segment.
+		 *
+		 * This behavior would simulate code paths for the case that the return
+		 * statement does not exist.
+		 * @param {ASTNode[]} uselessReturns The collected return statements.
+		 * @param {CodePathSegment[]} prevSegments The previous segments to traverse.
+		 * @param {WeakSet<CodePathSegment>} [providedTraversedSegments] A set of segments that have already been traversed in this call
+		 * @returns {ASTNode[]} `uselessReturns`.
+		 */
+		function getUselessReturns(
+			uselessReturns,
+			prevSegments,
+			providedTraversedSegments,
+		) {
+			const traversedSegments =
+				providedTraversedSegments || new WeakSet();
+
+			for (const segment of prevSegments) {
+				if (!segment.reachable) {
+					if (!traversedSegments.has(segment)) {
+						traversedSegments.add(segment);
+						getUselessReturns(
+							uselessReturns,
+							segment.allPrevSegments.filter(isReturned),
+							traversedSegments,
+						);
+					}
+					continue;
+				}
+
+				if (segmentInfoMap.has(segment)) {
+					uselessReturns.push(
+						...segmentInfoMap.get(segment).uselessReturns,
+					);
+				}
+			}
+
+			return uselessReturns;
+		}
+
+		/**
+		 * Removes the return statements on the given segment from the useless return
+		 * statement list.
+		 *
+		 * This segment may be an unreachable segment.
+		 * In that case, the information object of the unreachable segment is not
+		 * initialized because `onCodePathSegmentStart` event is not notified for
+		 * unreachable segments.
+		 * This goes to the previous segments of the unreachable segment recursively
+		 * if the unreachable segment was generated by a return statement. Otherwise,
+		 * this ignores the unreachable segment.
+		 *
+		 * 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,
+			usedUnreachableSegments,
+		) {
+			if (!segment.reachable) {
+				usedUnreachableSegments.add(segment);
+				segment.allPrevSegments
+					.filter(isReturned)
+					.filter(
+						prevSegment =>
+							!usedUnreachableSegments.has(prevSegment),
+					)
+					.forEach(prevSegment =>
+						markReturnStatementsOnSegmentAsUsed(
+							prevSegment,
+							usedUnreachableSegments,
+						),
+					);
+				return;
+			}
+
+			const info = segmentInfoMap.get(segment);
+
+			if (!info) {
+				return;
+			}
+
+			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);
+				return false;
+			});
+		}
+
+		/**
+		 * Removes the return statements on the current segments from the useless
+		 * return statement list.
+		 *
+		 * This function will be called at every statement except FunctionDeclaration,
+		 * BlockStatement, and BreakStatement.
+		 *
+		 * - FunctionDeclarations are always executed whether it's returned or not.
+		 * - BlockStatements do nothing.
+		 * - BreakStatements go the next merely.
+		 * @returns {void}
+		 */
+		function markReturnStatementsOnCurrentSegmentsAsUsed() {
+			scopeInfo.currentSegments.forEach(segment =>
+				markReturnStatementsOnSegmentAsUsed(segment, new Set()),
+			);
+		}
+
+		//----------------------------------------------------------------------
+		// Public
+		//----------------------------------------------------------------------
+
+		return {
+			// Makes and pushes a new scope information.
+			onCodePathStart(codePath) {
+				scopeInfo = {
+					upper: scopeInfo,
+					uselessReturns: [],
+					traversedTryBlockStatements: [],
+					codePath,
+					currentSegments: new Set(),
+				};
+			},
+
+			// Reports useless return statements if exist.
+			onCodePathEnd() {
+				for (const node of scopeInfo.uselessReturns) {
+					context.report({
+						node,
+						loc: node.loc,
+						messageId: "unnecessaryReturn",
+						fix(fixer) {
+							if (
+								isRemovable(node) &&
+								!sourceCode.getCommentsInside(node).length
+							) {
+								/*
+								 * Extend the replacement range to include the
+								 * entire function to avoid conflicting with
+								 * no-else-return.
+								 * https://github.com/eslint/eslint/issues/8026
+								 */
+								return new FixTracker(fixer, sourceCode)
+									.retainEnclosingFunction(node)
+									.remove(node);
+							}
+							return null;
+						},
+					});
+				}
+
+				scopeInfo = scopeInfo.upper;
+			},
+
+			/*
+			 * Initializes segments.
+			 * NOTE: This event is notified for only reachable segments.
+			 */
+			onCodePathSegmentStart(segment) {
+				scopeInfo.currentSegments.add(segment);
+
+				const info = {
+					uselessReturns: getUselessReturns(
+						[],
+						segment.allPrevSegments,
+					),
+					returned: false,
+				};
+
+				// Stores the info.
+				segmentInfoMap.set(segment, info);
+			},
+
+			onUnreachableCodePathSegmentStart(segment) {
+				scopeInfo.currentSegments.add(segment);
+			},
+
+			onUnreachableCodePathSegmentEnd(segment) {
+				scopeInfo.currentSegments.delete(segment);
+			},
+
+			onCodePathSegmentEnd(segment) {
+				scopeInfo.currentSegments.delete(segment);
+			},
+
+			// Adds ReturnStatement node to check whether it's useless or not.
+			ReturnStatement(node) {
+				if (node.argument) {
+					markReturnStatementsOnCurrentSegmentsAsUsed();
+				}
+				if (
+					node.argument ||
+					astUtils.isInLoop(node) ||
+					isInFinally(node) ||
+					// Ignore `return` statements in unreachable places (https://github.com/eslint/eslint/issues/11647).
+					!isAnySegmentReachable(scopeInfo.currentSegments)
+				) {
+					return;
+				}
+
+				for (const segment of scopeInfo.currentSegments) {
+					const info = segmentInfoMap.get(segment);
+
+					if (info) {
+						info.uselessReturns.push(node);
+						info.returned = true;
+					}
+				}
+				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.
+			 */
+			ClassDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ContinueStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			DebuggerStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			DoWhileStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			EmptyStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ExpressionStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ForInStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ForOfStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ForStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			IfStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ImportDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
+			LabeledStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			SwitchStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ThrowStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			TryStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			VariableDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
+			WhileStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			WithStatement: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ExportNamedDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
+			ExportDefaultDeclaration:
+				markReturnStatementsOnCurrentSegmentsAsUsed,
+			ExportAllDeclaration: markReturnStatementsOnCurrentSegmentsAsUsed,
+		};
+	},
 };