fix(check-tag-names): loosen tag replacement to allow for no-space if…

… at word boundary (as at end of line)
gajus · Jul 12, 2019 · 1145cd0 · 1145cd0
1 parent 15424f8
commit 1145cd0
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 1 deletion.
diff --git a/src/rules/checkTagNames.js b/src/rules/checkTagNames.js
@@ -60,7 +60,10 @@ export default iterateJsdoc(({
 
       if (preferredTagName !== tagName) {
         report(message, (fixer) => {
-          const replacement = sourceCode.getText(jsdocNode).replace(`@${tagName} `, `@${preferredTagName} `);
+          const replacement = sourceCode.getText(jsdocNode).replace(
+            new RegExp(`@${_.escapeRegExp(tagName)}\\b`),
+            `@${preferredTagName}`
+          );
 
           return fixer.replaceText(jsdocNode, replacement);
         }, jsdocTag);

diff --git a/test/rules/assertions/checkTagNames.js b/test/rules/assertions/checkTagNames.js
@@ -373,6 +373,39 @@ export default {
           }
         }
       }
+    },
+    {
+      code: `
+          /**
+           * @abc
+           * @abcd
+           */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Invalid JSDoc tag (preference). Replace "abc" JSDoc tag with "abcd".'
+        }
+      ],
+      output: `
+          /**
+           * @abcd
+           * @abcd
+           */
+          function quux () {
+
+          }
+      `,
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            abc: 'abcd'
+          }
+        }
+      }
     }
   ],
   valid: [