格式化程序

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

---

内置

OpenCode 内置了多种针对流行语言和框架的格式化工具。下面列出了这些格式化工具、支持的文件扩展名以及所需的命令或配置选项。

格式化工具	扩展	要求
air	.R	air 命令可用
biome	.js、.jsx、.ts、.tsx、.html、.css、.md、.json、.yaml，以及更多	biome.json(c) 配置文件
cargofmt	.rs	cargo fmt 命令可用
clang-format	.c、.cpp、.h、.hpp、.ino，以及更多	.clang-format 配置文件
cljfmt	.clj、.cljs、.cljc、.edn	cljfmt 命令可用
dart	.dart	dart 命令可用
dfmt	.d	dfmt 命令可用
gleam	.gleam	gleam 命令可用
gofmt	.go	gofmt 命令可用
htmlbeautifier	.erb、.html.erb	htmlbeautifier 命令可用
ktlint	.kt、.kts	ktlint 命令可用
mix	.ex、.exs、.eex、.heex、.leex、.neex、.sface	mix 命令可用
nixfmt	.nix	nixfmt 命令可用
ocamlformat	.ml、.mli	ocamlformat 命令可用且存在 .ocamlformat 配置文件
ormolu	.hs	ormolu 命令可用
oxfmt (实验性)	.js、.jsx、.ts、.tsx	package.json 中存在 oxfmt 依赖，且存在实验性环境变量标志
pint	.php	composer.json 中存在 laravel/pint 依赖
prettier	.js、.jsx、.ts、.tsx、.html、.css、.md、.json、.yaml，以及更多	package.json 中存在 prettier 依赖
rubocop	.rb、.rake、.gemspec、.ru	rubocop 命令可用
ruff	.py、.pyi	带配置的 ruff 命令可用
rustfmt	.rs	rustfmt 命令可用
shfmt	.sh、.bash	shfmt 命令可用
standardrb	.rb、.rake、.gemspec、.ru	standardrb 命令可用
terraform	.tf、.tfvars	terraform 命令可用
uv	.py、.pyi	uv 命令可用
zig	.zig、.zon	zig 命令可用

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

---

工作原理

当 OpenCode 写入或编辑文件时，它会执行以下操作：

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

此过程在后台进行，确保您的代码风格无需任何手动操作即可保持一致。

---

配置

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

opencode.json

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

每个格式化工具配置都支持以下属性：

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

让我们看一些示例。

---

禁用格式化工具

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

opencode.json

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

要禁用特定的格式化工具，请将 disabled 设置为 true

opencode.json

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

---

自定义格式化工具

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

opencode.json

{
  "$schema": "https://opencode.ac.cn/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 占位符将被替换为正在格式化的文件的路径。