chore(refactor): moved comment parts to helper file

typedoc2md · Jun 29, 2024 · ef4ce36 · ef4ce36
1 parent 4be65e4
commit ef4ce36
Show file tree

Hide file tree

Showing 17 changed files with 34 additions and 100 deletions.
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-description-for-reflection.ts
@@ -9,8 +9,8 @@ export function getDescriptionForReflection(
     ? model.signatures[0].comment
     : model.comment;
   if (comment?.summary?.length) {
-    return this.partials
-      .commentParts(comment.summary)
+    return this.helpers
+      .getCommentParts(comment.summary)
       ?.split('\n\n')[0]
       .replace(/\n/g, ' ');
   }

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/_index.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/_index.ts
@@ -1,5 +1,4 @@
 export * from './comments.comment';
-export * from './comments.commentParts';
 export * from './container.body';
 export * from './container.categories';
 export * from './container.groups';

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts
@@ -94,7 +94,7 @@ export function comment(
             ? heading(opts.headingLevel, tagText) + '\n'
             : bold(tagText) + '\n',
         ];
-        tagMd.push(this.partials.commentParts(tag.content));
+        tagMd.push(this.helpers.getCommentParts(tag.content));
         return tagMd.join('\n');
       });
     md.push(tags.join('\n\n'));

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.commentParts.ts
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/container.categories.ts
@@ -13,7 +13,7 @@ export function categories(
     .forEach((category) => {
       md.push(heading(options.headingLevel, category.title));
       if (category.description) {
-        md.push(this.partials.commentParts(category.description));
+        md.push(this.helpers.getCommentParts(category.description));
       }
       if (category.children) {
         md.push(

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/container.groups.ts
@@ -26,7 +26,7 @@ export function groups(
     if (group.categories) {
       md.push(heading(options.headingLevel, getGroupTitle(group.title)));
       if (group.description) {
-        md.push(this.partials.commentParts(group.description));
+        md.push(this.helpers.getCommentParts(group.description));
       }
       md.push(
         this.partials.categories(group.categories, {
@@ -44,7 +44,7 @@ export function groups(
 
       md.push(heading(options.headingLevel, getGroupTitle(group.title)));
       if (group.description) {
-        md.push(this.partials.commentParts(group.description));
+        md.push(this.helpers.getCommentParts(group.description));
       }
       if (
         isPropertiesGroup &&

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.reflectionIndex.ts
@@ -17,7 +17,7 @@ export function reflectionIndex(
     model.categories.forEach((categoryGroup) => {
       md.push(heading(options.headingLevel, categoryGroup.title) + '\n');
       if (categoryGroup.description) {
-        md.push(this.partials.commentParts(categoryGroup.description) + '\n');
+        md.push(this.helpers.getCommentParts(categoryGroup.description) + '\n');
       }
       md.push(this.helpers.getGroupIndex(categoryGroup) + '\n');
     });
@@ -36,7 +36,7 @@ export function reflectionIndex(
           );
           if (categoryGroup.description) {
             md.push(
-              this.partials.commentParts(categoryGroup.description) + '\n',
+              this.helpers.getCommentParts(categoryGroup.description) + '\n',
             );
           }
           md.push(this.helpers.getGroupIndex(categoryGroup) + '\n');

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts
@@ -86,9 +86,9 @@ export function signature(
     this.partials.inheritance(model, { headingLevel: options.headingLevel }),
   );
 
-  if (model.comment) {
+  if (modelComments) {
     md.push(
-      this.partials.comment(model.comment, {
+      this.partials.comment(modelComments, {
         headingLevel: options.headingLevel,
         showSummary: false,
       }),

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureReturns.ts
@@ -28,7 +28,7 @@ export function signatureReturns(
   if (model.comment?.blockTags.length) {
     const tags = model.comment.blockTags
       .filter((tag) => tag.tag === '@returns')
-      .map((tag) => this.partials.commentParts(tag.content));
+      .map((tag) => this.helpers.getCommentParts(tag.content));
     md.push(tags.join('\n\n'));
   }
 

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts
@@ -77,8 +77,6 @@ export const resourcePartials = (context: MarkdownThemeContext) => {
         isTableColumn?: boolean | undefined;
       } = {},
     ) => partials.comment.apply(context, [model, options]) as string,
-    commentParts: (model: CommentDisplayPart[]) =>
-      partials.commentParts.apply(context, [model]) as string,
     body: (model: ContainerReflection, options: { headingLevel: number }) =>
       partials.body.apply(context, [model, options]) as string,
     categories: (

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts b/packages/typedoc-plugin-markdown/src/theme/context/templates/document.ts
@@ -19,7 +19,7 @@ export function document(
     md.push(this.partials.breadcrumbs());
   }
 
-  md.push(this.partials.commentParts(page.model.content));
+  md.push(this.helpers.getCommentParts(page.model.content));
 
   md.push(this.partials.footer());
 

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts b/packages/typedoc-plugin-markdown/src/theme/context/templates/project.ts
@@ -21,7 +21,7 @@ export function project(
     this.page.project.url === this.page.url &&
     this.options.getValue('entryPointStrategy') === EntryPointStrategy.Packages;
 
-  md.push(this.hook('index.page.begin').join('\n'));
+  md.push(this.hook('index.page.begin', this).join('\n'));
 
   if (!this.options.getValue('hidePageHeader')) {
     md.push(this.partials.header());
@@ -35,14 +35,14 @@ export function project(
     this.options.getValue('mergeReadme') && Boolean(page.model.readme);
 
   if (includeReadme && page.model.readme) {
-    md.push(this.partials.commentParts(page.model.readme));
+    md.push(this.helpers.getCommentParts(page.model.readme));
   }
 
   if (!this.options.getValue('hidePageTitle') && !includeReadme) {
     md.push(heading(1, this.partials.pageTitle()));
   }
 
-  md.push(this.hook('content.begin').join('\n'));
+  md.push(this.hook('content.begin', this).join('\n'));
 
   if (page.model.comment) {
     md.push(this.partials.comment(page.model.comment, { headingLevel: 2 }));
@@ -72,7 +72,7 @@ export function project(
 
   md.push(this.partials.footer());
 
-  md.push(this.hook('index.page.end').join('\n'));
+  md.push(this.hook('index.page.end', this).join('\n'));
 
   return md.join('\n\n');
 }
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts b/packages/typedoc-plugin-markdown/src/theme/context/templates/read-me.ts
@@ -21,7 +21,7 @@ export function readme(
 
   if (Boolean(page.model.readme)) {
     md.push(
-      this.partials.commentParts(page.model.readme as CommentDisplayPart[]),
+      this.helpers.getCommentParts(page.model.readme as CommentDisplayPart[]),
     );
   }
 

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts b/packages/typedoc-plugin-markdown/src/theme/context/templates/reflection.ts
@@ -12,7 +12,7 @@ export function reflection(
 ) {
   const md: string[] = [];
 
-  md.push(this.hook('page.begin').join('\n'));
+  md.push(this.hook('page.begin', this).join('\n'));
 
   if (!this.options.getValue('hidePageHeader')) {
     md.push(this.partials.header());
@@ -26,7 +26,7 @@ export function reflection(
     md.push(heading(1, this.partials.pageTitle()));
   }
 
-  md.push(this.hook('content.begin').join('\n'));
+  md.push(this.hook('content.begin', this).join('\n'));
 
   if (
     [
@@ -44,7 +44,7 @@ export function reflection(
 
   md.push(this.partials.footer());
 
-  md.push(this.hook('page.end').join('\n'));
+  md.push(this.hook('page.end', this).join('\n'));
 
   return md.join('\n\n');
 }
diff --git a/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts b/packages/typedoc-plugin-markdown/src/theme/markdown-themeContext.ts
@@ -5,11 +5,7 @@ import {
   resourcePartials,
   resourceTemplates,
 } from '@plugin/theme/context/resources';
-import {
-  MarkdownRenderer,
-  MarkdownRendererHooks,
-  PackageMetaData,
-} from '@plugin/types';
+import { MarkdownRenderer, PackageMetaData } from '@plugin/types';
 import * as path from 'path';
 import { Internationalization, Options, Reflection } from 'typedoc';
 
@@ -161,6 +157,7 @@ export class MarkdownThemeContext {
    *
    * @internal
    */
-  hook = (name: keyof MarkdownRendererHooks) =>
-    (this.theme.owner as MarkdownRenderer).markdownHooks.emit(name, this);
+  hook: MarkdownRenderer['markdownHooks']['emit'] = (...params) => {
+    return (this.theme.owner as MarkdownRenderer).markdownHooks.emit(...params);
+  };
 }
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/functions.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/functions.ts
@@ -6,6 +6,8 @@
  * This is a function that is assigned to a variable.
  *
  * @param someParam  This is some numeric parameter.
+ *
+ * @see http://abc.com
  */
 export const basicFunction = (someParam: number) => {
   return 0;

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.function.spec.ts.snap
@@ -262,6 +262,10 @@ This is some numeric parameter.
 
 \`number\`
 
+## See
+
+http://abc.com
+
 ## Source
 
 [functions.ts:1](http://source-url)
@@ -287,6 +291,10 @@ This is a function that is assigned to a variable.
 
 \`number\`
 
+## See
+
+http://abc.com
+
 ## Source
 
 [functions.ts:1](http://source-url)