Documenting an object parameter with the name module triggers jsdoc/valid-types

[edg2s]

Expected behavior

No error is found in the code example

Actual behavior

An error is reported from the line containing * @param {string} options.module:

Syntax error in namepath: options.module

ESLint Config

{
  "jsdoc/valid-types": "error"
}

ESLint sample

/**
 * @param {string} id
 * @param {Object} options
 * @param {boolean} options.isSet
 * @param {string} options.module
 */
function ( id, options ) {
}

Environment

• Node version:
• ESLint version
• eslint-plugin-jsdoc version: 37.0.3

[brettz9]

I think this might be an issue for jsdoc-type-pratt-parser (for not allowing "module" in this position)... @simonseyock ?

As a workaround, you can use jsdoc's escaping mechanism:

* @param {string} options."module"

[dog-s-life]

Same issue for external.

/**
 * @param {boolean} requestBody.external blah blah.
 */

[c69-addepar]

i have filed the same issue for parser, it reproduces consistently:
jsdoc-type-pratt-parser/jsdoc-type-pratt-parser#102

But not sure if the actual a bug is in parser, or in this plugin.

[brettz9]

Closing as tracking to be done in jsdoc-type-pratt-parser. (We regularly update, and if we don't just ping us.)

[gajus]

🎉 This issue has been resolved in version 37.4.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀