fix: format all tags descriptions

hosseinmd · Feb 18, 2021 · cb815f0 · cb815f0
1 parent 905f735
commit cb815f0
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 24 deletions.
diff --git a/src/descriptionFormatter.ts b/src/descriptionFormatter.ts
@@ -1,5 +1,4 @@
 import { format } from "prettier";
-import { TAGS_NEED_FORMAT_DESCRIPTION } from "./roles";
 import { DESCRIPTION, EXAMPLE, TODO } from "./tags";
 import { JsdocOptions } from "./types";
 import { capitalizer } from "./utils";
@@ -52,10 +51,6 @@ function formatDescription(
   options: JsdocOptions,
   formatOptions: FormatOptions = {},
 ): string {
-  if (!TAGS_NEED_FORMAT_DESCRIPTION.includes(tag)) {
-    return text;
-  }
-
   if (!text) return text;
 
   const { printWidth } = options;

diff --git a/src/roles.ts b/src/roles.ts
@@ -90,20 +90,7 @@ const TAGS_TYPELESS = [
 ];
 
 const TAGS_DESCRIPTION_NEEDED = [CATEGORY, DESCRIPTION, EXAMPLE, SINCE, TODO];
-const TAGS_NEED_FORMAT_DESCRIPTION = [
-  CATEGORY,
-  DESCRIPTION,
-  PARAM,
-  PROPERTY,
-  RETURNS,
-  THROWS,
-  TODO,
-  TYPE,
-  TYPEDEF,
-  YIELDS,
-  DEPRECATED,
-  OVERRIDE,
-];
+
 const TAGS_TYPE_NEEDED = [
   EXTENDS,
   PARAM,
@@ -172,7 +159,6 @@ export {
   TAGS_DESCRIPTION_NEEDED,
   TAGS_IS_CAMEL_CASE,
   TAGS_NAMELESS,
-  TAGS_NEED_FORMAT_DESCRIPTION,
   TAGS_GROUP,
   TAGS_ORDER,
   TAGS_SYNONYMS,

diff --git a/tests/__snapshots__/exampleTag.test.js.snap b/tests/__snapshots__/exampleTag.test.js.snap
@@ -18,7 +18,7 @@ exports[`Example javascript code 1`] = `
  *   }
  *
  * @undefiendTag
- * @undefiendTag {number} name des
+ * @undefiendTag {number} name Des
  */
 const testFunction = (text, defaultValue, optionalNumber) => true;
 "
@@ -42,7 +42,7 @@ exports[`Example javascript code 2`] = `
  *   }
  *
  * @undefiendTag
- * @undefiendTag {number} name des
+ * @undefiendTag {number} name Des
  */
 const testFunction = (text, defaultValue, optionalNumber) => true;
 "

diff --git a/tests/__snapshots__/main.test.js.snap b/tests/__snapshots__/main.test.js.snap
@@ -208,7 +208,7 @@ exports[`Should format regular jsDoc 1`] = `
  * @param {Number | Null} [optionalNumber]
  * @returns {Boolean} Description for @returns with s
  * @undefiendTag
- * @undefiendTag {number} name des
+ * @undefiendTag {number} name Des
  */
 const testFunction = (text, defaultValue, optionalNumber) => true;
 "
@@ -238,7 +238,7 @@ exports[`Should format regular jsDoc 2`] = `
  * @param {Number | Null} [optionalNumber]
  * @returns {Boolean} Description for @returns with s
  * @undefiendTag
- * @undefiendTag {number} name des
+ * @undefiendTag {number} name Des
  */
 const testFunction = (text, defaultValue, optionalNumber) => true;
 "