fix(core): remove superfluous newlines from table column descriptions (…

…#591)
typedoc2md · May 3, 2024 · 8503932 · 8503932
1 parent 44bfbf0
commit 8503932
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 46 deletions.
diff --git a/.changeset/large-lemons-hammer.md b/.changeset/large-lemons-hammer.md
@@ -0,0 +1,5 @@
+---
+"typedoc-plugin-markdown": patch
+---
+
+- Remove superfluous newlines from table column descriptions.
diff --git a/packages/typedoc-plugin-markdown/src/libs/utils/format-table-column.ts b/packages/typedoc-plugin-markdown/src/libs/utils/format-table-column.ts
@@ -4,5 +4,6 @@ export function formatTableColumn(str: string) {
     .replace(/\n(?=(?:[^`]*`[^`]*`)*[^`]*$)/gi, '<br />')
     .replace(/\`\`\`ts/g, '`')
     .replace(/\`\`\`/g, '`')
-    .replace(/\n/g, '');
+    .replace(/\n/g, '')
+    .replace(/(<br \/>\s*)+$/g, '');
 }
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/classes.ts
@@ -34,6 +34,7 @@ export class ClassWithSimpleProps {
   propB = 'propBValue';
   /**
    * Comments for propB
+   * on two lines
    *
    * @defaultValue 'propCDefaultValue'
    */