You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In its current form, the plugin doesn't supply a rule to check the types referenced from an inline link or inheritDoc tag.
This means that it's harder for maintainers of documentation to notice when these break due to a rename of some referenced type.
I suggest adding a new rule named check-types or valid-types (as a homage to eslint-plugin-jsdoc's rule of the same name) which would check that the type referenced is in scope of the comment.
Note: Enabling this rule, could potentially also mark the types as used and fix #348 too.
I'd be interested in submitting a PR for this, if this is interesting for the maintainers.
The text was updated successfully, but these errors were encountered:
kraenhansen
changed the title
eslint-plugin-tsdoc: Check types referenced through {@link} and {@inheritDoc}eslint-plugin-tsdoc: Check types referenced through {@link} and {@inheritDoc}May 4, 2023
In its current form, the plugin doesn't supply a rule to check the types referenced from an inline link or inheritDoc tag.
This means that it's harder for maintainers of documentation to notice when these break due to a rename of some referenced type.
I suggest adding a new rule named
check-types
orvalid-types
(as a homage to eslint-plugin-jsdoc's rule of the same name) which would check that the type referenced is in scope of the comment.Note: Enabling this rule, could potentially also mark the types as used and fix #348 too.
I'd be interested in submitting a PR for this, if this is interesting for the maintainers.
The text was updated successfully, but these errors were encountered: