LuaLS / LuaLS/lua-language-server

Alias comments only show for strings and numbers

Aperta
#2,284 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

(Split from: https://github.com/LuaLS/lua-language-server/issues/2279)

Aliases have a feature where they can be multiline and you can write comments for different available values. However, this only works for string and numbers. For example in this code:

---@class TestClass

---@enum TestEnum
TestEnum = {
	TEST1 = 1,
	TEST2 = 2,
	TEST3 = 3,
}

---@alias TestAlias
---| 'TEST1' # TEST1 comment
---| 'TEST2' # TEST2 comment
---| 'TEST3' # TEST3 comment
---| TestClass # TestClass comment
---| TestEnum # TestEnum comment
---| TestEnum.TEST1 # TestEnum.TEST1 comment
---| 1 # TestNumber Comment

---@param test TestAlias
local function test(test)
end

test()

I get this
Screenshot_1

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

Riproduci il report in LuaLS con l’esempio di alias dell’issue, quindi traccia il modo in cui i commenti degli alias vengono raccolti e visualizzati per i valori stringa e numerici. Verifica lo stesso comportamento per TestClass, TestEnum e TestEnum.TEST1; il lavoro è completo quando i commenti compaiono per quei valori alias così come compaiono per stringhe e numeri.

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

Valutazione

Stack tecnologico
lua
Ambito
devtools
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.