将 Biome 集成到你的 VCS

了解如何将 Biome 与 VCS 集成

VCS（版本控制系统）集成旨在利用只有 VCS 才能提供的额外功能。目前，Biome 仅支持 Git。该集成需要主动启用。

你需要在 Biome 配置文件中启用 vcs.enabled 并设置 vcs.clientKind：

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

该配置本身并不做任何事。你需要主动启用自己想要的功能。

启用 vcs.useIgnoreFile，让 Biome 忽略项目 VCS 忽略文件中列出的所有文件和目录，以及 .ignore 文件。

对于 Git 仓库，Biome 会读取 .gitignore 文件以及位于 .git/info/exclude 的 Git 本地排除文件。在关联的工作树（linked worktrees）中，.git/info/exclude 会从公共 Git 目录读取，这与 Git 自身的行为一致。

{
  "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 check --changed

你也可以使用 --since 选项指定任意分支。该选项优先于 vcs.defaultBranch 选项。例如，你可能想针对 next 分支检查自己的更改：

biome check --changed --since=next

在提交更改之前，你可能想在不对整个项目运行 Biome 的情况下，检查已添加到索引（即已暂存文件）中的文件的格式和 Lint。要让 Biome 只处理将要提交的文件，请在命令中传入 --staged 选项：

biome check --staged

--staged 选项在 ci 命令中不可用，因为你通常不会在 CI 期间提交更改。