Alias for default tag name broken for @constructor

[Crystal-Spider]

Expected behavior

Not to give off a warning saying "Invalid JSDoc tag (preference). Replace "constructor" JSDoc tag with "class"." when I set
"settings": { "jsdoc": { "tagNamePreference": { "constructor": "constructor" } }
For other tag aliases, like the one proposed in the README "return", it works fine.

Actual behavior

ESLint Config

{
  "root": true,
  "parser": "@typescript-eslint/parser",
  "plugins": [
    "jsdoc"
  ],
  "rules": {
    "jsdoc/check-tag-names": "warn"
  },
  "settings": {
    "jsdoc": {
      "tagNamePreference": {
        "constructor": "constructor"
      }
    }
  },
  "ignorePatterns": [
    "build",
    "dist",
    "**/*.d.ts"
  ]
}

ESLint sample

/**
 * @constructor
 */
 constructor() {}

Environment

• Node version: 14.17.1
• ESLint version: 7.32.0
• eslint-plugin-jsdoc version: 36.1.0

[brettz9]

Are you only getting this in your IDE or also when you run the eslint binary against it?

I'm not able to replicate with the binary using those settings and the following code:

      class A {
        /**
         * @constructor
         */
         constructor() {
           super();
         }
      }

i.e., with this as our test case:

    {
      code: `
      class A {
        /**
         * @constructor
         */
         constructor() {
           super();
         }
      }
      `,
      parser: require.resolve('@typescript-eslint/parser'),
      settings: {
        jsdoc: {
          tagNamePreference: {
            constructor: 'constructor',
          },
        },
      },
    },

[Crystal-Spider]

@brettz9 Hi, thank you for your replay.
I'm not sure what you mean to be honest, my fault, but if it can be of any help, I run the command
npx eslint . --ext .js,.ts
and I did get
warning Invalid JSDoc tag (preference). Replace "constructor" JSDoc tag with "class" jsdoc/check-tag-names.
So I think it's not showing up only in the IDE.

[brettz9]

Yes, if you are getting the problem from the command line like that, then there does appear to be some problem. (unless it is due to an older ESLint version which I wouldn't think).

Could you make a repository which minimally reproduces the problem? I.e., which has nothing but a single simple JavaScript/TypeScript file, package.json, and ESLint config file that can reproduce the problem?

[Crystal-Spider]

Basic repository to reproduce the error created here.

[brettz9]

Thanks for the repo. I was able to replicate, so expect should be able to fix it, but expect to be preoccupied for maybe the next week or two before I can get to this.

[brettz9]

Ok, apologies for the long delay... As per the docs, it turns out, you just need to use tag constructor:

      settings: {
        jsdoc: {
          tagNamePreference: {
            'tag constructor': 'constructor',
          },
        },
      },

Closing as that should resolve, though feel free to comment further.