microsoft / microsoft/TypeScript
Support import types in JSDoc links
Open
Nobody has claimed this yet.
Experience Enhancement
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Bug Report
🔎 Search Terms
- JSDoc
- link / see
🕗 Version & Regression Information
4.3.0-dev.20210503
💻 Code
For some JavaScript:
// foo.js
export class Foo {}
// index.js
/**
* {@link import('./foo').Foo Foo}
*
* @param {import('./foo').Foo} foo
*/
function withFoo(foo) { }
🙁 Actual behavior
The parameter type is resolved but the @link is not
🙂 Expected behavior
Both links should be resolved
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 JSDoc link handling for the {@link import('./foo').Foo Foo} example in index.js, comparing it with the working @param {import('./foo').Foo} case and the exported Foo in foo.js. Done means both the parameter type and the JSDoc link resolve to Foo.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100