feat(prettier-plugin-jsdoc): add rule to ignore consistent columns

homer0 · Oct 26, 2020 · 1573db8 · 1573db8
1 parent 11e3d5c
commit 1573db8
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 4 deletions.
diff --git a/src/fns/render.js b/src/fns/render.js
@@ -307,10 +307,16 @@ const render = R.curry((options, column, block) => {
     const data = getLengthsData(block.tags);
     if (options.jsdocGroupColumnsByTag) {
       const tagsData = getTagsData(data.byTag, width, options);
-      const atLeastOneCannot = Object.entries(tagsData).find(([tagName, info]) => (
-        !options.jsdocAllowDescriptionOnNewLinesForTags.includes(tagName) &&
-        !info.canUseColumns
-      ));
+      let atLeastOneCannot;
+      if (options.jsdocIgnoreNewLineDescriptionsForConsistentColumns) {
+        atLeastOneCannot = Object.entries(tagsData).find(([tagName, info]) => (
+          !options.jsdocAllowDescriptionOnNewLinesForTags.includes(tagName) &&
+          !info.canUseColumns
+        ));
+      } else {
+        atLeastOneCannot = Object.values(tagsData).find((info) => !info.canUseColumns);
+      }
+
       if (atLeastOneCannot && options.jsdocConsistentColumns) {
         lines.push(...renderTagsInlines(width, options, block.tags));
       } else {

diff --git a/src/options.js b/src/options.js
@@ -282,6 +282,14 @@ const options = {
       ],
     }],
   },
+  jsdocIgnoreNewLineDescriptionsForConsistentColumns: {
+    type: 'boolean',
+    category: 'jsdoc',
+    default: true,
+    description:
+      'If enabled, when evaluating the rule for consistent columns, tags with description ' +
+      'on a new line, allowed by `jsdocAllowDescriptionOnNewLinesForTags`, will be ignored.',
+  },
 };
 /**
  * @type {PJPOptions}

diff --git a/src/types.js b/src/types.js
@@ -120,6 +120,9 @@
  * period. Default `true`.
  * @property {string[]} jsdocAllowDescriptionOnNewLinesForTags
  * A list of tags that are allowed to have their description on a new line.
+ * @property {boolean} jsdocIgnoreNewLineDescriptionsForConsistentColumns
+ * If enabled, when evaluating the rule for consistent columns, tags with description on a new line,
+ * allowed by `jsdocAllowDescriptionOnNewLinesForTags`, will be ignored. Default `true`.
  */
 
 /* eslint-disable max-len */

diff --git a/test/unit/fns/render.test.js b/test/unit/fns/render.test.js
@@ -524,6 +524,12 @@ describe('render', () => {
             description: 'Lorem ipsum description for the age.',
             descriptionParagrah: true,
           },
+          {
+            tag: 'version',
+            type: '',
+            name: '1.0.0',
+            description: '',
+          },
         ],
       },
       output: [
@@ -532,6 +538,7 @@ describe('render', () => {
         'Lorem ipsum description for the name.',
         '@property {number} age',
         'Lorem ipsum description for the age.',
+        '@version 1.0.0',
       ],
       column: 0,
       options: {
@@ -543,6 +550,59 @@ describe('render', () => {
         ],
       },
     },
+    {
+      it: 'should consider inline tags for consistent columns',
+      input: {
+        description: '',
+        tags: [
+          {
+            tag: 'callback',
+            type: '',
+            name: 'LoremIpsumFn',
+            description: '',
+          },
+          {
+            tag: 'param',
+            type: 'string',
+            name: 'name',
+            description: 'Lorem ipsum description for the name.',
+            descriptionParagrah: true,
+          },
+          {
+            tag: 'param',
+            type: 'number',
+            name: 'age',
+            description: 'Lorem ipsum description for the age.',
+            descriptionParagrah: true,
+          },
+          {
+            tag: 'returns',
+            type: 'Person',
+            name: '',
+            description: 'A new person.',
+          },
+        ],
+      },
+      output: [
+        '@callback LoremIpsumFn',
+        '@param {string} name',
+        'Lorem ipsum description for the name.',
+        '@param {number} age',
+        'Lorem ipsum description for the age.',
+        '@returns {Person}',
+        'A new person.',
+      ],
+      column: 0,
+      options: {
+        ...defaultOptions,
+        jsdocPrintWidth: 80,
+        jsdocIgnoreNewLineDescriptionsForConsistentColumns: false,
+        jsdocAllowDescriptionOnNewLinesForTags: [
+          ...defaultOptions.jsdocAllowDescriptionOnNewLinesForTags,
+          'param',
+        ],
+      },
+    },
   ];
 
   it.each(cases)('should correctly format the case %#', (caseInfo) => {