microsoft / microsoft/TypeScript
JSDoc doesn't dig through type aliases
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 6fd6a04f2eabcbd468b80aac270b34bad24892e4
Code
/** @param containingNode Node to check for parse error */
type AddUnusedDiagnostic = (containingNode: number, type: number, diagnostic: number) => void;
Expected behavior: containingNode in the JSDoc comment binds to the parameter of the function type (e.g. rename, quick info, document highlights, and GTD work).
Actual behavior: containingNode doesn't bind to anything and the quick info just says it has type any.
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 reproducing the reported TypeScript snippet and tracing how its JSDoc parameter is resolved for a function type inside a type alias. Verify the result through quick info, rename, document highlights, and GTD work; done means containingNode binds to the function-type parameter instead of showing any.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100