LuaLS / LuaLS/lua-language-server
Add a shortcut annotation for adding a `nil,string` return type to functions (`@error`)
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
Returning of errors from Lua functions is often done by returning nil + error message (nil,string):
---@return table
---@overload fun(): nil, string
local function doSomething()
but this syntax can get complex when function takes parameters, or has other overloads. An old solution from LDoc was to use a @error annotation - I propose to add something similar to LuaLS.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
El payload no menciona archivos, pruebas ni puntos de entrada de LuaLS; empieza leyendo el comportamiento de @error en el manual de LDoc enlazado y localizando el análisis de anotaciones y el manejo de tipos de retorno de LuaLS. Done debería definir y probar cómo representa @error un retorno nil,string para funciones parametrizadas y funciones con otras sobrecargas.
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
- Necesita aclaración
- Aptitud para principiantes
- 30/100