LuaLS / LuaLS/lua-language-server

Support specifying globals inside Lua files

未关闭
#1,464 8 条评论 9 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

enhancement
主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

Currently, when using this language server, you get warnings for global variables:

if someGlobalVariable then -- Undefined global `someGlobalVariable `. Lua Diagnostics.(undefined-global)
  print("wow!")
end

The way to squelch them is to add the globals to the VSCode settings. But this is too much of a sledgehammer, as we might only want the globals to be enabled in this specific file. Thus, we should also add a feature so that end-users can specify the globals in-line:

-- We specify a list of globals at the top of the file.
-- @global someGlobalVariable 

someCode()

if someGlobalVariable then -- No warning.
  print("wow!")
end

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先定位 language server 中未定义全局变量诊断的处理逻辑,以及现有的 VSCode 全局变量设置。追踪 Lua 注释的解析方式,然后定义并测试内联 @global 语法,使指定的全局变量仅在该文件中被接受,而不改变项目范围的设置。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua
领域
devtools
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。