LuaLS / LuaLS/lua-language-server

An annotation for indicating that a function may error

Abierto
#2,400 0 comentarios 3 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 pretty useful to have an indicator of whether the function may error (and thus needs to be handled with pcall or the like).

---@fallible
---@param bar string
---@return string bar
local function assert_is_foobar(bar)
    if bar ~= "foobar" then
        error("bar isn't equal to foobar")
    end
    return bar
end

I'm aware of #1881 but it doesn't fullfill the same purpose as @fallible, the main difference being the fact that @noreturn indicates that the function never returns while this indicates that the function could return an error

The LSP server could also potentially show the user a warning if they don't wrap a @fallible function in a pcall call

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

Comienza revisando cómo el servidor de lenguaje gestiona actualmente la anotación relacionada @noreturn y cómo analiza el uso de pcall. El issue no menciona archivos ni pruebas, y el comportamiento de advertencia previsto se describe como opcional, por lo que es necesario aclarar el alcance de la implementación y los criterios de finalización antes de programar.

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.