LuaLS / LuaLS/lua-language-server

[Question/Request] Can I recycle common params for differing functions without mass copy+paste?

Aperta
#1,772 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement feat/LuaCats Annotations
Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I would like to be able to recycle a list of parameters (and types), sometimes with an extra parameter or a different set of return values. I only know how to do this via copy+paste of parameters from one function to the next, and edit as needed. However, I am trying to reduce the code volume, clarity, as well as make it easier to enact changes that should cascade to any function which uses those sets of parameters.

Here's an example:

---@param blah number
---@param barf function
---@param puke fun(boolean):number
---@param thanks table
function foo(blah, barf, puke, thanks)
end

---@param blah number
---@param barf function
---@param puke fun(boolean):number
---@param thanks table
---@return boolean
function bar(blah, barf, puke, thanks)
    return true
end

I'd like to be able to define a 'defined parameter set' which would allow me to do something like this:

---@parameters hmmm
---@param blah number
---@param barf function
---@param puke fun(boolean):number
---@param thanks table

---@uses parameters hmmm
function foo(blah, barf, puke, thanks)
end

---@uses parameters hmmm
---@return boolean
function bar(blah, barf, puke, thanks)
    return true
end

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

L’issue non indica file di implementazione, test o punti di ingresso. Inizia individuando come vengono analizzate le annotazioni Lua come @param e @return, quindi valuta come una dichiarazione riutilizzabile di un insieme di parametri e il suo utilizzo potrebbero adattarsi a quella sintassi. Il lavoro è completato quando i parametri condivisi possono essere documentati una volta, riutilizzati da più funzioni, estesi o combinati con valori di ritorno diversi e coperti da test.

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
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.