jsdoc/valid-types Rule Errors when namepath contains readonly (all lowercase)

[dhurlburtusa]

Expected behavior

The following should be valid and should not generate an error.

/**
 * @param {object} params
 * @param {boolean} params.readonly
 */

Actual behavior

/**
 * @param {object} params
 * @param {boolean} params.readonly
 */

Errors with: "Syntax error in namepath: params.readonly jsdoc/valid-types".

ESLint Config

module.exports = {
  root: true,
  extends: ["plugin:jsdoc/recommended"],
  rules: {
    "jsdoc/valid-types": "error",
  },
};

ESLint sample

/**
 * @param readonly
 */

/**
 * @param {boolean} readonly
 */

/**
 * @param {object} params
 * @param {boolean} params.readonly
 */

Environment

• Node version: 16.6.1
• ESLint version: 8.4.1
• eslint-plugin-jsdoc version: 37.2.0

Possible Cause

I believe the cause of this is due to the following PR: jsdoc-type-pratt-parser/jsdoc-type-pratt-parser#98

Although the cause may be due to the parser (I filed an issue there too (jsdoc-type-pratt-parser/jsdoc-type-pratt-parser#104)), I'm thinking it would be good to improve the tests here to help catch some of these errors.

[brettz9]

I'd prefer we get any tests added to jsdoc-type-pratt-parser. Don't need to cover every edge case in this project, I think. Closing but feel free to comment further as needed.

[jdatskuid]

I ran into this error today in a typedef. We have an object with a property named "readonly" and I get this error.

ESLint v7.7.0

Example:

/**
 * An object interface
 * @typedef  {Object} FooBar
 * @property {boolean} readonly
 * @property {boolean} private
 * @property {boolean} public
 * @property {boolean} constant
 */

Error:

32:0  error  Syntax error in namepath: readonly          jsdoc/valid-types

My only workaround was to disable the valid-types rule for the JSDoc comment:

/* eslint-disable jsdoc/valid-types */
/**
 * An object interface
 * @typedef  {Object} FooBar
 * @property {boolean} readonly
 * @property {boolean} private
 * @property {boolean} public
 * @property {boolean} constant
 */
/* eslint-enable */

[brettz9]

The issue is being tracked at jsdoc-type-pratt-parser..

You might try surrounding the item in quotes and see if that provides a temporary resolution.

[jdatskuid]

Thanks, I noticed that after posting. Quotes do not resolve the issue.