fix(module): Remove empty comment blocks of merge target modules

Closes #142
christopherthielen · Jan 14, 2020 · c800a22 · c800a22
1 parent 89b4141
commit c800a22
Show file tree

Hide file tree

Showing 13 changed files with 254 additions and 4 deletions.
diff --git a/plugin.ts b/plugin.ts
@@ -1,10 +1,11 @@
-import { Reflection, ReflectionKind } from 'typedoc/dist/lib/models/reflections/abstract';
-import { DeclarationReflection } from 'typedoc/dist/lib/models/reflections/declaration';
 import { Component, ConverterComponent } from 'typedoc/dist/lib/converter/components';
-import { Converter } from 'typedoc/dist/lib/converter/converter';
 import { Context } from 'typedoc/dist/lib/converter/context';
+import { Converter } from 'typedoc/dist/lib/converter/converter';
 import { CommentPlugin } from 'typedoc/dist/lib/converter/plugins/CommentPlugin';
+import { Comment } from 'typedoc/dist/lib/models';
+import { Reflection, ReflectionKind } from 'typedoc/dist/lib/models/reflections/abstract';
 import { ContainerReflection } from 'typedoc/dist/lib/models/reflections/container';
+import { DeclarationReflection } from 'typedoc/dist/lib/models/reflections/declaration';
 import { getRawComment } from './getRawComment';
 
 /**
@@ -63,7 +64,7 @@ export class ExternalModuleNamePlugin extends ConverterComponent {
    * @param node  The node that is currently processed if available.
    */
   private onDeclaration(context: Context, reflection: Reflection, node?) {
-    if (reflection.kindOf(ReflectionKind.ExternalModule)) {
+    if (reflection.kindOf(ReflectionKind.ExternalModule) || reflection.kindOf(ReflectionKind.Module)) {
       let comment = getRawComment(node);
       // Look for @module
       let match = /@module\s+([\w\u4e00-\u9fa5\.\-_/@"]+)/.exec(comment);
@@ -160,10 +161,17 @@ export class ExternalModuleNamePlugin extends ConverterComponent {
       // Remove @module and @preferred from the comment, if found.
       CommentPlugin.removeTags(mergeTarget.comment, 'module');
       CommentPlugin.removeTags(mergeTarget.comment, 'preferred');
+      if (isEmptyComment(mergeTarget.comment)) {
+        delete mergeTarget.comment;
+      }
     });
   }
 }
 
+function isEmptyComment(comment: Comment) {
+  return !comment || (!comment.text && !comment.shortText && (!comment.tags || comment.tags.length === 0));
+}
+
 interface ModuleRename {
   renameTo: string;
   preferred: boolean;

diff --git a/test/typedoc-0.10.0/cypress/integration/example_spec.js b/test/typedoc-0.10.0/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.11.1/cypress/integration/example_spec.js b/test/typedoc-0.11.1/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.12.0/cypress/integration/example_spec.js b/test/typedoc-0.12.0/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.13.0/cypress/integration/example_spec.js b/test/typedoc-0.13.0/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.14.0/cypress/integration/example_spec.js b/test/typedoc-0.14.0/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.5.10/cypress/integration/example_spec.js b/test/typedoc-0.5.10/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.6.0/cypress/integration/example_spec.js b/test/typedoc-0.6.0/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.7.2/cypress/integration/example_spec.js b/test/typedoc-0.7.2/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.8.0/cypress/integration/example_spec.js b/test/typedoc-0.8.0/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-0.9.0/cypress/integration/example_spec.js b/test/typedoc-0.9.0/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');
 

diff --git a/test/typedoc-latest.tgz b/test/typedoc-latest.tgz
diff --git a/test/typedoc-latest/cypress/integration/example_spec.js b/test/typedoc-latest/cypress/integration/example_spec.js
@@ -41,6 +41,28 @@ describe('docs', () => {
       .contains('File2');
   });
 
+  it('renders File1 doc comment', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('a')
+      .contains('File1')
+      .click();
+
+    cy.contains('This is in the root module');
+  });
+
+  it('does not render empty comment blocks where @module used to be', () => {
+    cy.visit('/');
+
+    cy.get('a')
+      .contains('root')
+      .click();
+    cy.get('section.tsd-comment').should('not.exist');
+  });
+
   it('renders Nest1 in dir1', () => {
     cy.visit('/');