Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
tomlau10 opened this issue Jun 18, 2024 · 0 comments

Comments

@tomlau10
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant