typescript-eslint / typescript-eslint/ts-api-utils
🛠 Tooling: Ensure example tags include the function they describe
Open
Nobody has claimed this yet.
area: tooling
status: needs investigation
- Dominant language
- TypeScript
- Stars
- 122
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
Bug Report Checklist
- I have tried restarting my IDE and the issue persists.
- I have pulled the latest
mainbranch of the repository. - I have searched for related issues and found none that matched my issue.
Overview
Following up on #176: can we add a lint rule or similar to enforce this typo doesn't happen again? Perhaps this is a good rule to add to eslint-plugin-jsdoc.
Investigation needed to see if this exists somewhere already.
Additional Info
No response
Contributor guide
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 reviewing issue #176 and investigating whether eslint-plugin-jsdoc already has a rule that enforces example tags matching the function they describe. Determine where such a rule would belong and what examples it should cover; done means documenting the chosen approach and adding an enforceable rule or confirming an existing one.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- eslint, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100