microsoft / microsoft/TypeScript-TmLanguage
JSDoc grammar highlights @return {@link ...} as type
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 471
- Forks
- 149
- PR merge metrics
- No merged PRs in 30d
Description
With the following code, TS claims that {@link TreeItem} is incorrect
export interface TreeDataProvider<T> {
/**
* @return {@link TreeItem} representation of the element
*/
getTreeItem(element: T): TreeItem;
}
adding a character between return and {@link TreeItem} resolves it.
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
Reproduce the incorrect handling with the JSDoc example in the issue, then inspect the TypeScript TextMate grammar rules covering @return and inline {@link ...} tags. Done means the link is no longer treated as an invalid type or incorrectly highlighted, while ordinary @return types still work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100