LuaLS / LuaLS/lua-language-server

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

Abierto
#1,772 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

enhancement feat/LuaCats Annotations
Lenguaje dominante
Lua
Estrellas
4.4k
Forks
442
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

El issue no especifica archivos de implementación, pruebas ni puntos de entrada. Empieza por localizar cómo se analizan las anotaciones de Lua como @param y @return; después, evalúa cómo encajarían en esa sintaxis una declaración reutilizable de conjunto de parámetros y su uso. Se considera terminado cuando los parámetros compartidos puedan documentarse una vez, reutilizarse en varias funciones, ampliarse o combinarse con distintos valores de retorno y quedar cubiertos por pruebas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
lua
Área
devtools
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.