LuaLS / LuaLS/lua-language-server

Better global

Open
#283 3 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue proposes new @global, @partial, @class, and @environment annotations for distinguishing Lua environments, but names no files, tests, or entry points. Start by clarifying the intended environment and merging semantics, then locate the annotation and global-resolution implementations. Done means the proposed examples resolve globals as described and have coverage for the different environment combinations.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.