microsoft / microsoft/TypeScript
Investigate eagerly returning more information about suggestions
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
Problem
Suggestions VS Code have three broad UX parts:
- Name/label. Primary identifier for a suggestion, such as
foo. - Details. Type information or auto import info, such as
string. - Documentation. Js doc info and additional details about the suggestion item
Currently VS Code only shows the details of the currently active suggestion. This can be problematic in cases like auto imports, where multiple symbols may all have the same name:
This design also reflects the design of the suggestion api:
completionInforeturns the entire list of suggestions, but only includes the namecompletionEntryDetailsreturns the details and documentation for an individual suggestion
Investigation
With https://github.com/microsoft/vscode/issues/39441, VS Code is exploring letting languages/extensions return the details part of the suggestion eagerly. This would let VS Code show details for the entire list of suggestions instead of just for the active one. In the auto import case specifically, this would likely mean showing the file paths we would import from.
We would like the typescript team's feedback on these idea and our current proposals:
- What information would be most helpful to render in the main suggestion list?
- How much overhead would returning this information add? Both in terms of message size and TS server computation time?
/cc @jrieken For VS Code apis
/cc @amcasey @minestarks for VS
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par lire cette issue et l’issue #39441 de VS Code qui lui est liée, puis comparez les API completionInfo et completionEntryDetails décrites ici. Examinez quels détails des suggestions seraient utiles dans la liste principale, ainsi que les coûts liés à la taille des messages et aux calculs du serveur TypeScript. Le travail est considéré comme terminé lorsque les retours de l’équipe TypeScript sont documentés ou qu’une proposition claire est établie.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript, vscode
- Domaine
- developer-experience, tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100