fix: broken markdown newlines

elyukai · Mar 6, 2022 · c965cb9 · c965cb9
1 parent 355daf0
commit c965cb9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/src/ast.ts b/src/ast.ts
@@ -1,3 +1,4 @@
+import { EOL } from "os"
 import ts from "typescript"
 
 export namespace JSDoc {
@@ -59,9 +60,7 @@ export namespace JSDoc {
   }
 
   const commentToString = (comment: string | ts.NodeArray<ts.JSDocComment> | undefined) =>
-    ts.getTextOfJSDocComment(comment)
-      ?.replace(/\r\n(?:\r\n)+/g, "\n\n")
-      .replace(/\r\n/g, " ")
+    ts.getTextOfJSDocComment(comment)?.replaceAll(EOL, "\n")
 
   const parseTagComment = <K extends keyof TagValueActualTypes>(name: K, comment: string | undefined): TagValueActualTypes[K] => {
     const type = tagValueTypes[name]

diff --git a/src/renderers/markdown.ts b/src/renderers/markdown.ts
@@ -281,7 +281,10 @@ const strictObjectBody = (
 
       return [
         title,
-        config.jsDoc?.comment ?? "",
+        config.jsDoc?.comment
+          ?.split("\n\n")[0]
+          ?.replaceAll("\n", " ")
+          ?? "",
         a("See details", namedLink(propertyPropertyPath))
       ].join(" | ")
     })