fix: workaround for 'constructor' key in tagNamePreference; fixes #537

Author: edg2s

.README/README.md

@@ -156,6 +156,8 @@ Use `settings.jsdoc.tagNamePreference` to configure a preferred alias name for a
 }
 ```
 
+Note: ESLint does not allow settings to have keys which conflict with Object.prototype e.g. `'constructor'`. To work around this use can use the key `'tag constructor'`.
+
 One may also use an object with a `message` and `replacement`.
 
 The following will report the message `@extends is to be used over @augments as it is more evocative of classes than @augments` upon encountering `@augments`.

README.md

@@ -212,6 +212,8 @@ Use `settings.jsdoc.tagNamePreference` to configure a preferred alias name for a
 }
 ```
 
+Note: ESLint does not allow settings to have keys which conflict with Object.prototype e.g. `'constructor'`. To work around this use can use the key `'tag constructor'`.
+
 One may also use an object with a `message` and `replacement`.
 
 The following will report the message `@extends is to be used over @augments as it is more evocative of classes than @augments` upon encountering `@augments`.
@@ -2614,6 +2616,15 @@ function quux (foo) {
 // Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
 // Message: Invalid JSDoc tag (preference). Replace "param" JSDoc tag with "arg".
 
+/**
+ * @constructor foo
+ */
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"tagNamePreference":{"tag constructor":"cons"}}}
+// Message: Invalid JSDoc tag (preference). Replace "constructor" JSDoc tag with "cons".
+
 /**
  * @arg foo
  */

src/jsdocUtils.js

@@ -223,8 +223,15 @@ const getPreferredTagName = (
     return name;
   }
 
-  if (_.has(tagPreference, name)) {
-    return tagPreference[name];
+  // Allow keys to have a 'tag ' prefix to avoid upstream bug in ESLint
+  // that disallows keys that conflict with Object.prototype,
+  // e.g. 'tag constructor' for 'constructor' (#537)
+  const tagPreferenceFixed = _.mapKeys(tagPreference, (value, key) => {
+    return key.replace('tag ', '');
+  });
+
+  if (_.has(tagPreferenceFixed, name)) {
+    return tagPreferenceFixed[name];
   }
 
   const tagNames = getTagNamesForMode(mode, context);

test/rules/assertions/checkTagNames.js

@@ -112,6 +112,37 @@ export default {
         },
       },
     },
+    {
+      code: `
+          /**
+           * @constructor foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Invalid JSDoc tag (preference). Replace "constructor" JSDoc tag with "cons".',
+        },
+      ],
+      output: `
+          /**
+           * @cons foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            'tag constructor': 'cons',
+          },
+        },
+      },
+    },
     {
       code: `
           /**