Repository navigation
jsdoc/valid-types for "is" property #1221
Description
Expected behavior
Defining a property or param named is should be allowed.
Actual behavior
When defining a param or property named is, the linter reports an error for the rule jsdoc/valid-types.
ESLint Config
{
"env": {
"es2021": true
},
"extends": [
"eslint:recommended"
],
"plugins": [
"jsdoc"
],
"parserOptions": {
"sourceType": "module",
"ecmaVersion": "latest"
},
"rules": {
"jsdoc/valid-types": 2
}
}ESLint sample
/**
* @param {string} is
* @param {string} foo
*
* @returns {string}
*/
export default function (is, foo) {
return is + foo;
}I've also created a project that reproduces the issue on codesandbox.io:
https://codesandbox.io/p/devbox/festive-sun-g23dhw-y3vs47
Environment
- Node version: v20.9.0
- ESLint version: v8.57.0
eslint-plugin-jsdocversion: 48.2.2
Activity
fix(`valid-types`): whitelist pratt parser keywords; fixes gajus#1221
fix(`valid-types`): whitelist pratt parser keywords; fixes #1221
github-actions commentedon Apr 4, 2024
🎉 This issue has been resolved in version 48.2.3 🎉
The release is available on:
Your semantic-release bot 📦🚀
brettz9 commentedon Apr 4, 2024
The fix in #1222 doesn't handle nested use of the keyword. For that, one has to escape with quotation marks.