LuaLS / LuaLS/lua-language-server

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

Offen
#2,436 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Lua
Sterne
4.4k
Forks
442
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit nachzuverfolgen, wie der Sprachserver @alias-Deklarationen, Hover-Informationen und IntelliSense-Suchvorschläge verarbeitet. Reproduziere das DeviceSide-Beispiel und folge den bestehenden Pfaden für das Hovern über "left" und die Suche nach "left side". Erledigt bedeutet, dass sowohl das Hover-Popup als auch der beschreibungsbasierte Vorschlag für Alias-Einträge funktionieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
lua
Bereich
devtools
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.