redhat-developer / redhat-developer/vscode-java
Pass the function signature in the detail property of the completion item instead of the label
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 2.3k
- Fork
- 546
- Merge medio
- 20h 1m
- PR unite (30g)
- 11
Descrizione
Based on the gif in the README and the snapshots in https://github.com/Microsoft/vscode/issues/29126#issuecomment-432262123, it looks like this extension is appending the function signature to the function name in the label of the completion item.
This makes the reading of the items hard, especially when the docs are expanded to the side (Hit Ctrl+Space to show/hide the docs once the suggest widget is open)
The CompletionItem has a property called detail. Most extensions use this property to pass the signature. Below is a typsescript example:


I understand the temptation to include the signature as part of the label. It allows the user to choose the right item from the list at a glance. But this is only possible when the function name is small and docs are collapsed. Else, it just adds noise

Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia tracciando dove questa estensione costruisce oggetti VS Code CompletionItem, utilizzando la CompletionItem API documentation e la completion UI mostrata nell’issue. Sposta la firma della funzione da item label alla sua detail property, quindi verifica con Ctrl+Space che i labels siano più puliti mentre la firma rimane visibile nella documentazione espansa.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- developer-experience
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100