microsoft / microsoft/TypeScript
Tooltips / IntelliSense: Don't resolve type aliases (aka "semantic sugar") set explicitly
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
We have defined a bunch of "semantic sugar" type aliases like:
Status quo (bad): VS Code is resolving these along the alias chain in tooltips and IntelliSense suggestions (which kinda makes non-sense of the type alias in the first place)
(c.f. hovered tooltip over this.url at bottom)
Better: Let VS Code show UrlString as type here instead of string to aid developers with semantic sugar as of what type of string to expect.
Alternative: Show both, i.e. BufferingWebSocket.url: UrlString (= string).
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 behavior in VS Code's tooltips and IntelliSense suggestions with an explicitly defined type alias such as UrlString. Investigate the TypeScript language-service entry points that produce these displays; done means the alias remains visible, or both the alias and its underlying type are shown consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100