microsoft / microsoft/TypeScript
Show documentation for literals in intellisense
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Suggestion
When filling in a value where the expected type is a union of literals, intellisense is able to suggest the possible values.
However, it does NOT show the documentation associated with each literal:
This makes me tend to use enums instead, which has a more verbose syntax and requires an extra import.
Use Cases
Building and documented APIs in typescript will be nicer if we could just document the literals in a union.
Search Terms
- intellisense for string literals
- documentation for string literals
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 IntelliSense completion for a union of documented string literals in TypeScript. Trace the completion and documentation behavior for literal suggestions, then verify that each suggested literal displays its associated documentation without changing enum behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100