fix: optional type without name

issue: #153
hosseinmd · Mar 24, 2022 · b14397c · b14397c
1 parent bd31495
commit b14397c
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 13 deletions.
diff --git a/src/parser.ts b/src/parser.ts
@@ -30,8 +30,8 @@ export const getParser = (originalParse: Parser["parse"], parserName: string) =>
     parsersOrOptions: Parameters<Parser["parse"]>[1],
     maybeOptions?: AllOptions,
   ): AST {
-  const parsers = parsersOrOptions;
-  let options = (maybeOptions ?? parsersOrOptions) as AllOptions;
+    const parsers = parsersOrOptions;
+    let options = (maybeOptions ?? parsersOrOptions) as AllOptions;
     const prettierParse =
       findPluginByParser(parserName, options)?.parse || originalParse;
 
@@ -107,10 +107,6 @@ export const getParser = (originalParse: Parser["parse"], parserName: string) =>
             });
 
             type = convertToModernType(type);
-            type = formatType(type, {
-              ...options,
-              printWidth: commentContentPrintWidth,
-            });
           }
 
           return {
@@ -138,6 +134,19 @@ export const getParser = (originalParse: Parser["parse"], parserName: string) =>
 
       tags = tags
         .map(assignOptionalAndDefaultToName)
+        .map(({ type, ...rest }) => {
+          if (type) {
+            type = formatType(type, {
+              ...options,
+              printWidth: commentContentPrintWidth,
+            });
+          }
+
+          return {
+            ...rest,
+            type,
+          } as Spec;
+        })
         .map(({ type, name, description, tag, ...rest }) => {
           const isVerticallyAlignAbleTags =
             TAGS_VERTICALLY_ALIGN_ABLE.includes(tag);
@@ -527,21 +536,29 @@ function assignOptionalAndDefaultToName({
   name,
   optional,
   default: default_,
+  tag,
+  type,
   ...rest
 }: Spec): Spec {
-  if (name && optional) {
-    // Figure out if tag type have default value
-    if (default_) {
-      name = `[${name}=${default_}]`;
+  if (optional) {
+    if (name) {
+      // Figure out if tag type have default value
+      if (default_) {
+        name = `[${name}=${default_}]`;
+      } else {
+        name = `[${name}]`;
+      }
     } else {
-      name = `[${name}]`;
+      type = `${type} | undefined`;
     }
   }
 
   return {
     ...rest,
-    name: name,
-    optional: optional,
+    tag,
+    name,
+    optional,
+    type,
     default: default_,
   };
 }
diff --git a/tests/__snapshots__/main.test.ts.snap b/tests/__snapshots__/main.test.ts.snap
@@ -121,6 +121,15 @@ exports[`Optional parameters 1`] = `
 "
 `;
 
+exports[`Optional params 1`] = `
+"/**
+ * @param {string} [p2] - An optional param (Google Closure syntax)
+ * @param {string} [p3] - Another optional param (JSDoc syntax).
+ * @returns {string | undefined}
+ */
+"
+`;
+
 exports[`Should align vertically param|property|returns|yields|throws if option set to true, and amount of spaces is different than default 1`] = `
 "/**
  * @property  {Object}          unalginedProp   Unaligned property descriptin

diff --git a/tests/main.test.ts b/tests/main.test.ts
@@ -671,3 +671,15 @@ test("example with tab intention", () => {
     ),
   ).toMatchSnapshot();
 });
+
+test("Optional params", () => {
+  const result = subject(`
+/**
+ * @param {string=} p2 - An optional param (Google Closure syntax)
+ * @param {string} [p3] - Another optional param (JSDoc syntax).
+ * @returns {string=} 
+*/
+`);
+
+  expect(result).toMatchSnapshot();
+});