LuaLS / LuaLS/lua-language-server

Missing diagnostic when passing nil-able fields to pairs/ipairs

未关闭
#2,429 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Type Checking, Diagnostics/Syntax Checking

Expected Behaviour

In the following code, I expect to get param-type mismatch for each of the for loops (with pairs and ipairs) because the variable being iterated can be nil:

---@type string[]?
local x1 = {}

for _ in ipairs(x1) do  -- param-type-mismatch: Cannot assign `string[]?` to parameter `<T:table>
    break
end

---@type table<string, boolean>?
local y1 = {}

for _ in ipairs(y1) do -- param-type-mismatch: Cannot assign `table<string, boolean>?` to parameter `<T:table>
    break
end

---@class Class
---@field x string[]?
---@field y table<string, boolean>?

---@type Class
local x2 = {}

for _ in ipairs(x2.x) do -- Should warn, but it doesn't
    break
end

for _ in pairs(x2.y) do -- Should warn, but it doesn't
    break
end
Actual Behaviour

The param-type-mismatch diagnostic is only shown for the first two loops (direct variables without nesting/fields), but not when using fields (the third and fourth for loops).

Reproduction steps

Copy the code into a Lua file and observe the diagnostics

Additional Notes

No response

Log File

No response

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

将提供的 Lua 示例复制到 Lua 文件中,并比较直接变量与嵌套字段的诊断结果,以重现该问题。跟踪处理 ipairs 和 pairs 参数的类型检查路径,然后验证 nullable 字段是否会收到与直接变量相同的 param-type-mismatch 诊断。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
devtools
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。