Improve generated JSDoc for @return tags

Shopify · Aug 8, 2024 · ab039ad · ab039ad
1 parent f4fe587
commit ab039ad
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/packages/cli/src/lib/transpile/morph/functions.ts b/packages/cli/src/lib/transpile/morph/functions.ts
@@ -42,9 +42,16 @@ export function generateFunctionDocumentation(
     const declaration = functionNode as FunctionDeclaration;
     const jsDocs = declaration.getJsDocs()[0];
 
-    if (jsDocs?.getTags().length === 0) {
+    if (
+      jsDocs &&
+      !jsDocs.getTags().find((tag) => tag.getTagName() === 'return')
+    ) {
       const returnType = declaration.getReturnType().getText();
-      if (isAnnotableType(returnType)) {
+      const hasManuallySpecifiedReturnType = !!declaration
+        .getSignature()
+        .compilerSignature.getReturnType().aliasSymbol;
+
+      if (hasManuallySpecifiedReturnType) {
         jsDocs.addTag({tagName: 'return', text: normalizeType(returnType)});
       }
     }