フォーマッター

OpenCode は言語固有のフォーマッターを使用します。

OpenCode はファイルの書き込みや編集後に、言語固有のフォーマッターを使用して自動的にフォーマットします。これにより、生成されるコードがプロジェクトのコードスタイルに従うことが保証されます。

組み込みフォーマッター

OpenCode には、人気のある言語やフレームワーク用の組み込みフォーマッターが多数含まれています。以下は、フォーマッター、サポートされるファイル拡張子、必要なコマンドまたは設定オプションのリストです。

したがって、プロジェクトの package.json に prettier がある場合、OpenCode は自動的にそれを使用します。

動作の仕組み

OpenCode がファイルを書き込みまたは編集すると：

1. ファイル拡張子をすべての有効なフォーマッターと照合します。
2. ファイルに対して適切なフォーマッターコマンドを実行します。
3. フォーマットの変更を自動的に適用します。

このプロセスはバックグラウンドで行われ、手動の手順なしにコードスタイルが維持されます。

設定

OpenCode 設定の formatter セクションでフォーマッターをカスタマイズできます。

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

各フォーマッター設定は以下をサポートします：

いくつかの例を見てみましょう。

フォーマッターの無効化

すべてのフォーマッターをグローバルに無効にするには、formatter を false に設定します：

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

特定のフォーマッターを無効にするには、disabled を true に設定します：

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

カスタムフォーマッター

コマンド、環境変数、ファイル拡張子を指定して、組み込みフォーマッターをオーバーライドしたり、新しいフォーマッターを追加したりできます：

{
  "$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 プレースホルダーは、フォーマットされるファイルのパスに置き換えられます。