Unable to parse namepath with readonly

[dhurlburtusa]

The following should all be valid JSDoc:

/**
 * @param readonly
 */

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

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

in jsdoc or typescript (maybe closure too) mode but they fail to parse.

When running tryParse with 'readonly' or 'params.readonly'`, it errors with "Error: No parslet found for token: 'readonly' with value 'readonly'".

tryParse('readonly');
// Error: No parslet found for token: \'readonly\' with value \'readonly\'
tryParse('params.readonly');
// Error: No parslet found for token: \'readonly\' with value \'readonly\'

Note that the following both run without error:

tryParse('readOnly')
tryParse('params.readOnly')

I believe this was caused by PR #98.

[simonseyock]

This has similar problems as #102

Imagine: @type {readonly}. This expression is not valid typescript.

The problem is that eslint-plugin-jsdoc parses type and name independently with jsdoc-type-pratt-parser and the parser does not provide different modes for the type and the name.

[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 */

[dysphasia]

I also received this issue when defining an object with the property name "is"

/**
 * @param {object} props
 * @param {string} props.is
 */ 

3:1  warning  Syntax error in namepath: props.is  jsdoc/valid-types

This workaround removed the ESLint error

/**
 * @param {object} props
 * @param {string} props."is"
 */ 

Package Versions:

• eslint: 8.37.0
• eslint-plugin-jsdoc: 40.1.1

[brettz9]

For eslint-plugin-jsdoc v48.2.3, I've at least added support for the few problematic keywords I could detect ("readonly", "is", "import", "typeof"). I just check if the name is a direct match and if so, forego checking. This does not handle nested cases which still require escaping ala obj."readonly".