`eslint-plugin-tsdoc`: Check types referenced through `{@link}` and `{@inheritDoc}`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
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 https://github.com/microsoft/tsdoc/issues/348 too.
I'd be interested in submitting a PR for this, if this is interesting for the maintainers.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the eslint-plugin-tsdoc implementation and its handling of {@link} and {@inheritDoc} tags. Review how existing rules resolve referenced types, then define the rule's scope and expected behavior; done means invalid referenced types are reported and the relevant tests cover valid and renamed or missing types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100