fix(check-tag-names): ensure replacement field overrides a default tag name preference; fixes #367

Author: brettz9

README.md

@@ -1550,6 +1550,14 @@ function quux (foo) {
 function quux () {
 
 }
+
+/**
+ * @extends Foo
+ */
+function quux () {
+
+}
+// Settings: {"jsdoc":{"tagNamePreference":{"augments":{"message":"@extends is to be used over @augments.","replacement":"extends"}}}}
 ````
 
 

src/jsdocUtils.js

@@ -61,7 +61,10 @@ const getJsdocParameterNames = (jsdoc : Object, targetTagName : string) : Array<
 };
 
 const getPreferredTagName = (name : string, tagPreference : Object = {}) : string => {
-  if (_.values(tagPreference).includes(name)) {
+  const prefValues = _.values(tagPreference);
+  if (prefValues.includes(name) || prefValues.some((prefVal) => {
+    return prefVal && typeof prefVal === 'object' && prefVal.replacement === name;
+  })) {
     return name;
   }
 

test/rules/assertions/checkTagNames.js

@@ -517,5 +517,25 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @extends Foo
+           */
+          function quux () {
+
+          }
+      `,
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            augments: {
+              message: '@extends is to be used over @augments.',
+              replacement: 'extends',
+            },
+          },
+        },
+      },
+    },
   ],
 };