LuaLS / LuaLS/lua-language-server
When defining global variable using `---@class _G` + `---@field`, no autocompletion in `_G.*` for those injected fields
还没有人认领这个 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?
Completion
Expected Behaviour
The _G class is defined in extension's basic.lua, representing the global vairable. I expected the following should merge the defined fields into the global variable.
---@class _G
---@field player_min integer
---@field player_max integer
print(p--[[should have autocompletion]])
print(_G.p--[[should have autocompletion]])
Actual Behaviour
LuaLs recognized the injected field in the hover preview of _G, however no autocompletion for those fields are provided, unless I write _G._G.*.
---@class _G
---@field player_min integer
---@field player_max integer
print(p--[[no autocompletion]])
print(_G.p--[[no autocompletion]])
print(_G._G.p--[[!!! has autocompletion !!!]])
Reproduction steps
Use the code snippet provided above.
Additional Notes
LuaLS actually recognized the injected fields in the hover preview of _G, just the autocompletion is not working as expected.
Meanwhile the workaround is the use ---@type annotation for global variable. However as discussed here, unless the global variable is of table type, otherwise any default value assigned to it will be misleading as the global variable may not be a const.
Log File
No response
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
使用提供的 Lua 代码片段复现 Visual Studio Code 扩展中的补全行为,然后检查 basic.lua 中针对 _G 的定义和补全路径。当使用 @field 在 _G 上声明的字段同时出现在全局补全和 _G.* 补全中,且不要求使用 _G._G.* 时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- lua
- 领域
- devtools
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 38/100