Pular para o conteúdo

Integre o Biome com seu VCS

A integração com VCS (Version Control System) destina-se a aproveitar recursos adicionais que apenas um VCS pode fornecer. No momento, o Biome suporta apenas Git. A integração é opcional. Você precisa habilitar vcs.enabled e definir vcs.clientKind no arquivo de configuração do Biome:

biome.json
{
"vcs": {
"enabled": true,
"clientKind": "git"
}
}

Essa configuração não faz nada por si só. Você precisa optar pelos recursos que deseja.

Habilite vcs.useIgnoreFile para permitir que o Biome ignore todos os arquivos e diretórios listados no arquivo de ignorados do VCS do projeto, bem como um arquivo .ignore.

biome.json
{
"vcs": {
"enabled": true,
"clientKind": "git",
"useIgnoreFile": true
}
}

Este é um recurso que está disponível apenas via CLI e permite processar apenas os arquivos que foram alterados de uma revisão para outra.

Primeiro, você precisa atualizar seu arquivo de configuração e dizer ao Biome qual é o branch padrão através do campo vcs.defaultBranch:

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

Em seguida, adicione a opção --changed ao seu comando, para processar apenas os arquivos que seu VCS reconheceu como “alterados”. O Biome, com a ajuda do VCS, determinará os arquivos alterados a partir do branch main e da sua revisão atual:

Terminal window
biome check --changed

Alternativamente, você pode usar a opção --since para especificar um branch arbitrário. Esta opção tem precedência sobre a opção vcs.defaultBranch. Por exemplo, você pode querer verificar suas alterações em relação ao branch next:

Terminal window
biome check --changed --since=next

Antes de commitar suas alterações, você pode querer verificar a formatação e os lints dos arquivos que foram adicionados ao index, também conhecidos como staged files. Adicione a opção --staged ao seu comando, para processar apenas esses arquivos:

Terminal window
biome check --staged

A opção --staged não está disponível no comando ci porque não se espera que você commite alterações em um ambiente de CI.