LuaLS / LuaLS/lua-language-server

`---@cast` annotation doesn't respect scope rules

未关闭
#2,761 3 条评论 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

Expected Behaviour

The ---@cast annotation should respect Lua scoping rules.

Actual Behaviour

Let's consider:

--- @class foo
--- @field a number

--- @class bar
--- @field b string

--- @type { [integer]: foo|bar }
local array = {}

for i, instance in ipairs(array) do
	if instance.a then
                -- First if block
		--- @cast instance foo
	end

	if instance.b then
                -- Second if block
	end
end

In the first if block, we cast the instance to the foo type. When hovering over the instance variable in the second if block we can see its type is foo. It would be expected for its type to be bar since the ---@cast happened in different scope.
image

Reproduction steps
  1. Copy-paste the given example code into your text editor.
  2. Hover over the instance variable in the second if block.
  3. See the error in the popup.
Additional Notes

No response

Log File

No response

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先,在 Visual Studio Code 扩展中使用提供的 Lua 示例重现该问题,并检查类型检查如何处理两个 if 块的作用域。完成标准是,向 foo 的 cast 仅在第一个块内生效,而第二个块中的实例保留适当的推断类型,而不是 foo。

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

评估

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

把新 issue 发到你的邮箱

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