refactor: simplify JSDoc comment detection logic (#20360)

Pixel998 · web-flow · commit 311502143949 · 2025-12-02T17:12:05.000+01:00
* refactor: simplify JSDoc comment detection logic

* clean up JSDoc comments and rename looksLikeExport
diff --git a/lib/rules/utils/ast-utils.js b/lib/rules/utils/ast-utils.js
@@ -704,60 +704,63 @@ function isKeywordToken(token) {
 }
 
 /**
- * Check to see if its a ES6 export declaration.
- * @param {ASTNode} astNode An AST node.
- * @returns {boolean} whether the given node represents an export declaration.
+ * Checks whether the given node represents an ES6 export declaration.
+ * @param {ASTNode} node A node to check.
+ * @returns {boolean} `true` if the node is an export declaration.
  * @private
  */
-function looksLikeExport(astNode) {
+function isExportDeclaration(node) {
 	return (
-		astNode.type === "ExportDefaultDeclaration" ||
-		astNode.type === "ExportNamedDeclaration" ||
-		astNode.type === "ExportAllDeclaration" ||
-		astNode.type === "ExportSpecifier"
+		node.type === "ExportDefaultDeclaration" ||
+		node.type === "ExportNamedDeclaration" ||
+		node.type === "ExportAllDeclaration"
 	);
 }
 
 /**
- * Retrieves the JSDoc comment for a given node.
- * @param {ASTNode} node The AST node to get the comment for.
+ * Checks for the presence of a JSDoc comment for the given node and returns it.
+ * @param {ASTNode} node The node to get the comment for.
  * @param {SourceCode} sourceCode A SourceCode instance to get comments.
  * @returns {Token|null} The Block comment token containing the JSDoc comment for the given node or null if not found.
  * @private
  */
-function getJSDocComment(node, sourceCode) {
-	/**
-	 * Checks for the presence of a JSDoc comment for the given node and returns it.
-	 * @param {ASTNode} astNode The AST node to get the comment for.
-	 * @returns {Token|null} The Block comment token containing the JSDoc comment for the given node or null if not found.
-	 * @private
-	 */
-	function findJSDocComment(astNode) {
-		const tokenBefore = sourceCode.getTokenBefore(astNode, {
-			includeComments: true,
-		});
+function findJSDocComment(node, sourceCode) {
+	const tokenBefore = sourceCode.getTokenBefore(node, {
+		includeComments: true,
+	});
 
-		if (
-			tokenBefore &&
-			isCommentToken(tokenBefore) &&
-			tokenBefore.type === "Block" &&
-			tokenBefore.value.charAt(0) === "*" &&
-			astNode.loc.start.line - tokenBefore.loc.end.line <= 1
-		) {
-			return tokenBefore;
-		}
-
-		return null;
+	if (
+		tokenBefore &&
+		tokenBefore.type === "Block" &&
+		tokenBefore.value.charAt(0) === "*" &&
+		node.loc.start.line - tokenBefore.loc.end.line <= 1
+	) {
+		return tokenBefore;
 	}
+
+	return null;
+}
+
+/**
+ * Retrieves the JSDoc comment for a given node.
+ * @param {ASTNode} node The node to get the comment for.
+ * @param {SourceCode} sourceCode A SourceCode instance to get comments.
+ * @returns {Token|null} The Block comment token containing the JSDoc comment for the given node or null if not found.
+ * @private
+ */
+function getJSDocComment(node, sourceCode) {
 	let parent = node.parent;
 
 	switch (node.type) {
 		case "ClassDeclaration":
 		case "FunctionDeclaration":
-			return findJSDocComment(looksLikeExport(parent) ? parent : node);
+			return findJSDocComment(
+				isExportDeclaration(parent) ? parent : node,
+				sourceCode,
+			);
 
 		case "ClassExpression":
-			return findJSDocComment(parent.parent);
+			return findJSDocComment(parent.parent, sourceCode);
 
 		case "ArrowFunctionExpression":
 		case "FunctionExpression":
@@ -783,11 +786,11 @@ function getJSDocComment(node, sourceCode) {
 					parent.type !== "FunctionDeclaration" &&
 					parent.type !== "Program"
 				) {
-					return findJSDocComment(parent);
+					return findJSDocComment(parent, sourceCode);
 				}
 			}
 
-			return findJSDocComment(node);
+			return findJSDocComment(node, sourceCode);
 
 		// falls through
 		default:
