若VSCode中Zig缺少补全、跳转定义或悬停提示,需配置Zig Language Server(ZLS):一、用zig build编译安装;二、用zigpkg一键安装;三、用Homebrew安装;四、启用Zig扩展并验证集成。

如果您在 VSCode 中使用 Zig 语言时发现缺少代码补全、跳转定义或悬停提示等功能,则很可能是 Zig Language Server(ZLS)未正确安装或未被 VSCode 识别。以下是配置 ZLS 的多种可行方式:
本文运行环境:MacBook Pro M2,macOS Sequoia
一、通过 zig build 编译安装 zls
此方法适用于需要与当前 Zig 编译器版本严格匹配的场景,zls 源码需使用同版本 Zig 构建,确保协议兼容性与功能完整性。
1、在终端中执行 git clone https://github.com/zigtools/zls.git 下载官方 zls 仓库。
2、进入 zls 目录:cd zls。
3、运行构建命令:zig build -Drelease-safe,生成可执行文件。
4、定位输出路径:默认为 zls/zig-out/bin/zls,将其复制至全局可访问位置如 /usr/local/bin/zls。
5、在 VSCode 设置中打开 JSON 配置(Cmd+, → 右上角打开设置(JSON)),添加键值对:"zig.zlsPath": "/usr/local/bin/zls"。
二、使用 zigpkg 快速安装 zls
zigpkg 是 Zig 社区维护的包管理工具,支持一键拉取预编译的 zls 二进制,适用于希望跳过编译过程的用户。
1、确保已安装 zigpkg:运行 curl -sSf https://raw.githubusercontent.com/zigtools/zigpkg/main/install.sh | sh 完成安装。
2、执行安装命令:zigpkg install zls,自动下载并放置 zls 至 ~/.zigpkg/bin/。
3、将该路径加入系统 PATH:在 ~/.zshrc 中追加 export PATH="$HOME/.zigpkg/bin:$PATH"。
4、重新加载 shell 配置:source ~/.zshrc,验证是否可用:zls --version。
5、在 VSCode 设置 JSON 中配置 "zig.zlsPath": "~/.zigpkg/bin/zls"(注意:VSCode 不展开波浪线,需替换为绝对路径如 /Users/username/.zigpkg/bin/zls)。
三、使用 Homebrew 安装预编译 zls
Homebrew 提供社区维护的 zls 公式,适合偏好包管理器统一维护依赖的 macOS 用户,避免手动构建与路径配置复杂度。
1、更新 Homebrew:brew update。
2、安装 zls:brew install zls。
3、确认安装路径:brew --prefix zls,典型输出为 /opt/homebrew/opt/zls/bin/zls。
4、在 VSCode 设置 JSON 中写入完整路径:"zig.zlsPath": "/opt/homebrew/opt/zls/bin/zls"。
四、启用 VSCode Zig 扩展并验证 zls 集成
VSCode Zig 官方扩展内置 zls 自动发现机制,但需满足 Zig 编译器已就位且 zls 可执行文件位于 PATH 或显式配置路径中,方可激活全部 LSP 功能。
1、打开 VSCode 扩展市场(Cmd+Shift+X),搜索 Zig,选择发布者为 Zig Team 的扩展并安装。
2、重启 VSCode,新建 test.zig 文件,输入 std. 后等待自动弹出补全列表。
3、将光标置于任何标准库函数名上,按 Option+K(macOS)触发悬停提示,确认显示函数签名与文档说明。
4、右键点击函数名,选择“转到定义”,验证能否准确跳转至 std 库源码位置。










