格式化工具
Dropstone 使用語言特定的格式化工具。
Dropstone 可以在文件寫入或編輯後使用語言特定的格式化工具來格式化文件。格式化工具預設為禁用；在配置中啟用它們後，Dropstone 才會運行它們。
內置格式化工具
Dropstone 為流行的語言和框架提供了多個內置格式化工具。以下是格式化工具、支持的文件擴展名和所需命令或配置選項的列表。
| 格式化工具 | 擴展名 | 要求 |
|---|---|---|
| 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 命令可用 |
| 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，Dropstone 將對匹配的文件使用 prettier。
工作原理
當 Dropstone 寫入或編輯文件且格式化工具已啟用時，它會：
- 根據所有已啟用的格式化工具檢查文件擴展名。
- 在文件上運行適當的格式化工具命令。
- 應用格式化更改。
此過程在後台針對已啟用的格式化工具進行。
配置
您可以通過 Dropstone 配置中的 formatter 部分來啟用和自定義格式化工具。
要啟用所有內置格式化工具，請將 formatter 設置為 true。
{
"$schema": "https://dropstone.io/schema/config.json",
"formatter": true
}
使用對象來保持內置格式化工具啟用，同時配置覆蓋或自定義格式化工具。
{
"$schema": "https://dropstone.io/schema/config.json",
"formatter": {}
}
每個格式化工具配置支持以下內容：
| 屬性 | 類型 | 描述 |
|---|---|---|
disabled | boolean | 設置為 true 以禁用格式化工具 |
command | string[] | 運行格式化的命令。自定義格式化工具必需；內置格式化工具可選。 |
environment | object | 運行格式化工具時要設置的環境變量 |
extensions | string[] | 此格式化工具應處理的文件擴展名 |
讓我們看一些示例。
禁用格式化工具
如果省略 formatter，所有格式化工具都將被禁用。要在另一個配置啟用它們後禁用所有格式化工具，請將 formatter 設置為 false：
{
"$schema": "https://dropstone.io/schema/config.json",
"formatter": false
}
要禁用特定格式化工具，請將 disabled 設置為 true：
{
"$schema": "https://dropstone.io/schema/config.json",
"formatter": {
"prettier": {
"disabled": true
}
}
}
自定義格式化工具
您可以使用 environment 或 extensions 等選項配置內置格式化工具。要添加自定義格式化工具，請指定 command 和 extensions：
{
"$schema": "https://dropstone.io/schema/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 占位符將被替換為正在格式化的文件的路徑。
Ctrl+I