fix(tag-lines): avoid reformatting post-delimiter spacing; fixes #1593

Author: brettz9

docs/rules/tag-lines.md

@@ -397,6 +397,31 @@ The following patterns are considered problems:
  */
 // "jsdoc/tag-lines": ["error"|"warn", "any",{"maxBlockLines":2,"startLines":5}]
 // Message: If set to a number, `maxBlockLines` must be greater than or equal to `startLines`.
+
+/**
+ * My Test Function, with some example code.
+ *
+ * ```js
+ *   new Foo();
+ * ```
+ *
+ *
+ * @param {string} bar
+ */
+function myTestFunction(bar) {
+
+}
+// "jsdoc/tag-lines": ["error"|"warn", "any",{"startLines":1}]
+// Message: Expected only 1 line after block description
+
+/**
+ *
+ * Second Test Case
+ * @param {number} baz
+ *
+ */
+// "jsdoc/tag-lines": ["error"|"warn", "any",{"startLines":1}]
+// Message: Expected 1 lines after block description
 ````
 
 

src/iterateJsdoc.js

@@ -170,7 +170,8 @@ import esquery from 'esquery';
  *   seedTokens: (
  *     tokens?: Partial<import('comment-parser').Tokens>
  *   ) => import('comment-parser').Tokens,
- *   descLines: string[]
+ *   descLines: string[],
+ *   postDelims: string[]
  * ) => import('comment-parser').Line[]} setter
  * @returns {void}
  */
@@ -928,6 +929,8 @@ const getUtils = (
   utils.setBlockDescription = (setter) => {
     /** @type {string[]} */
     const descLines = [];
+    /** @type {string[]} */
+    const postDelims = [];
     /**
      * @type {undefined|Integer}
      */
@@ -974,6 +977,7 @@ const getUtils = (
         return true;
       }
 
+      postDelims.push(postDelimiter);
       descLines.push(description);
       return false;
     });
@@ -994,6 +998,7 @@ const getUtils = (
           (info),
           seedTokens,
           descLines,
+          postDelims,
         ),
       );
     }

src/rules/tagLines.js

@@ -37,18 +37,22 @@ const checkMaxBlockLines = ({
         line: excessIndexLine,
       },
       () => {
-        utils.setBlockDescription((info, seedTokens, descLines) => {
+        utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {
+          const newPostDelims = [
+            ...postDelims.slice(0, excessIndexLine),
+            ...postDelims.slice(excessIndexLine + excessBlockLines - 1 - maxBlockLines),
+          ];
           return [
             ...descLines.slice(0, excessIndexLine),
             ...descLines.slice(excessIndexLine + excessBlockLines - 1 - maxBlockLines),
-          ].map((desc) => {
+          ].map((desc, idx) => {
             return {
               number: 0,
               source: '',
               tokens: seedTokens({
                 ...info,
                 description: desc,
-                postDelimiter: desc.trim() ? ' ' : '',
+                postDelimiter: newPostDelims[idx],
               }),
             };
           });
@@ -310,15 +314,15 @@ export default iterateJsdoc(({
           line: lastDescriptionLine - trailingDiff,
         },
         () => {
-          utils.setBlockDescription((info, seedTokens, descLines) => {
-            return descLines.slice(0, -trailingDiff).map((desc) => {
+          utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {
+            return descLines.slice(0, -trailingDiff).map((desc, idx) => {
               return {
                 number: 0,
                 source: '',
                 tokens: seedTokens({
                   ...info,
                   description: desc,
-                  postDelimiter: desc.trim() ? info.postDelimiter : '',
+                  postDelimiter: postDelims[idx],
                 }),
               };
             });
@@ -332,22 +336,22 @@ export default iterateJsdoc(({
           line: lastDescriptionLine,
         },
         () => {
-          utils.setBlockDescription((info, seedTokens, descLines) => {
+          utils.setBlockDescription((info, seedTokens, descLines, postDelims) => {
             return [
               ...descLines,
               ...Array.from({
                 length: -trailingDiff,
               }, () => {
                 return '';
               }),
-            ].map((desc) => {
+            ].map((desc, idx) => {
               return {
                 number: 0,
                 source: '',
                 tokens: seedTokens({
                   ...info,
                   description: desc,
-                  postDelimiter: desc.trim() ? info.postDelimiter : '',
+                  postDelimiter: desc.trim() ? postDelims[idx] : '',
                 }),
               };
             });

test/rules/assertions/tagLines.js

@@ -853,6 +853,83 @@ export default /** @type {import('../index.js').TestCases} */ ({
         },
       ],
     },
+    {
+      code: `
+        /**
+         * My Test Function, with some example code.
+         *
+         * \`\`\`js
+         *   new Foo();
+         * \`\`\`
+         *
+         *
+         * @param {string} bar
+         */
+        function myTestFunction(bar) {
+
+        }
+      `,
+      errors: [
+        {
+          line: 8,
+          message: 'Expected only 1 line after block description',
+        },
+      ],
+      options: [
+        'any',
+        {
+          startLines: 1,
+        },
+      ],
+      output: `
+        /**
+         * My Test Function, with some example code.
+         *
+         * \`\`\`js
+         *   new Foo();
+         * \`\`\`
+         *
+         * @param {string} bar
+         */
+        function myTestFunction(bar) {
+
+        }
+      `,
+    },
+    {
+      code: `
+        /**
+         *
+         * Second Test Case
+         * @param {number} baz
+         *
+         */
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'Expected 1 lines after block description',
+        },
+        {
+          line: 6,
+          message: 'Expected 0 trailing lines',
+        },
+      ],
+      options: [
+        'any',
+        {
+          startLines: 1,
+        },
+      ],
+      output: `
+        /**
+         *
+         * Second Test Case
+         *
+         * @param {number} baz
+         */
+      `,
+    },
   ],
   valid: [
     {