microsoft / microsoft/TypeScript
Allow reporting errors for unresolved @ link jsdoc tags
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Suggestion
🔍 Search Terms
- jsdoc
@link
⭐ Suggestion
Add an option to report unresolved @link symbols in JSDoc comments.
This can help catch some simple mistakes and also alert the user to cases where our IntelliSense doesn't understand the jsdocs symbol
📃 Motivating Example
/**
* {@link food} <- Should been an error here
*/
const foo = 12
💻 Use Cases
We'd use this in vscode for both our main codebase and for our vscode.d.ts file.
I imagine this would also be quite useful for maintaining definitely typed
Related issues
- #15852
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 with the motivating JSDoc example and related issue #15852 to determine how unresolved @link symbols should be diagnosed and made configurable. The work is complete when an option reports unresolved links without affecting valid links, including the described VS Code and declaration-file use cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100