格式化工具

OpenCode 会在文件写入或编辑后，自动使用特定语言的格式化工具进行格式化。这确保了生成的代码遵循您项目的代码风格。

---

内置格式化工具

OpenCode 为多种流行语言和框架提供了内置的格式化工具。以下是格式化工具列表、支持的文件扩展名以及所需的命令或配置选项。

格式化工具	扩展名	要求
gofmt	.go	gofmt 命令可用
mix	.ex, .exs, .eex, .heex, .leex, .neex, .sface	mix 命令可用
prettier	.js, .jsx, .ts, .tsx, .html, .css, .md, .json, .yaml, 以及 更多	package.json 中包含 prettier 依赖项
biome	.js, .jsx, .ts, .tsx, .html, .css, .md, .json, .yaml, 以及 更多	存在 biome.json(c) 配置文件
zig	.zig, .zon	zig 命令可用
clang-format	.c, .cpp, .h, .hpp, .ino, 以及 更多	存在 .clang-format 配置文件
ktlint	.kt, .kts	ktlint 命令可用
ruff	.py, .pyi	ruff 命令可用且已配置
rustfmt	.rs	rustfmt 命令可用
uv	.py, .pyi	uv 命令可用
rubocop	.rb, .rake, .gemspec, .ru	rubocop 命令可用
standardrb	.rb, .rake, .gemspec, .ru	standardrb 命令可用
htmlbeautifier	.erb, .html.erb	htmlbeautifier 命令可用
air	.R	air 命令可用
dart	.dart	dart 命令可用
ocamlformat	.ml, .mli	ocamlformat 命令可用且存在 .ocamlformat 配置文件
terraform	.tf, .tfvars	terraform 命令可用
gleam	.gleam	gleam 命令可用
nixfmt	.nix	nixfmt 命令可用
shfmt	.sh, .bash	shfmt 命令可用
oxfmt (实验性)	.js, .jsx, .ts, .tsx	package.json 中包含 oxfmt 依赖项，并且设置了 实验性环境变量标志

因此，如果你的项目 package.json 中包含了 prettier，OpenCode 将自动使用它。

---

工作原理

当 OpenCode 写入或编辑文件时，它会：

1. 根据所有已启用的格式化器检查文件扩展名。
2. 在文件上运行相应的格式化器命令。
3. 自动应用格式化更改。

此过程在后台进行，确保您的代码风格得以保持，无需任何手动步骤。

---

配置

您可以通过 OpenCode 配置中的 formatter 部分来自定义格式化器。

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "formatter": {}
}

每个格式化器配置支持以下属性：

属性	类型	描述
disabled	boolean	设置为 true 以禁用该格式化器
command	string[]	用于格式化的运行命令
environment	object	运行格式化器时要设置的环境变量
extensions	string[]	此格式化器应处理的文件扩展名

让我们看一些示例。

---

禁用格式化器

要全局禁用所有格式化器，请将 formatter 设置为 false：

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "formatter": false
}

要禁用特定格式化器，请将 disabled 设置为 true：

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "formatter": {
    "prettier": {
      "disabled": true
    }
  }
}

---

自定义格式化器

你可以通过指定命令、环境变量和文件扩展名来覆盖内置的格式化器或添加新的格式化器：

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "formatter": {
    "prettier": {
      "command": ["npx", "prettier", "--write", "$FILE"],
      "environment": {
        "NODE_ENV": "development"
      },
      "extensions": [".js", ".ts", ".jsx", ".tsx"]
    },
    "custom-markdown-formatter": {
      "command": ["deno", "fmt", "$FILE"],
      "extensions": [".md"]
    }
  }
}

命令中的 $FILE 占位符 将被替换为正在格式化的文件路径。