feat: add jsdocAddDefaultToDescription

.eslintrc.js

@@ -9,7 +9,12 @@ module.exports = {
     ecmaVersion: "next",
   },
   parser: "@typescript-eslint/parser",
-  extends: ["prettier", "eslint:recommended"],
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "prettier",
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+  ],
   rules: {
     "@typescript-eslint/no-explicit-any": "off",
     "no-unused-vars": "off",

package.json

@@ -39,6 +39,7 @@
   "devDependencies": {
     "@commitlint/config-conventional": "^14.1.0",
     "@react-native-community/eslint-config": "^3.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.3.0",
     "@types/jest": "^27.0.2",
     "@types/mdast": "^3.0.10",
     "@typescript-eslint/parser": "^5.3.0",
@@ -76,4 +77,4 @@
   "engines": {
     "node": ">=12.0.0"
   }
-}
+}

src/custom.d.ts

@@ -1,5 +1,5 @@
 declare namespace jest {
-  interface Matchers<R, T> {
+  interface Matchers<R> {
     toMatchSpecificSnapshot(filename: string): R;
   }
 }

src/index.ts

@@ -97,6 +97,14 @@ const options: Record<keyof JsdocOptions, SupportOption> = {
     description:
       "If You don't set value to jsdocPrintWidth, the printWidth will be use as jsdocPrintWidth.",
   },
+  jsdocAddDefaultToDescription: {
+    since: "0.3.29",
+    name: "jsdocAddDefaultToDescription",
+    type: "boolean",
+    category: "jsdoc",
+    default: true,
+    description: "Add Default value of a param to end description",
+  },
 };
 
 const defaultOptions: JsdocOptions = {
@@ -113,6 +121,8 @@ const defaultOptions: JsdocOptions = {
   jsdocSeparateTagGroups: options.jsdocSeparateTagGroups.default as boolean,
   jsdocCapitalizeDescription: options.jsdocCapitalizeDescription
     .default as boolean,
+  jsdocAddDefaultToDescription: options.jsdocAddDefaultToDescription
+    .default as boolean,
   tsdoc: options.tsdoc.default as boolean,
 };
 

src/parser.ts

@@ -130,9 +130,11 @@ export const getParser = (originalParse: Parser["parse"], parserName: string) =>
           return [tag];
         });
       }
+      if (options.jsdocAddDefaultToDescription) {
+        tags = tags.map(addDefaultValueToDescription);
+      }
 
       tags = tags
-        .map(addDefaultValueToDescription)
         .map(assignOptionalAndDefaultToName)
         .map(({ type, name, description, tag, ...rest }) => {
           const isVerticallyAlignAbleTags =
@@ -415,7 +417,6 @@ function convertCommentDescToDescTag(parsed: Block): void {
  * This is for find params of function name in code as strings of array
  */
 function getParamsOrders(ast: AST, tokenIndex: number): string[] | undefined {
-  let paramsOrder: string[] | undefined;
   let params: Token[] | undefined;
 
   try {
@@ -476,14 +477,14 @@ function getParamsOrders(ast: AST, tokenIndex: number): string[] | undefined {
       }
     }
 
-    paramsOrder = params
+    return params
       ?.filter(({ type }) => typeof type === "object" && type.label === "name")
       .map(({ value }) => value);
   } catch {
     //
   }
 
-  return paramsOrder;
+  return;
 }
 
 /**

src/types.ts

@@ -11,6 +11,7 @@ export interface JsdocOptions {
   jsdocSingleLineComment: boolean;
   jsdocSeparateReturnsFromParam: boolean;
   jsdocSeparateTagGroups: boolean;
+  jsdocAddDefaultToDescription: boolean;
   jsdocCapitalizeDescription: boolean;
   tsdoc: boolean;
 }

tests/__snapshots__/files/create-ignorer.js.shot

@@ -45,49 +45,3 @@ function _createIgnorer(ignoreContent, withNodeModules) {
 module.exports = createIgnorer;
 "
 `;
-
-exports[`File: create-ignorer.js index: 5 1`] = `
-"\\"use strict\\";
-
-const path = require(\\"path\\");
-const ignore = require(\\"ignore\\");
-const getFileContentOrNull = require(\\"../utils/get-file-content-or-null\\");
-
-/**
- * @param {string | null} ignorePath
- * @param {boolean | null} withNodeModules
- */
-async function createIgnorer(ignorePath, withNodeModules) {
-  const ignoreContent = ignorePath
-    ? await getFileContentOrNull(path.resolve(ignorePath))
-    : null;
-
-  return _createIgnorer(ignoreContent, withNodeModules);
-}
-
-/**
- * @param {string | null} ignorePath
- * @param {boolean | null} withNodeModules
- */
-createIgnorer.sync = function (ignorePath, withNodeModules) {
-  const ignoreContent = !ignorePath
-    ? null
-    : getFileContentOrNull.sync(path.resolve(ignorePath));
-  return _createIgnorer(ignoreContent, withNodeModules);
-};
-
-/**
- * @param {null | string} ignoreContent
- * @param {boolean | null} withNodeModules
- */
-function _createIgnorer(ignoreContent, withNodeModules) {
-  const ignorer = ignore().add(ignoreContent || \\"\\");
-  if (!withNodeModules) {
-    ignorer.add(\\"node_modules\\");
-  }
-  return ignorer;
-}
-
-module.exports = createIgnorer;
-"
-`;

tests/__snapshots__/files/order.jsx.shot

@@ -18,22 +18,3 @@ exports[`File: order.jsx 1`] = `
  */
 "
 `;
-
-exports[`File: order.jsx index: 4 1`] = `
-"/**
- * @callback ClassMapper
- * @param {string} className
- * @param {string} language
- * @returns {string}
- *
- * @callback ClassAdder
- * @param {ClassAdderEnvironment} env
- * @returns {undefined | string | string[]}
- *
- * @typedef ClassAdderEnvironment
- * @property {string} language
- * @property {string} type
- * @property {string} content
- */
-"
-`;