fix: add new line to unknown tag

issue: #204
hosseinmd · Oct 3, 2023 · cdbf931 · cdbf931
1 parent 384709f
commit cdbf931
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 1 deletion.
diff --git a/src/stringify.ts b/src/stringify.ts
@@ -1,5 +1,8 @@
 import { Spec } from "comment-parser";
-import { formatDescription, descriptionEndLine } from "./descriptionFormatter.js";
+import {
+  formatDescription,
+  descriptionEndLine,
+} from "./descriptionFormatter.js";
 import {
   DESCRIPTION,
   EXAMPLE,
@@ -123,6 +126,8 @@ const stringify = async (
       TAGS_PEV_FORMATE_DESCRIPTION.includes(tag) ||
       !TAGS_ORDER.includes(tag)
     ) {
+      description = description.trimEnd();
+
       // Avoid wrapping
       descriptionString = description;
     } else {

diff --git a/tests/__snapshots__/tagGroup.test.ts.snap b/tests/__snapshots__/tagGroup.test.ts.snap
@@ -23,3 +23,25 @@ exports[`Tag group 1`] = `
  */
 "
 `;
+
+exports[`space after unknownTag 1`] = `
+"/**
+ * A description.
+ *
+ * @unknownTag A note.
+ *
+ * @see http://acme.com
+ */
+"
+`;
+
+exports[`space between note and see 1`] = `
+"/**
+ * A description.
+ *
+ * @notDefinedTag A note.
+ *
+ * @see http://acme.com
+ */
+"
+`;
diff --git a/tests/tagGroup.test.ts b/tests/tagGroup.test.ts
@@ -37,3 +37,56 @@ test("Tag group", async () => {
 
   expect(result).toMatchSnapshot();
 });
+
+test("space after unknownTag", async () => {
+  function _subject(str: string) {
+    return subject(str, {
+      arrowParens: "always",
+      bracketSameLine: false,
+      bracketSpacing: true,
+      embeddedLanguageFormatting: "auto",
+      endOfLine: "lf",
+      htmlWhitespaceSensitivity: "css",
+      insertPragma: false,
+      jsxSingleQuote: true,
+      printWidth: 180,
+      proseWrap: "preserve",
+      quoteProps: "preserve",
+      requirePragma: false,
+      semi: true,
+      singleAttributePerLine: false,
+      singleQuote: true,
+      tabWidth: 4,
+      trailingComma: "all",
+      useTabs: true,
+      vueIndentScriptAndStyle: true,
+
+      jsdocAddDefaultToDescription: false,
+      jsdocCapitalizeDescription: true,
+      jsdocDescriptionTag: false,
+      jsdocDescriptionWithDot: true,
+      jsdocKeepUnParseAbleExampleIndent: false,
+      jsdocLineWrappingStyle: "greedy",
+      jsdocPreferCodeFences: false,
+      jsdocPrintWidth: 120,
+      jsdocSeparateReturnsFromParam: false,
+      jsdocSeparateTagGroups: true,
+      jsdocSingleLineComment: false,
+      jsdocSpaces: 1,
+      jsdocVerticalAlignment: true,
+      tsdoc: false,
+    });
+  }
+  const result = await _subject(`
+   /**
+    * 
+    * A description.
+    *
+    * @unknownTag A note.
+    *
+    * @see http://acme.com
+    */
+   `);
+
+  expect(await _subject(await _subject(result))).toMatchSnapshot();
+});