fix(match-name): perform replacements for names appearing after mul…

…tiline types
gajus · Mar 12, 2022 · a23168d · a23168d
1 parent 13f128b
commit a23168d
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -7685,6 +7685,14 @@ function quux () {
 function quux () {}
 // "jsdoc/match-name": ["error"|"warn", ]
 // Message: Rule `no-restricted-syntax` is missing a `match` option.
+
+/**
+ * @param {
+ *   someType
+ * } opt_a
+ */
+// "jsdoc/match-name": ["error"|"warn", {"match":[{"disallowName":"/^opt_/i","replacement":""}]}]
+// Message: Only allowing names not matching `/^opt_/i` but found "opt_a".
 ````
 
 The following patterns are not considered problems:

diff --git a/src/rules/matchName.js b/src/rules/matchName.js
@@ -50,9 +50,14 @@ export default iterateJsdoc(({
     }
 
     const fixer = () => {
-      tag.source[0].tokens.name = tag.source[0].tokens.name.replace(
-        disallowNameRegex, replacement,
-      );
+      for (const src of tag.source) {
+        if (src.tokens.name) {
+          src.tokens.name = src.tokens.name.replace(
+            disallowNameRegex, replacement,
+          );
+          break;
+        }
+      }
     };
 
     let {

diff --git a/test/rules/assertions/matchName.js b/test/rules/assertions/matchName.js
@@ -325,6 +325,38 @@ export default {
       ],
       options: [],
     },
+    {
+      code: `
+        /**
+         * @param {
+         *   someType
+         * } opt_a
+         */
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Only allowing names not matching `/^opt_/i` but found "opt_a".',
+        },
+      ],
+      options: [
+        {
+          match: [
+            {
+              disallowName: '/^opt_/i',
+              replacement: '',
+            },
+          ],
+        },
+      ],
+      output: `
+        /**
+         * @param {
+         *   someType
+         * } a
+         */
+      `,
+    },
   ],
   valid: [
     {