Fix rendering of handlers with comments and parameters

Author: socsieng

src/render/comment-renderer.ts

@@ -24,8 +24,8 @@ export default class CommentRenderer {
       const paramsSection: string[] = [];
       if (signature.parameters) {
         const paramComments = signature.parameters
-          .filter(p => p.comment?.text)
-          .map(p => this.renderMultilineComment(`@param ${p.name}`, p.comment!.text!))
+          .filter(p => p.comment?.text || p.comment?.shortText)
+          .map(p => this.renderMultilineComment(`@param ${p.name}`, p.comment?.text || p.comment?.shortText || ''))
           .join('\n');
 
         if (paramComments.length) {

src/render/type-literal-renderer.ts

@@ -10,13 +10,15 @@ export default class TypeLiteralRenderer extends ContainerRenderer {
 
   public render(node: Reflection): string {
     const lines: string[] = [];
+    const member = node as DeclarationReflection;
+    let indent = false;
 
-    if (node.comment) {
+    if (member.signatures && member.signatures[0]?.comment) {
+      indent = true;
+    } else if (node.comment) {
       this.pushIfTruthy(lines, this.renderComment(node));
     }
 
-    const member = node as DeclarationReflection;
-
     if (member.children || member.indexSignature) {
       const children = [...(member.children || []), member.indexSignature].filter(c => c);
       if (node.parent?.kind === ReflectionKind.TypeAlias) {
@@ -28,7 +30,12 @@ export default class TypeLiteralRenderer extends ContainerRenderer {
         lines.push(join(' ', '{', children.map(c => ReflectionFormatter.instance().render(c)).join(', '), '}'));
       }
     } else if (member.signatures) {
-      lines.push(ReflectionFormatter.instance().render(member.signatures[0]));
+      let signature = ReflectionFormatter.instance().render(member.signatures[0]);
+      if (indent) {
+        lines.push('\n');
+        signature = signature.split('\n').map(l => `  ${l}`).join('\n');
+      }
+      lines.push(signature);
     } else if (member.name === '__type') {
       lines.push('{}');
     }

tests/dynamic-tests.ts

@@ -40,8 +40,8 @@ function createApplication(logOutput: string[]) {
   return app;
 }
 
-function removeBlankLines(input: string) {
-  return input.replace(/^$\r?\n/gm, '');
+function normalizeWhitespace(input: string) {
+  return input.replace(/^$\r?\n/gm, '').replace(/\s+/gm, '');
 }
 
 describe('Dynamic test suite', () => {
@@ -98,7 +98,7 @@ describe('Dynamic test suite', () => {
       if (writeOutput) {
         fs.writeFileSync(outputDeclarationFile, result);
       }
-      expect(removeBlankLines(result)).toBe(removeBlankLines(expectedOutput.trim()));
+      expect(normalizeWhitespace(result)).toBe(normalizeWhitespace(expectedOutput.trim()));
     } else {
       console.log(logOutput.join('\n'));
       expect(logOutput).toEqual([]);

tests/test-data/function/handler-exact.d.ts

@@ -0,0 +1,14 @@
+declare module Handlers {
+  type MyUncommentedHandler = (foo: any) => any;
+
+  /**
+   * My comment
+   */
+  type MyCommentedHandler =
+    /**
+     * Handler comment
+     *
+     * @param foo can be anything
+     */
+    (foo: any) => any;
+}