Biome をあなたの VCS と統合する

VCS (バージョン管理システム）の統合は、追加の機能を活用することを目的としており、VCSでしか提供できない機能を利用して開発体験をさらにカスタマイズできるようになります。

この統合は opt-in であり、2つの必須フィールドが必要です。vcs.enabled フィールドと vcs.clientKind フィールドです。

{
  "vcs": {
    "enabled": true,
    "clientKind": "git"
  }
}

この設定自体は、何も行いません。新機能を opt-in する必要があります。

この機能では、Biome が VCS において、指定されたすべてのファイルとフォルダを無視することができます。これは opt-in 機能であり、vcs.useIgnoreFile フィールドを有効にする必要があります。

{
  "vcs": {
    "enabled": true,
    "clientKind": "git",
    "useIgnoreFile": true
  }
}

この機能は CLI でのみ利用可能で、特定のリビジョン間で変更されたファイルのみを処理できます。

設定ファイルを更新し、vcs.defaultBranch フィールドでデフォルトのブランチを Biome に伝える必要があります。

{
  "vcs": {
    "enabled": true,
    "clientKind": "git",
    "useIgnoreFile": true,
    "defaultBranch": "main"
  }
}

次に、コマンドに --changed オプションを追加すると、VCS が”変更された”と認識したファイルのみを処理します。Biome は、VCS の助けを借りて、main ブランチと現在のリビジョンからの変更ファイルを判断します。

biome format --changed

あるいは、--since オプションを使って任意のブランチを指定することもできます。このオプションは vcs.defaultBranch オプションよりも優先されます。例えば、変更を next ブランチと比較したい場合は次のようにします。

biome format --changed --since=next

変更をコミットする前に、インデックス に追加されたファイル、つまり ステージされたファイル のformatやlintをチェックしたい場合があります。コマンドに --staged オプションを追加して、ステージされたファイルのみを処理できます：

biome check --staged

CI環境では変更をコミットすることは想定されていないため、ci コマンドに --staged オプションは使用できません。