fix: markdown image link

hosseinmd · Nov 5, 2021 · bf2da59 · bf2da59
1 parent 59dc643
commit bf2da59
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/src/descriptionFormatter.ts b/src/descriptionFormatter.ts
@@ -1,5 +1,5 @@
 import { format, BuiltInParserName } from "prettier";
-import { DESCRIPTION, EXAMPLE, PRIVATE_REMARKS, REMARKS, TODO } from "./tags";
+import { DESCRIPTION, EXAMPLE, TODO } from "./tags";
 import { AllOptions } from "./types";
 import { capitalizer, formatCode } from "./utils";
 import fromMarkdown from "mdast-util-from-markdown";
@@ -73,7 +73,7 @@ function formatDescription(
   });
   if (options.jsdocCapitalizeDescription) text = capitalizer(text);
 
-  text = `${"!".repeat(tagStringLength)}${
+  text = `${tagStringLength ? `${"!".repeat(tagStringLength - 1)}?` : ""}${
     text.startsWith("```") ? "\n" : ""
   }${text}`;
 
@@ -150,7 +150,7 @@ function formatDescription(
       return `\\\n`;
     }
 
-    return (mdAst.value || "") as string;
+    return (mdAst.value || mdAst.title || mdAst.alt || "") as string;
   }
 
   function stringyfy(
@@ -268,7 +268,7 @@ function formatDescription(
           )}`;
         }
 
-        if (ast.type === "link") {
+        if (ast.type === "link" || ast.type === "image") {
           return `[${stringyfy(ast, intention, mdAst)}](${ast.url})`;
         }
 
@@ -279,7 +279,8 @@ function formatDescription(
 
   let result = stringyfy(rootAst, beginningSpace, null);
 
-  result = result.trimStart().slice(tagStringLength);
+  result = result.replace(/^[\s\n]+/g, "");
+  result = result.replace(/^([!]+\?)/g, "");
 
   return result;
 }

diff --git a/tests/__snapshots__/descriptions.test.ts.snap b/tests/__snapshots__/descriptions.test.ts.snap
@@ -123,6 +123,11 @@ exports[`Markdown Table 3`] = `
 "
 `;
 
+exports[`Markdown link 1`] = `
+"/** @param {string} [dir] [Next.js](https://nextjs.org) project directory path. */
+"
+`;
+
 exports[`Nested list 1`] = `
 "/**
  * 1. Foo

diff --git a/tests/descriptions.test.ts b/tests/descriptions.test.ts
@@ -725,6 +725,16 @@ test("Jsdoc link in description", () => {
   expect(result1).toMatchSnapshot();
 });
 
+test("Markdown link", () => {
+  const result1 = subject(`
+/**
+ @param {string} [dir] [Next.js](https://nextjs.org) project directory path.
+ */
+`);
+
+  expect(result1).toMatchSnapshot();
+});
+
 test("Not Capitalizing", () => {
   const comment = `/**