Render modules as namespaces

Author: Soc Sieng

src/render/container-renderer.ts

@@ -6,7 +6,7 @@ import join from '../util/join';
 import { propertySorter } from '../util/sort';
 
 export default class ContainerRenderer extends ReflectionRenderer {
-  private _type: string;
+  protected _type: string;
 
   constructor(type: string) {
     super();

src/render/module-renderer.ts

@@ -0,0 +1,74 @@
+import { DeclarationReflection, Reflection, ReflectionKind } from 'typedoc/dist/lib/models';
+import ContainerRenderer from './container-renderer';
+import join from '../util/join';
+
+export default class ModuleRenderer extends ContainerRenderer {
+  constructor() {
+    super('module');
+  }
+
+  public render(node: Reflection): string {
+    if (this.isNamespace(node)) {
+      let renderNode = node as DeclarationReflection;
+      const nodeNames: string[] = [];
+      let latestComment: string | undefined;
+      let currentComment: string | undefined;
+
+      do {
+        currentComment = this.renderComment(renderNode);
+
+        // cannot combine modules into namespace because comments differ
+        if (latestComment && currentComment && latestComment !== currentComment) {
+          break;
+        }
+
+        if (currentComment) {
+          latestComment = currentComment;
+        }
+
+        nodeNames.push(renderNode.name);
+        if (renderNode.children?.length === 1 && renderNode.children[0].kindOf(ReflectionKind.SomeModule)) {
+          const nextNode = renderNode.children[0];
+          const nextComment = this.renderComment(nextNode);
+
+          // cannot combine modules into namespace because comments differ
+          if (latestComment && nextComment && latestComment !== nextComment) {
+            break;
+          }
+
+          renderNode = nextNode;
+        } else {
+          break;
+        }
+      } while (this.isNamespace(renderNode));
+
+      const lines: string[] = [];
+      const declarationParts: string[] = [
+        this.isTop(node) ? 'declare' : '',
+        'namespace', `${nodeNames.join('.')}`
+      ];
+
+      if (latestComment) {
+        this.pushIfTruthy(lines, latestComment);
+      }
+
+      lines.push(join(' ', ...declarationParts, '{'));
+
+      const body = this.renderBody(renderNode);
+      if (body) {
+        lines.push(body);
+      }
+
+      lines.push('}');
+
+      return lines.join('\n');
+    }
+
+    return super.render(node);
+  }
+
+  private isNamespace(node: Reflection) {
+    const hasSpecialCharacterExpression = /[^\w]/;
+    return !hasSpecialCharacterExpression.test(node.name);
+  }
+}

src/render/renderers.ts

@@ -8,6 +8,7 @@ import FunctionRenderer from './function-renderer';
 import GetSignatureRenderer from './get-signature-renderer';
 import IndexSignatureRenderer from './index-signature-renderer';
 import MethodRenderer from './method-renderer';
+import ModuleRenderer from './module-renderer';
 import ObjectLiteralRenderer from './object-literal-renderer';
 import ParameterRenderer from './parameter-renderer';
 import ProjectRenderer from './project-renderer';
@@ -28,14 +29,14 @@ export const renderers: { [kind: number]: ReflectionRenderer } = {
   [ReflectionKind.Enum]: new ContainerRenderer('enum'),
   [ReflectionKind.EnumMember]: new EnumMemberRenderer(),
   [ReflectionKind.Event]: new EventRenderer(),
-  [ReflectionKind.ExternalModule]: new ContainerRenderer('module'),
+  [ReflectionKind.ExternalModule]: new ModuleRenderer(),
   [ReflectionKind.Function]: new FunctionRenderer(),
   [ReflectionKind.GetSignature]: new GetSignatureRenderer(),
   [ReflectionKind.Global]: new ProjectRenderer(),
   [ReflectionKind.IndexSignature]: new IndexSignatureRenderer(),
   [ReflectionKind.Interface]: new ContainerRenderer('interface'),
   [ReflectionKind.Method]: new MethodRenderer(),
-  [ReflectionKind.Module]: new ContainerRenderer('module'),
+  [ReflectionKind.Module]: new ModuleRenderer(),
   [ReflectionKind.ObjectLiteral]: new ObjectLiteralRenderer(),
   [ReflectionKind.Parameter]: new ParameterRenderer(),
   [ReflectionKind.Property]: new PropertyRenderer(),

tests/dynamic-tests.ts

@@ -41,7 +41,7 @@ function createApplication(logOutput: string[]) {
 }
 
 function normalizeWhitespace(input: string) {
-  return input.replace(/^$\r?\n/gm, '').replace(/\s+/gm, '');
+  return input.replace(/^$\r?\n/gm, '').replace(/\s+$/gm, '');
 }
 
 describe('Dynamic test suite', () => {

tests/test-data/comments/exact.d.ts

@@ -1,4 +1,4 @@
-declare module CommentsTest {
+declare namespace CommentsTest {
   /**
    * This is the comment's short text
    *

tests/test-data/export/exact.d.ts

@@ -1,7 +1,7 @@
 /**
  * Export test
  */
-declare module ExportTest {
+declare namespace ExportTest {
   class ExportedClass {
     private doSomethingPrivate(): void;
 

tests/test-data/function/destructuring-expected.d.ts

@@ -1,4 +1,4 @@
-declare module test {
+declare namespace test {
   /**
    * Adds many numbers together
    */

tests/test-data/function/destructuring-input.ts

@@ -1,4 +1,4 @@
-export module test {
+export namespace test {
   /**
    * Adds many numbers together
    */

tests/test-data/function/expected.d.ts

@@ -1,4 +1,4 @@
-declare module test {
+declare namespace test {
   /**
    * Adds two numbers together
    */

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

@@ -1,4 +1,4 @@
-declare module Handlers {
+declare namespace Handlers {
   type MyUncommentedHandler = (foo: any) => any;
 
   /**