LuaLS / LuaLS/lua-language-server

support nil checks on object fields

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

Nadie ha tomado este issue todavía.

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

Descripción

At present a variable's nil check is recognised as meaning the variable can't have a type of nil within the code block, but this doesn't work for object fields.

Setup code:

---@class MapPosition
---@field x integer
---@field y integer

---@class Data
---@field targetPosition MapPosition|nil

---@type Data
local data = {
    targetPosition = nil
}

---@param x MapPosition
local function demandMapPositionClass(x)
end

Object field code that doesn't work as it misses the nil check.

--- Object field nil check
local targetPos  ---@type MapPosition
if data.targetPosition ~= nil then
    targetPos = data.targetPosition -- This has set targetPos to a type of nil or MapPosition. But a nil value can't enter this block.
else
    targetPos = {x = 1, y = 1}
end
demandMapPositionClass(targetPos) -- This warns as targetPos can now contain nil.

Variable code that works correctly with it auto detecting the nil check.

--- Variable nil check
local targetPos2  ---@type MapPosition
local test = data.targetPosition
if test ~= nil then
    targetPos2 = test -- This correctly knows that test can only be of type MapPosition.
else
    targetPos2 = {x = 1, y = 1}
end
demandMapPositionClass(targetPos2)

I can fix the object field check with an @as on the offending line to force it to the right data type, but this isn't as futureproofed for later code changes. Also making a new variable just for this to magically works seems a waste and misleading when reading the code as you'd assume a variable is used later on for a specific purpose and not just to help Sumneko intellisense,

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

Empieza reproduciendo el problema con la configuración de Lua y compara el estrechamiento de tipos para data.targetPosition con el estrechamiento para la variable de prueba local. Sigue la ruta de análisis de tipos que gestiona las comprobaciones de nil en campos de objetos; se considera terminado cuando el ejemplo del campo de objeto ya no muestra una advertencia al pasar targetPos a demandMapPositionClass.

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

Evaluación

Stack tecnológico
lua
Área
devtools
Tipo de issue
Error
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.