fix(check-tag-names): treat keys in tagNamePreference setting as de…

…fined so appropriate message will appear and fixer applied
gajus · Jul 12, 2019 · 2a605bf · 2a605bf
1 parent b7bebd1
commit 2a605bf
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 1 deletion.
diff --git a/src/rules/checkTagNames.js b/src/rules/checkTagNames.js
@@ -16,8 +16,11 @@ export default iterateJsdoc(({
   const {definedTags = []} = context.options[0] || {};
 
   let definedPreferredTags = [];
+  let definedNonPreferredTags = [];
   const {tagNamePreference} = settings;
   if (Object.keys(tagNamePreference).length) {
+    definedNonPreferredTags = _.keys(tagNamePreference);
+
     // Replace `_.values` with `Object.values` when we may start requiring Node 7+
     definedPreferredTags = _.values(tagNamePreference).map((preferredTag) => {
       if (typeof preferredTag === 'string') {
@@ -41,7 +44,7 @@ export default iterateJsdoc(({
 
   jsdoc.tags.forEach((jsdocTag) => {
     const tagName = jsdocTag.tag;
-    if (utils.isValidTag(tagName, [...definedTags, ...definedPreferredTags])) {
+    if (utils.isValidTag(tagName, [...definedTags, ...definedPreferredTags, ...definedNonPreferredTags])) {
       let preferredTagName = utils.getPreferredTagName(
         tagName,
         true,

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