Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

eslint-plugin-tsdoc: Check types referenced through {@link} and {@inheritDoc} #349

Open
kraenhansen opened this issue May 4, 2023 · 0 comments

Comments

@kraenhansen
Copy link

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.

@kraenhansen 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant