
开发者详解如何为 Zed 编辑器构建 pylyzer 语言服务器扩展
来源标题:A Deep Dive into Building the Pylyzer-Zed Language Server Extension
开发者 Tomás Gonzalez Dowling 撰文介绍了自己开发 pylyzer-zed 扩展的完整过程,该扩展将 Python 静态代码分析器 Pylyzer 集成进 Zed 编辑器。Zed 的扩展基于 Rust 编写并编译为 WebAssembly,在编辑器内安全运行,不同于传统编辑器依赖的 Node.js 插件。文章还介绍了配置 Rust 工具链和 WASM 目标的具体步骤。
以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。
软件工程 Rust 扩展 Zed:深入解析 pylyzer-zed 语言服务器扩展的构建过程 Tomás Gonzalez Dowling 阅读时间 5 分钟· 2026 年 10 月 7 日
Zed 迅速成为追求极速、响应灵敏的代码编辑器的开发者们的最爱。但真正让 Zed 出彩的是它的可扩展模型。与依赖笨重的进程外 Node.js 插件的传统编辑器不同,Zed 扩展被编译为 WebAssembly(WASM),在编辑器内部安全高效地运行。
最近,我决定深入 Zed 扩展开发,创建了 pylyzer-zed——一个将 Pylyzer(一款快速、面向 Python 的静态代码分析器和语言服务器)集成到 Zed 中的扩展。
在本文中,我将带你回顾我的经历、Zed 扩展的架构,以及我在过程中学到的实践经验。
包含自定义逻辑(如语言服务器适配器)的 Zed 扩展用 Rust 编写。在编写任何代码之前,你需要搭建 Rust 工具链并配置 WebAssembly 目标。
以下是我准备环境时使用的确切步骤:
1. 通过 rustup 安装 Rust(如果尚未安装)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
2. 为你的 Rust 工具链添加 WebAssembly 目标
注意:虽然我从 wasm32-wasip1 开始,但请留意 Zed 文档,因为
他们正积极向 wasm32-wasip2 演进,用于更新的扩展构建。
rustup target add wasm32-wasip1
3. 在本地安装实际的 Pylyzer 二进制文件用于测试
cargo install pylyzer --locked
工具链就绪后,构建扩展只需运行:
cargo build --target=wasm32-wasip1
Zed 扩展的构成
Zed 扩展本质上是一个具有特定结构的 Git 仓库。对于 pylyzer-zed,核心文件如下所示:
pylyzer-zed/ ├── extension.toml # Zed 扩展清单 ├── Cargo.toml # Rust 包配置 └── src/ └── pylyzer.rs # WebAssembly 扩展逻辑
清单文件:extension.toml
该文件告诉 Zed 你的扩展是什么以及它提供什么功能。对于语言服务器,你需要定义 [language_servers] 表:
id = "pylyzer" name = "Pylyzer" description = "Pylyzer support for Python." version = "0.0.1" schema_version = 1 authors = ["Tomas Gonzalez Dowling tomas@comtom.engineering"] repository = "https://github.com/comtom/pylyzer-zed" [language_servers.pylyzer] name = "Pylyzer" languages = ["Python"]
Rust crate:Cargo.toml
Zed 要求扩展编译为动态库(cdylib)。我们还需要引入 zed_extension_api,它提供了与编辑器交互所需的绑定。
[package] name = "pylyzer-zed" version = "0.0.1" edition = "2021" [lib] path = "src/pylyzer.rs" crate-type = ["cdylib"] [dependencies] zed_extension_api = "^0.2.0"
- 编写扩展逻辑
神奇之处发生在 src/pylyzer.rs 中。要集成语言服务器,我们需要定义一个 struct 并实现 zed::Extension trait。
以下是核心实现的简化拆解:
use zed_extension_api::{self as zed, settings::LspSettings}; struct Pylyzer; impl zed::Extension for Pylyzer { fn new() -> Self { Self {} fn language_server_command( &mut self, _language_server_id: &zed_extension_api::LanguageServerId, worktree: &zed_extension_api::Worktree, ) -> zed_extension_api::Result<zed_extension_api::Command> { // 1. 捕获用户的 shell 环境 let env = worktree.shell_env(); // 2. 检查用户是否在 Zed 设置中提供了自定义二进制路径 if let Ok(lsp_settings) = LspSettings::for_worktree("pylyzer", worktree) { if let Some(binary) = lsp_settings.binary { if let Some(path) = binary.path { let args = binary.arguments.unwrap_or_else(|| default_args()); return Ok(zed::Command { command: path, args, env }); // 3. 回退方案:在工作区的 PATH 中查找 'pylyzer' let path = worktree .which("pylyzer") .ok_or_else(|| "pylyzer must be installed and available in $PATH.".to_string())?; Ok(zed::Command { command: path, args: default_args(), env, }) // ...(initialization_options 和 workspace_configuration 的实现) fn default_args() -> Vec<String> { vec![ "--server".to_string(), "--".to_string(), "--disable".to_string(), "inlayHints".to_string(), "--disable".to_string(), "semanticTokens".to_string(), zed::register_extension!(Pylyzer);
代码中的关键要点:
环境至关重要:通过调用 worktree.shell_env(),我们确保语言服务器继承用户的 shell 环境(如已激活的 Python 虚拟环境),这对 Python 工具链至关重要。
优雅解析:代码首先检查 LspSettings,看用户是否显式配置了二进制路径。如果没有,则优雅地回退到 worktree.which("pylyzer"),在项目的 $PATH 中搜索。
合理默认值:Pylyzer 可以提供 inlay hints 和 semantic tokens,但 Zed 已经对这两者有出色的原生支持。通过默认传入 --disable inlayHints 和 --disable semanticTokens,我们避免重复的 UI 渲染,让 Zed 发挥其长处。
配置透传:实现了 language_server_initialization_options 和 language_server_workspace_configuration 方法,用于读取用户在 settings.json 中提供的任何自定义 JSON 设置,并将它们直接传递给 Pylyzer LSP。
- 测试与调试
Zed 扩展架构最棒的一点是 Dev Extension 工作流。你无需将扩展发布到注册表即可测试。
由于扩展在 WASM 沙箱中运行,标准调试工具受到限制。不过,Zed 会将 stdout 和 stderr 直接转发到主 Zed 进程。
如果需要排查问题,在 Rust 代码中添加 println! 或 dbg! 语句,重新构建,然后从终端以 --foreground 标志启动 Zed:
zed --foreground
(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)
正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。