LuaLS / LuaLS/lua-language-server
Suggestion: Make `@param;@return` available as code action
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Lua
- Sterne
- 4.4k
- Forks
- 442
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
One really nice feature of the lua-lsp is that by typing --- above a function, we get the @param;@return suggestions which auto-inserts function annotation.
Would it be possible to make this feature available via code action as well? Right now, it takes a bit of repetitive work to get the annotations inserted. When at the function head: up, -. -, -, enter. By using a code action, this could be reduced to one hotkey (and depending on your editor, maybe one extra enter).
Another benefit would be that making this available as code action would increase the discoverability of this feature. For a while, I didn't know that this very useful feature even existed. By being a code action, it would be far easier to discover for new users.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die bestehenden durch --- ausgelösten Vorschläge nachzuverfolgen, die @param- und @return-Annotationen einfügen, und untersuche dann, wo Code Actions vom Sprachserver bereitgestellt werden. Fertig ist die Änderung, wenn das Einfügen derselben Annotation über eine Code Action verfügbar ist und an einem Funktionskopf weiterhin auffindbar bleibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- lua
- Bereich
- devtools
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100