microsoft / microsoft/TypeScript

Investigate eagerly returning more information about suggestions

Aperta
#36,265 24 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

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:

Screen Shot 2020-01-17 at 11 26 30 AM

This design also reflects the design of the suggestion api:

  • completionInfo returns the entire list of suggestions, but only includes the name
  • completionEntryDetails returns 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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo questa issue e l’issue #39441 di VS Code collegata, quindi confronta le API completionInfo e completionEntryDetails descritte qui. Verifica quali dettagli dei suggerimenti sarebbero utili nell’elenco principale, nonché i costi relativi alle dimensioni dei messaggi e ai calcoli del server TypeScript. Il lavoro è completato quando viene documentato il feedback del team TypeScript o si arriva a una proposta chiara.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript, vscode
Ambito
developer-experience, tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.