Skip to content

VS Code 扩展

提示

本文为 参与扩展开发;若仅需安装,请访问 VS MarketplaceOpen VSX Registry

开发流程

克隆 oxc-vscode 仓库并执行 pnpm install

本地构建与调试

两种方式:

命令行

  • pnpm build:编译 VS Code 扩展并构建 release Language Server
  • pnpm install-extension:安装进 VS Code
  • Ctrl+Shift+P,执行「Developer: Reload Window」
  • 随后在 VS Code 中手动验证改动

在 VS Code 内

  • 用 VS Code 打开 oxc-vscode
  • 「运行与调试」(Run and Debug),选择配置 Launch VS Code Extension
  • 点击绿色运行按钮——会新开窗口并载入刚构建的扩展

使用未发布的 oxlint / oxfmt

oxc 主仓库 编译:

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

在扩展 settings.json 中指向本地产物:

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

查看输出面板

想了解扩展/Language Server 行为,可在 VS Code 「输出」(Output) 里选择 Oxc channel。
若想更啰嗦,设为:

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

若你在 oxc_language_server 等 Rust crate 中集成 oxfmt/oxlint,可用 info! / error! 等宏输出到 VS Code Oxc channel。

撰写测试

视改动决定在何处添加测试:仅 VS Code UI 专有逻辑放在扩展,LSP 与工具本体通信相关测试写在 oxlint/oxfmtoxc_language_server

例如:

  • VS Code:状态栏等行为
  • oxlint:诊断与 code actions 返回
  • oxc_language_server:工作区级问题聚合