如何配置VSCode使sumneko.lua识别Premake5全局函数并消除警告？

1. 配置工作区全局API声明 #

打开项目根目录下的.vscode/settings.json，添加Premake相关的全局变量/函数到诊断白名单，让sumneko.lua识别这些API为合法定义，不再标记警告：

{
    "Lua.diagnostics.globals": [
        "premake",
        "workspace",
        "project",
        "filter",
        "config",
        "group",
        "target",
        "files",
        "excludes",
        // 按需补充项目里用到的其他Premake API
    ],
    "Lua.runtime.version": "Lua 5.1" // Premake基于Lua 5.1，指定版本能提升语言服务准确性
}

2. 添加Premake类型定义文件（优化代码补全体验） #

在项目根目录创建一个类型定义文件（比如premake_types.d.lua），手动定义Premake API的类型结构，既能消除警告，还能获得代码补全和类型提示：

---@class PremakeWorkspace
---@field name string
---@field location string
---@field configurations table<string>
function workspace(name) end

---@class PremakeProject
---@field kind string
---@field language string
---@field targetdir string
function project(name) end

-- 根据自身使用需求，继续定义其他常用的Premake函数和属性

3. 配置Premake自定义模块路径（如有需要） #

如果项目中用到了自定义的Premake脚本模块，在settings.json中补充模块路径，让sumneko.lua能识别这些自定义脚本：

{
    "Lua.workspace.library": [
        "${workspaceFolder}/path/to/your/premake/modules"
    ]
}

将路径替换为你实际存放Premake自定义模块的文件夹路径即可。

4. 针对性关闭冲突诊断规则 #

如果遇到和Premake使用习惯冲突的警告（比如小写全局变量提示），可以在settings.json中关闭对应规则：

{
    "Lua.diagnostics.disable": [
        "lowercase-global", // Premake API多为小写全局，该规则会误报，可关闭
        "unused-local" // 若不想看到未使用局部变量的警告，也可关闭
    ]
}

内容的提问来源于stack exchange，提问作者AberrantWolf