Closed
Description
Motivation
To allow the likes of this standard JSDoc approach, which allows for documentation per parameter:
/**
* @param {object} cfg
* @param {boolean} cfg.isChecked
* @param {string} cfg.path
*/
...but without complaining about "object" not being a specific type if one's preferredTypes
normally discourage the use of this object. One can already exempt it within a @typedef
, but one shouldn't wish to normally exempt it in @param
--only if it is the "root" param. This would therefore need to be a new kind of exemptedBy
, allowing probably for an object and possibly AST comment
and context
.
Current behavior
Using object
in a root param when it is prevented in preferredTypes
will err.
Desired behavior
Don't err when using object
in a root param.
Alternatives considered
N/A
Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.
Activity
[-]`exemptedBy` for `check-types` and expanded[/-][+]allow means to skip roots in`check-types`[/+]feat(`check-types`): add `skipRootChecking` option to `preferredTypes…
feat(`check-types`): add `skipRootChecking` option to `preferredTypes…
feat(`check-types`): add `skipRootChecking` option to `preferredTypes…
feat(`check-types`): add `skipRootChecking` option to `preferredTypes…
gajus commentedon Nov 2, 2022
🎉 This issue has been resolved in version 39.6.0 🎉
The release is available on:
Your semantic-release bot 📦🚀
Update dependency eslint-plugin-jsdoc to v39.6.0 (#1623)