microsoft / microsoft/TypeScript
Considering limiting hover length
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 3.7.x-dev.201xxxxx
Search Terms: hover, length
Code
// A *self-contained* demonstration of the problem follows...
// Test this by running `tsc` on the command-line, rather than through another build tool such as Gulp, Webpack, etc.
Expected behavior: JSDocs can always be shown
Actual behavior: JSDocs is hidden because hover is too long
Related Issues: https://github.com/microsoft/vscode/issues/92787
It seems certain type hover will be formatted to one property each line. I'm wondering if you could only adopt this behavior when the total lines do not exceed a threshold (like 10 lines), so it wouldn't affect JSDocs.
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 hover behavior with the provided Playground Link and compare the expected and actual displays, including the linked VS Code issue. Investigate the hover formatting behavior and determine how a line threshold could preserve JSDoc visibility without changing shorter type hovers. Done means long hovers still show JSDocs while the proposed formatting remains for shorter hovers.
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