fix: jsdocParser option

issue: #157

src/index.ts

@@ -7,6 +7,14 @@ import { JsdocOptions } from "./types";
 import { findPluginByParser } from "./utils";
 
 const options: Record<keyof JsdocOptions, SupportOption> = {
+  jsdocParser: {
+    since: "0.3.24",
+    name: "jsdocParser",
+    type: "boolean",
+    category: "jsdoc",
+    default: true,
+    description: "Enable/Disable jsdoc parser",
+  },
   jsdocSpaces: {
     since: "0.3.24",
     name: "jsdocSpaces",
@@ -116,6 +124,7 @@ const options: Record<keyof JsdocOptions, SupportOption> = {
 };
 
 const defaultOptions: JsdocOptions = {
+  jsdocParser: options.jsdocParser.default as boolean,
   jsdocSpaces: options.jsdocSpaces.default as number,
   jsdocPrintWidth: options.jsdocPrintWidth.default as unknown as undefined,
   jsdocDescriptionWithDot: options.jsdocDescriptionWithDot.default as boolean,

src/types.ts

@@ -1,6 +1,7 @@
 import { ParserOptions } from "prettier";
 
 export interface JsdocOptions {
+  jsdocParser: boolean;
   jsdocSpaces: number;
   jsdocPrintWidth?: number;
   jsdocDescriptionWithDot: boolean;

tests/__snapshots__/default.test.ts.snap

@@ -0,0 +1,19 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Empty default 1`] = `
+"/**
+ * The value
+ *
+ * @default 'type' name description
+ */
+"
+`;
+
+exports[`Empty default 2`] = `
+"/**
+ * The value
+ *
+ * @default
+ */
+"
+`;

tests/__snapshots__/descriptions.test.ts.snap

@@ -199,6 +199,19 @@ exports[`Jsx tsx css  1`] = `
 "
 `;
 
+exports[`Link  1`] = `
+"/**
+ * Name of something.
+ *
+ * See [documentation](1) for more details.
+ *
+ * # 1
+ *
+ * https://www.documentation.com
+ */
+"
+`;
+
 exports[`List in tags 1`] = `
 "/**
  * @param {any} var An example list:

tests/__snapshots__/jsdocParserDisable.test.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`extends 1`] = `
+exports[`disabled complex object typedef  1`] = `
 "/**
  * The bread crumbs indicate the navigate path and trigger the active page.
  * @class

tests/default.test.ts

@@ -0,0 +1,34 @@
+import prettier from "prettier";
+import { AllOptions } from "../src/types";
+
+function subject(code: string, options: Partial<AllOptions> = {}) {
+  return prettier.format(code, {
+    parser: "babel",
+    plugins: ["."],
+    jsdocSpaces: 1,
+    ...options,
+  } as AllOptions);
+}
+
+test("Empty default", () => {
+  const result = subject(`
+  /**
+   * The value
+   *
+   * @default 'type' name description
+   */
+`);
+
+  expect(result).toMatchSnapshot();
+});
+test("Empty default", () => {
+  const result = subject(`
+  /**
+   * The value
+   *
+   * @default []
+   */
+`);
+
+  expect(result).toMatchSnapshot();
+});

tests/descriptions.test.ts

@@ -524,7 +524,7 @@ test("matches prettier markdown format", () => {
   );
 
   expect(result1).toMatchSnapshot();
-})
+});
 
 test("description start underscores", () => {
   const result1 = subject(
@@ -988,3 +988,18 @@ test("Code in description", () => {
 
   expect(result5).toMatchSnapshot();
 });
+
+test("Link ", () => {
+  const result = subject(`
+  /**
+   * Name of something.
+   *
+   * See [documentation](1) for more details.
+   *
+   * # 1
+   * https://www.documentation.com
+   */
+`);
+
+  expect(result).toMatchSnapshot();
+});

tests/jsdocParserDisable.test.ts

@@ -23,7 +23,7 @@ test("template for callback", () => {
   expect(result).toMatchSnapshot();
 });
 
-test("extends", () => {
+test("disabled complex object typedef ", () => {
   const result = subject(`
  /**
   * The bread crumbs indicate the navigate path and trigger the active page.
@@ -36,4 +36,23 @@ test("extends", () => {
 `);
 
   expect(result).toMatchSnapshot();
+
+  const result2 = subject(
+    `
+  /**
+   * The bread crumbs indicate the navigate path and trigger the active page.
+   * @class
+   * @typedef {object} props
+   * @prop        {any} navigation
+   * @extends         {PureComponent<       props>} 
+   */
+  export class BreadCrumbs extends PureComponent {}
+ `,
+    {
+      plugins: ["prettier-plugin-jsdoc"],
+      jsdocParser: false,
+    },
+  );
+
+  expect(result).toBe(result2);
 });