fix(core): fix display of index descriptions in tables

typedoc2md · May 17, 2024 · 16712a4 · 16712a4
1 parent 4fa4093
commit 16712a4
Show file tree

Hide file tree

Showing 10 changed files with 313 additions and 169 deletions.
diff --git a/.changeset/yellow-beds-smile.md b/.changeset/yellow-beds-smile.md
@@ -1,5 +1,6 @@
 ---
-"typedoc-plugin-markdown": patch
+'typedoc-plugin-markdown': patch
 ---
 
 - Remove superfluous quotes from prop names (#619)
+- Fix display of index descriptions in tables (#619)
diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/helpers/get-declaration-comment.ts b/packages/typedoc-plugin-markdown/src/theme/resources/helpers/get-declaration-comment.ts
@@ -4,8 +4,5 @@ export function getDeclarationComment(model: DeclarationReflection) {
   if (model.signatures?.length) {
     return model.signatures[0].comment;
   }
-  if ((model.type as any)?.declaration?.signatures?.length) {
-    return (model.type as any)?.declaration.signatures[0].comment;
-  }
   return model.comment;
 }
diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/index.ts b/packages/typedoc-plugin-markdown/src/theme/resources/index.ts
@@ -596,7 +596,7 @@ There is no association list partial for properties as these are handled as a st
 export const helpers = (context: MarkdownThemeContext) => {
   return {
     getDeclarationComment: (model: DeclarationReflection) =>
-      getDeclarationComment.apply(context, [model]) as any,
+      getDeclarationComment.apply(context, [model]) as Comment | undefined,
     getDeclarationType: (model: DeclarationReflection) =>
       getDeclarationType.apply(context, [model]) as SomeType | undefined,
     getFlattenedDeclarations: (

diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/partials/member.reflectionIndex.ts b/packages/typedoc-plugin-markdown/src/theme/resources/partials/member.reflectionIndex.ts
@@ -110,7 +110,12 @@ function getTable(
     const comment = context.helpers.getDeclarationComment(child);
 
     if (comment?.summary?.length) {
-      row.push(context.partials.commentParts(comment.summary)?.split('\n')[0]);
+      row.push(
+        context.partials
+          .commentParts(comment.summary)
+          ?.split('\n\n')[0]
+          .replace(/\n/g, ' '),
+      );
     } else {
       row.push('-');
     }

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/config.ts b/packages/typedoc-plugin-markdown/test/fixtures/config.ts
@@ -76,7 +76,11 @@ const config: Record<string, Fixture> = {
     only: false,
     entryPoints: '/groups/**/*.ts',
     commonOptions: {
-      plugin: [path.join(__dirname, 'custom-plugins', 'navigation-plugin.mjs')],
+      plugin: [
+        path.join(__dirname, 'custom-plugins', 'stub-groups-theme.mjs'),
+        path.join(__dirname, 'custom-plugins', 'navigation-plugin.mjs'),
+      ],
+      theme: 'stub-groups',
       disableSources: true,
       entryFileName: 'index.md',
     },
@@ -89,7 +93,13 @@ const config: Record<string, Fixture> = {
       },
       {
         readme: 'none',
-        membersWithOwnFile: ['Class', 'Interface', 'Enum'],
+        membersWithOwnFile: [
+          'Class',
+          'Interface',
+          'Enum',
+          'TypeAlias',
+          'Function',
+        ],
         excludeGroups: true,
         useHTMLAnchors: true,
         indexFormat: 'table',

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/custom-plugins/stub-groups-theme.mjs b/packages/typedoc-plugin-markdown/test/fixtures/custom-plugins/stub-groups-theme.mjs
@@ -0,0 +1,30 @@
+// @ts-check
+import { MarkdownTheme, MarkdownThemeContext } from 'typedoc-plugin-markdown';
+
+/**
+ * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
+ */
+export function load(app) {
+  app.renderer.defineTheme('stub-groups', StubPartialsTheme);
+}
+
+class StubPartialsTheme extends MarkdownTheme {
+  /**
+   * @param {import('typedoc-plugin-markdown').MarkdownPageEvent} page
+   */
+  getRenderContext(page) {
+    return new MyMarkdownThemeContext(this, page, this.application.options);
+  }
+}
+
+class MyMarkdownThemeContext extends MarkdownThemeContext {
+  partials = {
+    ...this.partials,
+    declaration: () => {
+      return `_DECLARATION_MEMBER_PARTIAL_`;
+    },
+    signature: () => {
+      return `_SIGNATURE_MEMBER_PARTIAL_`;
+    },
+  };
+}
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/groups/basic.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/groups/basic.ts
@@ -3,14 +3,46 @@
  *
  * @module
  */
+
+/**
+ * Interface A comments line 1
+ * and comments on a soft line.
+ *
+ * Comments on double new line.
+ */
 export interface InterfaceA {
   propA: string;
   propB: string;
 }
+
+/**
+ * InterfaceB function.
+ */
 export interface InterfaceB {}
+/**
+ * EnumA function.
+ */
 export enum EnumA {}
 export enum EnumB {}
+/**
+ * ClassA function.
+ */
 export class ClassA {}
 export class ClassB {}
+/**
+ * TypeA function.
+ */
 export type TypeA = string;
-export type TypeB = string;
+/**
+ * TypeB function.
+ *
+ * @param str - A string to tokenize.
+ * @param offset - Initial offset. Used when composing lexers.
+ */
+export type TypeB = (str: string, offset?: number) => any;
+/**
+ * functionA function.
+ */
+export function functionA() {}
+export const variableA = '';
+export const variableB = '';