fix: Improve detection for "property methods" to convert as methods

Resolves #1624
TypeStrong · Jul 10, 2021 · 98331b5 · 98331b5
1 parent 5fd7f87
commit 98331b5
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 2 deletions.
diff --git a/src/lib/converter/factories/comment.ts b/src/lib/converter/factories/comment.ts
@@ -119,6 +119,8 @@ export function getRawComment(
         node = node.parent;
     } else if (node.kind === ts.SyntaxKind.ExportSpecifier) {
         node = node.parent.parent;
+    } else if (node.kind === ts.SyntaxKind.FunctionType) {
+        node = node.parent;
     }
 
     const sourceFile = node.getSourceFile();

diff --git a/src/lib/converter/symbols.ts b/src/lib/converter/symbols.ts
@@ -545,9 +545,10 @@ function convertProperty(
         return convertFunctionOrMethod(context, symbol, exportSymbol);
     }
 
-    // Special case: "arrow methods" should be treated as methods.
     if (declarations.length === 1) {
         const declaration = declarations[0];
+
+        // Special case: "arrow methods" should be treated as methods.
         if (
             ts.isPropertyDeclaration(declaration) &&
             !declaration.type &&
@@ -561,6 +562,20 @@ function convertProperty(
                 exportSymbol
             );
         }
+
+        // Special case: "arrow properties" in type space should be treated as methods.
+        if (
+            ts.isPropertySignature(declaration) &&
+            declaration.type &&
+            ts.isFunctionTypeNode(declaration.type)
+        ) {
+            return convertArrowAsMethod(
+                context,
+                symbol,
+                declaration.type,
+                exportSymbol
+            );
+        }
     }
 
     const reflection = context.createDeclarationReflection(
@@ -610,7 +625,7 @@ function convertProperty(
 function convertArrowAsMethod(
     context: Context,
     symbol: ts.Symbol,
-    arrow: ts.ArrowFunction,
+    arrow: ts.ArrowFunction | ts.FunctionTypeNode,
     exportSymbol?: ts.Symbol
 ) {
     const reflection = context.createDeclarationReflection(

diff --git a/src/test/converter/alias/specs.json b/src/test/converter/alias/specs.json
@@ -110,6 +110,9 @@
           "kind": 65536,
           "kindString": "Type literal",
           "flags": {},
+          "comment": {
+            "shortText": "A type that describes a compare function, e.g. for array.sort()."
+          },
           "signatures": [
             {
               "id": 3,

diff --git a/src/test/converter/mixin/specs.json b/src/test/converter/mixin/specs.json
@@ -916,6 +916,9 @@
           "kind": 65536,
           "kindString": "Type literal",
           "flags": {},
+          "comment": {
+            "shortText": "Any function"
+          },
           "signatures": [
             {
               "id": 3,

diff --git a/src/test/converter2.test.ts b/src/test/converter2.test.ts
@@ -217,6 +217,13 @@ const issueTests: Record<string, (project: ProjectReflection) => void> = {
             "Overwritten method with no comment should be inherited"
         );
     },
+
+    gh1624(project) {
+        ok(
+            query(project, "Foo.baz").signatures?.[0]?.hasComment(),
+            "Property methods declared in interface should still allow comment inheritance"
+        );
+    },
 };
 
 describe("Converter2", () => {

diff --git a/src/test/converter2/issues/gh1624.ts b/src/test/converter2/issues/gh1624.ts
@@ -0,0 +1,10 @@
+export interface Bar {
+    /** Some property style doc. */
+    baz: () => number;
+}
+
+export class Foo implements Bar {
+    baz(): number {
+        return 0;
+    }
+}
diff --git a/src/test/renderer/specs/classes/flattened.FlattenedClass.html b/src/test/renderer/specs/classes/flattened.FlattenedClass.html
@@ -171,6 +171,11 @@ <h3>callback</h3>
 					<div class="tsd-signature tsd-kind-icon">callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, optionalParam<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>A member that holds a callback that requires a typed function signature.</p>
+						</div>
+					</div>
 					<div class="tsd-type-declaration">
 						<h4>Type declaration</h4>
 						<ul class="tsd-parameters">
@@ -356,6 +361,11 @@ <h3>single<wbr>Call<wbr>Signature</h3>
 					<div class="tsd-signature tsd-kind-icon">single<wbr>Call<wbr>Signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>Single call signature.</p>
+						</div>
+					</div>
 					<div class="tsd-type-declaration">
 						<h4>Type declaration</h4>
 						<ul class="tsd-parameters">