VS Code 扩展

TIP

本页面适用于贡献 Oxc VS Code 扩展。 要下载该扩展，请参阅 Visual Studio Marketplace 或 Open VSX Registry。

开发

克隆 oxc-vscode 仓库并运行 pnpm install。

本地构建和运行扩展

有两种方式可以运行和测试对 Oxc VS Code 扩展所做的更改。

通过命令行：

• 运行 pnpm build 来编译 VS Code 扩展，并构建语言服务器的发布版本。
• 运行 pnpm install-extension 将其安装到 VS Code。
• 按下 Ctrl + Shift + P，搜索 “Developer: Reload Window”。
• 现在你可以在 VS Code 内手动测试你的更改。

通过 VS Code 本身：

• 在 VS Code 中打开 oxc-vscode 仓库。
• 转到编辑器左侧边栏的“运行与调试”选项卡。
• 选择 Launch VS Code Extension 配置。
• 点击顶部的绿色播放按钮。
• 这将构建 VS Code 扩展，并启动一个新窗口的 VS Code，其中已安装最新构建的 VS Code 扩展。

测试未发布的 oxlint/oxfmt 版本

在 oxc 项目 中执行以下操作进行构建：

cd apps/oxlint && pnpm build-test
cd ../oxfmt && pnpm build-test

然后通过 settings.json 中的扩展设置，配置 VS Code 扩展使用本地构建版本：

{
  "oxc.path.oxlint": "/path/to/oxc/apps/oxlint/dist/cli.js",
  "oxc.path.oxfmt": "/path/to/oxc/apps/oxfmt/dist/cli.js"
}

使用输出通道

要查看扩展和语言服务器的运行情况，请使用 VS Code 中的 Oxc 输出通道。 如需获取更多信息，请在 settings.json 中启用以下扩展设置：

{
  "oxc.trace.server": "verbose"
}

在 oxlint/oxfmt（例如 oxc_language_server crate）的语言服务器集成中，你可以使用 info! 或 error! 宏向 VS Code 的 Oxc 输出通道发送消息。

编写测试

根据你的修改内容，应创建相应的测试。 仅当测试与 VS Code 特定功能相关时，才应在 VS Code 扩展中编写测试。 针对工具的 LSP 通信的测试应添加至 oxlint/oxfmt，或添加至 Rust crate oxc_language_server。

示例：

• VS Code：状态栏变化
• oxlint：返回的诊断信息 / 代码操作
• oxc_language_server：工作区问题