LuaLS / lua-language-server

A language server that offers Lua language support - programmed in Lua
https://luals.github.io
MIT License
3.29k stars 305 forks source link

When defining global variable using `---@class _G` + `---@field`, no autocompletion in `_G.*` for those injected fields #2714

Open tomlau10 opened 3 months ago

tomlau10 commented 3 months ago

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. image

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