配置编辑器

编辑器扩展使用项目中的 oxfmt --lsp，因此必须在本地安装 oxfmt。

参见 快速入门 以安装 Oxfmt。

支持的编辑器

• VS Code（以及 Cursor 等）
• Zed
• JetBrains
• Neovim
• 其他编辑器

VS Code

安装

从以下位置下载官方 Oxc VS Code 扩展：

• Visual Studio Marketplace
• Open VSX Registry

该扩展兼容其他基于 VS Code 的编辑器，包括 Cursor。

团队设置

1. 向贡献者推荐该扩展：

.vscode/extensions.json:

.vscode/extensions.json

{
  "recommendations": ["oxc.oxc-vscode"]
}

2. 在 .vscode/settings.json 中启用保存时格式化：

.vscode/settings.json

{
  "oxc.fmt.configPath": ".oxfmtrc.json",
  "editor.defaultFormatter": "oxc.oxc-vscode",
  "editor.formatOnSave": true
}

按语言设置：

.vscode/settings.json

{
  "[javascript]": {
    "editor.defaultFormatter": "oxc.oxc-vscode",
    "editor.formatOnSave": true
  },
  "[typescript]": {
    "editor.defaultFormatter": "oxc.oxc-vscode",
    "editor.formatOnSave": true
  }
}

参考

• oxc-project/oxc-vscode

Zed

安装

• Oxc Zed 扩展

参考

• oxc-project/oxc-zed

JetBrains

IntelliJ IDEA 和 WebStorm。

安装

• JetBrains Marketplace 中的 Oxc

参考

• oxc-project/oxc-intellij-plugin

Neovim

nvim-lspconfig

npm i -g oxfmt

vim.lsp.enable('oxfmt')

• nvim-lspconfig: oxfmt

conform.nvim

require("conform").setup({
  formatters_by_ft = {
    javascript = { "oxfmt" },
    javascriptreact = { "oxfmt" },
    typescript = { "oxfmt" },
    typescriptreact = { "oxfmt" },
    json = { "oxfmt" },
    vue = { "oxfmt" },
  },
})

• conform.nvim

coc.nvim

:CocInstall coc-oxc

• oxc-project/coc-oxc

其他编辑器

对于支持 LSP 的编辑器（如 Emacs、Helix、Sublime），进行如下配置：

oxfmt --lsp

或者，对于不支持 LSP 的编辑器：

cat foo/bar.js | oxfmt --stdin-filepath dummy.js --config ./path/to/config.json

参考

• oxc_language_server