LuaLS/lua-language-server

Better global

Open

#283 opened on Dec 5, 2020

View on GitHub
 (3 comments) (4 reactions) (0 assignees)Lua (4,251 stars) (427 forks)batch import
help wanted

Description

I'm going to do some work for global variable distinguishing environments. At present, my idea is as follows:

---@global global -- the table will be merged into current globals. the second `global` can be omitted
local t = {
    X = 1,
    Y = 2,
    Z = 3,
}

print(X) -- `X` is `t.X`
---@global module1, module2 -- the table will be merged into environment `module1` and `module2`
local t = {
    X = 1,
    Y = 2,
    Z = 3,
}

print(X) -- `x` is undefined

---@environment module1, global -- set the current environment can visit `module1` and `global`
print(X) -- `X` is `t.X`

---@environment module1
print(X) -- `X` is `t.X` and `print` is undefined

EDIT:

---@partial class _G -- the table will be merged into class `_G`. the default environment is class `_G`
local t = {
    X = 1,
    Y = 2,
    Z = 3,
}

print(X) -- `X` is `t.X`
---@class module1
local t = {
    X = 1,
    Y = 2,
    Z = 3,
}

print(X) -- `x` is undefined

---@environment module1, _G -- set the current environment can visit class `module1` and `_G`
print(X) -- `X` is `t.X`

---@environment module1
print(X) -- `X` is `t.X` and `print` is undefined

Contributor guide