fix(require-hyphen-before-param-description): regression failing to…

… only check for hyphen at beginning; fixes #665
gajus · Jan 3, 2021 · acc3fc1 · acc3fc1
1 parent 62abd11
commit acc3fc1
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -9572,6 +9572,14 @@ function quux () {
  * @property foo - Foo.
  */
 // Options: ["never",{"tags":{"*":"always"}}]
+
+/** Entry point for module.
+ *
+ * @param {!Array<string>} argv Command-line arguments.
+ */
+function main(argv) {
+};
+// Options: ["never"]
 ````
 
 

diff --git a/src/rules/requireHyphenBeforeParamDescription.js b/src/rules/requireHyphenBeforeParamDescription.js
@@ -16,7 +16,7 @@ export default iterateJsdoc(({
       return;
     }
 
-    const startsWithHyphen = (/-/u).test(jsdocTag.description);
+    const startsWithHyphen = (/^\s*-/u).test(jsdocTag.description);
     if (always) {
       if (!startsWithHyphen) {
         report(`There must be a hyphen before @${targetTagName} description.`, (fixer) => {
@@ -37,7 +37,7 @@ export default iterateJsdoc(({
       }
     } else if (startsWithHyphen) {
       report(`There must be no hyphen before @${targetTagName} description.`, (fixer) => {
-        const [unwantedPart] = /\s*-\s*/u.exec(jsdocTag.description);
+        const [unwantedPart] = /^\s*-\s*/u.exec(jsdocTag.description);
 
         const replacement = sourceCode
           .getText(jsdocNode)

diff --git a/test/rules/assertions/requireHyphenBeforeParamDescription.js b/test/rules/assertions/requireHyphenBeforeParamDescription.js
@@ -488,5 +488,16 @@ export default {
         }},
       ],
     },
+    {
+      code: `
+      /** Entry point for module.
+       *
+       * @param {!Array<string>} argv Command-line arguments.
+       */
+      function main(argv) {
+      };
+      `,
+      options: ['never'],
+    },
   ],
 };