LuaLS / LuaLS/lua-language-server

Feature request: Infer overload annotations for subsequent overloads

Abierto
#2,309 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Lua
Estrellas
4.4k
Forks
442
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

It would be useful for subsequent function overload definitions to use prior annotations unless a new annotation is provided.

Such as:

---An example function
---@param a integer
---@param b string
---@param c function Some documentation about c
---@return boolean
---@overload fun(c)
---@overload fun(a): nil
function foo(a, b, c) end

being equivalent to

---An example function
---@param a integer
---@param b string
---@param c function Some documentation about c
---@return boolean
function foo(a, b, c) end

---An example function
---@param c function Some documentation about c
---@return boolean
function foo(c)

---An example function
---@param a integer
---@return nil
function foo(a)

With auto-generated documentation this isn't so much of a problem, but it's a bit of a chore when it's something to be done by hand.

Appreciate all the work you've done! This makes writing Lua so much more confident.

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 nombra archivos ni tests. Empieza localizando el manejo de @overload y de las anotaciones de parámetros/retorno; después, añade cobertura específica para heredar las anotaciones anteriores y sobrescribirlas cuando un overload proporcione unas nuevas. Se considera terminado cuando los dos overloads del ejemplo reciben las anotaciones heredadas y explícitas documentadas sin cambiar la definición original.

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
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.