fix: new line between Default is

issue: #176
hosseinmd · Oct 5, 2023 · 9fbbe53 · 9fbbe53
1 parent 4f9ba4c
commit 9fbbe53
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/src/parser.ts b/src/parser.ts
@@ -533,7 +533,7 @@ function addDefaultValueToDescription(tag: Spec): Spec {
     let { description } = tag;
 
     // remove old note
-    description = description.replace(/[ \t]*Default is `.*`\.?$/, "");
+    description = description.replace(/[\s]*Default[\s]*is[\s]*`.*`\.?$/, "");
 
     // add a `.` at the end of previous sentences
     if (description && !/[.\n]$/.test(description)) {

diff --git a/tests/__snapshots__/main.test.ts.snap b/tests/__snapshots__/main.test.ts.snap
@@ -413,6 +413,15 @@ exports[`Sould keep params ordering when more than 10 tags are present 1`] = `
 "
 `;
 
+exports[`default type parameter  1`] = `
+"/**
+ * @template [BAR=({bar:true}&{foo:false}&{buggy:true})] Default is
+ *   \`({bar:true}&{foo:false}&{buggy:true})\`
+ * @typedef {{ foo: BAR }} SomeType
+ */
+"
+`;
+
 exports[`example  1`] = `
 "/**
  * ABCCCC

diff --git a/tests/main.test.ts b/tests/main.test.ts
@@ -802,3 +802,21 @@ test("satisfies", async () => {
 
   expect(result).toMatchSnapshot();
 });
+
+test("default type parameter ", async () => {
+  function _subject(str: string) {
+    return subject(str, {
+      jsdocAddDefaultToDescription: true,
+    });
+  }
+  const result = await _subject(
+    `
+    /**
+     * @template [BAR=({bar:true}&{foo:false}&{buggy:true})] 
+     * @typedef {{foo: BAR}} SomeType
+     */
+`,
+  );
+
+  expect(await _subject(await _subject(result))).toMatchSnapshot();
+});