fix(multiline-blocks): for requireSingleLineUnderCount, ensure multi-line types nullify checks (#1422)

Author: brettz9

.README/rules/multiline-blocks.md

@@ -41,9 +41,11 @@ are whitelisted in `singleLineTags`.
 ### `requireSingleLineUnderCount` (defaults to `null`)
 
 If this number is set, it indicates a minimum line width for a single line of
-JSDoc content spread over a multi-line comment block. If a line is under the
-minimum length, it will be reported so as to enforce single line JSDoc blocks
-for such cases.
+JSDoc content spread over a multi-line comment block. If a single line is under
+the minimum length, it will be reported so as to enforce single line JSDoc blocks
+for such cases. Blocks are not reported which have multi-line descriptions,
+multiple tags, a block description and tag, or tags with multi-line types or
+descriptions.
 
 ### `singleLineTags` (defaults to `['lends', 'type']`)
 

docs/rules/multiline-blocks.md

@@ -55,9 +55,11 @@ are whitelisted in `singleLineTags`.
 ### <code>requireSingleLineUnderCount</code> (defaults to <code>null</code>)
 
 If this number is set, it indicates a minimum line width for a single line of
-JSDoc content spread over a multi-line comment block. If a line is under the
-minimum length, it will be reported so as to enforce single line JSDoc blocks
-for such cases.
+JSDoc content spread over a multi-line comment block. If a single line is under
+the minimum length, it will be reported so as to enforce single line JSDoc blocks
+for such cases. Blocks are not reported which have multi-line descriptions,
+multiple tags, a block description and tag, or tags with multi-line types or
+descriptions.
 
 <a name="user-content-options-singlelinetags-defaults-to-lends-type"></a>
 <a name="options-singlelinetags-defaults-to-lends-type"></a>
@@ -469,5 +471,22 @@ The following patterns are not considered problems:
  * @someTag
  */
 // "jsdoc/multiline-blocks": ["error"|"warn", {"requireSingleLineUnderCount":80}]
+
+/**
+ * @someTag
+ * @anotherTag
+ */
+// "jsdoc/multiline-blocks": ["error"|"warn", {"requireSingleLineUnderCount":80}]
+
+/**
+ * @type {{
+    visible: import("vue").Ref<boolean>,
+    attack: import("vue").Ref<AttackPve|AttackPvp|undefined>,
+    hero: import("vue").Ref<HeroOwn|undefined>,
+    outpost: import("vue").Ref<Outpost|undefined>,
+    rewards: import("vue").Ref<Rewards|undefined>
+* }}
+*/
+// "jsdoc/multiline-blocks": ["error"|"warn", {"requireSingleLineUnderCount":120}]
 ````
 

src/rules/multilineBlocks.js

@@ -11,8 +11,8 @@ const checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {
   }
 
   let lastLineWithTag = 0;
-  let exceedsLength = false;
-  let hasDesc = false;
+  let isUnderCountLimit = false;
+  let hasMultiDescOrType = false;
   const tagLines = jsdoc.source.reduce((acc, {
     tokens: {
       delimiter,
@@ -35,19 +35,19 @@ const checkForShortTags = (jsdoc, utils, requireSingleLineUnderCount) => {
         tag.length + postTag.length + desc.length <
           requireSingleLineUnderCount
       ) {
-        exceedsLength = true;
+        isUnderCountLimit = true;
       }
 
       return acc + 1;
-    } else if (desc.length) {
-      hasDesc = true;
+    } else if (desc.length || type.length) {
+      hasMultiDescOrType = true;
       return acc;
     }
 
     return acc;
   }, 0);
   // Could be tagLines > 1
-  if (!hasDesc && exceedsLength && tagLines === 1) {
+  if (!hasMultiDescOrType && isUnderCountLimit && tagLines === 1) {
     const fixer = () => {
       const tokens = jsdoc.source[lastLineWithTag].tokens;
       jsdoc.source = [
@@ -93,7 +93,7 @@ const checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) =>
   }
 
   let lastLineWithDesc = 0;
-  let exceedsLength = false;
+  let isUnderCountLimit = false;
   const descLines = jsdoc.source.reduce((acc, {
     tokens: {
       delimiter,
@@ -108,7 +108,7 @@ const checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) =>
         start.length + delimiter.length + postDelimiter.length + desc.length <
           requireSingleLineUnderCount
       ) {
-        exceedsLength = true;
+        isUnderCountLimit = true;
       }
 
       return acc + 1;
@@ -117,7 +117,7 @@ const checkForShortDescriptions = (jsdoc, utils, requireSingleLineUnderCount) =>
     return acc;
   }, 0);
   // Could be descLines > 1
-  if (exceedsLength && descLines === 1) {
+  if (isUnderCountLimit && descLines === 1) {
     const fixer = () => {
       const desc = jsdoc.source[lastLineWithDesc].tokens.description;
       jsdoc.source = [

test/rules/assertions/multilineBlocks.js

@@ -1100,5 +1100,36 @@ export default /** @type {import('../index.js').TestCases} */ ({
         },
       ],
     },
+    {
+      code: `
+        /**
+         * @someTag
+         * @anotherTag
+         */
+      `,
+      options: [
+        {
+          requireSingleLineUnderCount: 80,
+        },
+      ],
+    },
+    {
+      code: `
+        /**
+         * @type {{
+            visible: import("vue").Ref<boolean>,
+            attack: import("vue").Ref<AttackPve|AttackPvp|undefined>,
+            hero: import("vue").Ref<HeroOwn|undefined>,
+            outpost: import("vue").Ref<Outpost|undefined>,
+            rewards: import("vue").Ref<Rewards|undefined>
+        * }}
+        */
+      `,
+      options: [
+        {
+          requireSingleLineUnderCount: 120,
+        },
+      ],
+    },
   ],
 });