fix: description retrieval logic was problematic for single line tags; fixes #1036

Author: brettz9

README.md

@@ -12329,6 +12329,9 @@ export default (foo) => {
 /** @file To learn more,
  * see: https://github.com/d3/d3-ease. */
 
+/** To learn more,
+ * see: https://github.com/d3/d3-ease. */
+
 /**
  * This is a complete sentence...
  */
@@ -23488,6 +23491,15 @@ function processSass (input) {
 function updateIconButton () {
 }
 // "jsdoc/tag-lines": ["error"|"warn", "never",{"startLines":1}]
+
+/** A class. */
+class _Foo {
+  /** @param arg Argument. */
+  conststructor(arg: string) {
+    console.log(arg);
+  }
+}
+// "jsdoc/tag-lines": ["error"|"warn", "any",{"startLines":1}]
 ````
 
 

src/iterateJsdoc.js

@@ -229,23 +229,28 @@ const getUtils = (
   utils.getDescription = () => {
     const descriptions = [];
     let lastDescriptionLine = 0;
+    let tagsBegun = false;
     jsdoc.source.some(({
       tokens: {
         description,
         tag,
         end,
       },
     }, idx) => {
+      if (tag) {
+        tagsBegun = true;
+      }
+
       if (idx && (tag || end)) {
         lastDescriptionLine = idx - 1;
-        if (!tag && description) {
+        if (!tagsBegun && description) {
           descriptions.push(description);
         }
 
         return true;
       }
 
-      if (idx || description) {
+      if (!tagsBegun && (idx || description)) {
         descriptions.push(description || (descriptions.length ? '' : '\n'));
       }
 

test/rules/assertions/requireDescriptionCompleteSentence.js

@@ -1486,6 +1486,12 @@ export default {
        * see: https://github.com/d3/d3-ease. */
       `,
     },
+    {
+      code: `
+      /** To learn more,
+       * see: https://github.com/d3/d3-ease. */
+      `,
+    },
     {
       code: `
       /**

test/rules/assertions/tagLines.js

@@ -1139,5 +1139,23 @@ export default {
         },
       ],
     },
+    {
+      code: `
+      /** A class. */
+      class _Foo {
+        /** @param arg Argument. */
+        conststructor(arg: string) {
+          console.log(arg);
+        }
+      }
+      `,
+      options: [
+        'any',
+        {
+          startLines: 1,
+        },
+      ],
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
 };