LuaLS / LuaLS/lua-language-server

`need-check-nil` doesn't recognize nil check propagation

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

还没有人认领这个 Issue。

enhancement
主要语言
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?

MacOS

What is the issue affecting?

Diagnostics/Syntax Checking

Expected Behaviour

Ideally, need-check-nil would infer a nil check has been completed if I've already done that nil check earlier as part of a larger check. Specifically, the statement if not (a and a.b) then will properly register as a nil check on a, but assigning the inner expression to a local var prevents LLS from detecting it as a nil check.

Actual Behaviour

LLS warns need-check-nil when a variable cannot possibly be nil, if the check was masked via another variable.

Reproduction steps
---@return table?
local function stuff()
    return nil
end

local item = stuff()
local x = item and item.x
if not x then -- Works: `if not (item and item.x) then`
   -- This includes case where `item` is `nil` 
else
    local subitem = item.key -- Error on `item` (need-check-nil)
end
Additional Notes

No response

Log File

No response

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先使用 issue 中的 Lua 示例,在 Visual Studio Code 扩展中复现 need-check-nil 诊断,然后跟踪该诊断的 nil-check 传播逻辑。当之前通过 x 进行的检查已经排除了 item 为 nil 的可能性时,该示例不再对 item.key 发出警告,即表示完成。

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

评估

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

把新 issue 发到你的邮箱

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