LuaLS / LuaLS/lua-language-server

[Feature Request] @alias hover description / search for description

Aperta
#2,436 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

It would be really nice, to have a popup, when hovering over a `@alias`.

```
---@alias DeviceSide
---| '"left"' # The left side of the device
---| '"right"' # The right side of the device
---| '"top"' # The top side of the device
---| '"bottom"' # The bottom side of the device
---| '"front"' # The front side of the device
---| '"back"' # The back side of the device

---@param side DeviceSide
local function checkSide(side) end
```

**Hover description**
eg:
```
checkSide("left")
```
when hovering over "left", display a popup with the text: `The left side of the device`

**Search for description**
When beginning to type:
```
checkSide(left side
```

it would be great, if the IntelliSense would show the entry `"left" -- The left side of the device`

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 tracciando il modo in cui il server del linguaggio gestisce le dichiarazioni @alias, le informazioni al passaggio del mouse e i suggerimenti di ricerca IntelliSense. Riproduci l'esempio DeviceSide e segui i percorsi esistenti per passare il mouse su "left" e cercare "left side". Il lavoro è completato quando funzionano sia il popup al passaggio del mouse sia il suggerimento basato sulla descrizione per le voci alias.

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

Valutazione

Stack tecnologico
lua
Ambito
devtools
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.