fix: new line after item list

issue: #206
hosseinmd · Oct 3, 2023 · 98c42fe · 98c42fe
1 parent cdbf931
commit 98c42fe
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 15 deletions.
diff --git a/src/parser.ts b/src/parser.ts
@@ -576,8 +576,6 @@ function assignOptionalAndDefaultToName({
     const tagDescription = tagMatch?.[4] || "";
 
     if (tagMatch) {
-      console.log(tagMatch);
-
       type = tagValue;
       name = "";
       description = tagDescription;

diff --git a/src/stringify.ts b/src/stringify.ts
@@ -41,6 +41,7 @@ const stringify = async (
     tsdoc,
     useTabs,
     tabWidth,
+    jsdocSeparateTagGroups,
   } = options;
   const gap = " ".repeat(jsdocSpaces);
 
@@ -126,8 +127,6 @@ const stringify = async (
       TAGS_PEV_FORMATE_DESCRIPTION.includes(tag) ||
       !TAGS_ORDER.includes(tag)
     ) {
-      description = description.trimEnd();
-
       // Avoid wrapping
       descriptionString = description;
     } else {
@@ -162,6 +161,10 @@ const stringify = async (
       }
     }
 
+    if (jsdocSeparateTagGroups) {
+      descriptionString = descriptionString.trimEnd();
+    }
+
     tagString += descriptionString.startsWith("\n")
       ? descriptionString.replace(/^\n[\s]+\n/g, "\n")
       : descriptionString.trimStart();

diff --git a/tests/__snapshots__/descriptions.test.ts.snap b/tests/__snapshots__/descriptions.test.ts.snap
@@ -469,6 +469,21 @@ function test(value) {
 "
 `;
 
+exports[`Reference-style Links  3`] = `
+"/**
+ * Testing docBlocks.
+ *
+ * @param ...args Arguments.
+ *
+ * @returns Something.
+ *
+ *   - Note: here is a list item in markdown.
+ *
+ * @see https://link.example
+ */
+"
+`;
+
 exports[`code in description 1`] = `
 "/**
  * \`Touchable\`: Taps done right.

diff --git a/tests/__snapshots__/tagGroup.test.ts.snap b/tests/__snapshots__/tagGroup.test.ts.snap
@@ -34,14 +34,3 @@ exports[`space after unknownTag 1`] = `
  */
 "
 `;
-
-exports[`space between note and see 1`] = `
-"/**
- * A description.
- *
- * @notDefinedTag A note.
- *
- * @see http://acme.com
- */
-"
-`;
diff --git a/tests/descriptions.test.ts b/tests/descriptions.test.ts
@@ -1033,3 +1033,26 @@ test("Reference-style Links ", async () => {
 
   expect(result2).toMatchSnapshot();
 });
+
+test("Reference-style Links ", async () => {
+  const result = await subject(
+    `
+  /**
+   * Testing docBlocks.
+   *
+   * @param   ...args Arguments.
+   *
+   * @returns         Something.
+   *
+   *   - Note: here is a list item in markdown.
+   *
+   * @see https://link.example
+   */
+`,
+    {
+      jsdocSeparateTagGroups: true,
+    },
+  );
+
+  expect(result).toMatchSnapshot();
+});