fix(require-hyphen-before-param-description): inject hyphen at prop…

…er place with multiline type
gajus · Oct 11, 2024 · 8b5b7f7 · 8b5b7f7
1 parent 34866bc
commit 8b5b7f7
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 28 deletions.
diff --git a/docs/rules/require-hyphen-before-param-description.md b/docs/rules/require-hyphen-before-param-description.md
@@ -193,6 +193,15 @@ function quux () {
  */
 // "jsdoc/require-hyphen-before-param-description": ["error"|"warn", "always",{"tags":{"*":"never","property":"always"}}]
 // Message: There must be no hyphen before @returns description.
+
+/**
+ * @param {(
+ *  | string
+ *  | number
+ * )} input The input value
+ */
+function test(input) {}
+// Message: There must be a hyphen before @param description.
 ````
 
 

diff --git a/src/rules/requireHyphenBeforeParamDescription.js b/src/rules/requireHyphenBeforeParamDescription.js
@@ -33,38 +33,39 @@ export default iterateJsdoc(({
     }
 
     const startsWithHyphen = (/^\s*-/u).test(desc);
-    if (always) {
-      if (!startsWithHyphen) {
-        report(`There must be a hyphen before @${targetTagName} description.`, (fixer) => {
-          const lineIndex = /** @type {import('../iterateJsdoc.js').Integer} */ (
-            jsdocTag.line
-          );
-          const sourceLines = sourceCode.getText(jsdocNode).split('\n');
-
-          // Get start index of description, accounting for multi-line descriptions
-          const description = desc.split('\n')[0];
-          const descriptionIndex = sourceLines[lineIndex].lastIndexOf(description);
+    let lines = 0;
+    for (const {
+      tokens,
+    } of jsdocTag.source) {
+      if (tokens.description) {
+        break;
+      }
 
-          const replacementLine = sourceLines[lineIndex]
-            .slice(0, descriptionIndex) + '- ' + description;
-          sourceLines.splice(lineIndex, 1, replacementLine);
-          const replacement = sourceLines.join('\n');
+      lines++;
+    }
 
-          return fixer.replaceText(jsdocNode, replacement);
-        }, jsdocTag);
+    if (always) {
+      if (!startsWithHyphen) {
+        utils.reportJSDoc(
+          `There must be a hyphen before @${targetTagName} description.`,
+          {
+            line: jsdocTag.source[0].number + lines,
+          },
+          () => {
+            for (const {
+              tokens,
+            } of jsdocTag.source) {
+              if (tokens.description) {
+                tokens.description = tokens.description.replace(
+                  /^(\s*)/u, '$1- ',
+                );
+                break;
+              }
+            }
+          }
+        );
       }
     } else if (startsWithHyphen) {
-      let lines = 0;
-      for (const {
-        tokens,
-      } of jsdocTag.source) {
-        if (tokens.description) {
-          break;
-        }
-
-        lines++;
-      }
-
       utils.reportJSDoc(
         `There must be no hyphen before @${targetTagName} description.`,
         {

diff --git a/test/rules/assertions/requireHyphenBeforeParamDescription.js b/test/rules/assertions/requireHyphenBeforeParamDescription.js
@@ -447,6 +447,32 @@ export default {
        */
       `,
     },
+    {
+      code: `
+        /**
+         * @param {(
+         *  | string
+         *  | number
+         * )} input The input value
+         */
+        function test(input) {}
+      `,
+      errors: [
+        {
+          line: 6,
+          message: 'There must be a hyphen before @param description.',
+        },
+      ],
+      output: `
+        /**
+         * @param {(
+         *  | string
+         *  | number
+         * )} input - The input value
+         */
+        function test(input) {}
+      `,
+    },
   ],
   valid: [
     {