oxc-project/migrate-oxfmt

migrate-oxfmt 是做什麼的？

將專案從 Prettier 或 Biome 遷移至 Oxfmt 的指南。當被要求遷移、轉換或切換 JavaScript/TypeScript 專案的格式化工具時使用此指南。

簡介

Oxfmt 是 Oxc 工具鏈中的格式化工具，提供快速且與 ESLint 相容的程式碼格式化。本指南將協助你從 Prettier 或 Biome 遷移至 Oxfmt。

遷移步驟

1. 安裝 Oxfmt

使用 npm 或 yarn 安裝 Oxfmt：

npm install --save-dev @oxc-project/oxfmt
# 或
 yarn add --dev @oxc-project/oxfmt

2. 移除舊的格式化工具

卸載 Prettier 或 Biome：

npm uninstall prettier
# 或
npm uninstall @biomejs/biome

3. 設定 Oxfmt

在專案根目錄建立 .oxfmtrc 檔案，或直接在 package.json 中加入 oxfmt 設定區段。

範例 .oxfmtrc：

{
  "indentStyle": "space",
  "indentWidth": 2,
  "lineWidth": 80
}

4. 更新 Scripts

更新 package.json 中的 scripts：

{
  "scripts": {
    "format": "oxfmt --write src/",
    "format:check": "oxfmt --check src/"
  }
}

5. 移除舊的配置檔案

刪除 .prettierrc、prettier.config.js、biome.json 等舊配置檔案。

6. 執行格式化

執行 Oxfmt 重新格式化專案：

npm run format

注意事項

• Oxfmt 預設使用 2 空格縮排和 80 字元行寬，可透過 .oxfmtrc 調整。
• 與 Prettier 的相容性較高，但某些邊際案例可能會有差異，建議遷移後檢查差異。
• 若專案同時使用 ESLint，建議停用與格式化相關的規則，避免衝突。

支援

如遇到問題，請參考 Oxc 專案官方文件 或提交 issue。