Primeiros passos

Instalação

A forma mais rápida de baixar o Biome é usando npm ou o seu package manager favorito. Isso requer o Node.js v14.18 ou mais recente.

O CLI também está disponível como um executável independente caso você queira usar Biome sem instalar o Node.js.

Para instalar o Biome, execute o seguinte comando em um diretório que possua o arquivo package.json.

npm install --save-dev --save-exact @biomejs/biome

yarn add --dev --exact @biomejs/biome

pnpm add --save-dev --save-exact @biomejs/biome

bun add --dev --exact @biomejs/biome

É altamente recomendado não utilizar “range operators” ao instalar o Biome. Dê uma olhada na página de versionamento para mais informações.

Configuração

Recomendamos criar um arquivo de configuração biome.json para cada projeto. Isso elimina a necessidade de repetir as opções do CLI toda vez que você executar um comando e garante que o Biome aplique as mesmas configurações em seu editor. Se você está contente com a configuração padrão, você não precisa fazer isso.

Para criar o arquivo de configuração, use o comando de init dentro da pasta raíz do seu projeto:

npx @biomejs/biome init

yarn biome init

pnpm biome init

bunx @biomejs/biome init

deno run -A npm:@biomejs/biome init

Após utilizar o comando, você terá um novo arquivo biome.json no seu diretório:

{
  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
  "organizeImports": {
    "enabled": false
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  }
}

O linter.enabled: true habilita o linter e o rules.recommended: true habilita as regras recomendadas.

A formatação está ativada porque a configuração não desabilita explicitamente a formatação com formatter.enabled: false.

Como usar

O CLI do Biome vem com vários comandos e opções, então você utiliza só o que precisar.

Você pode formatar arquivos e diretórios usando o comando format com o parâmetro --write:

npx @biomejs/biome format --write <files>

yarn biome format --write <files>

pnpm biome format --write <files>

bunx @biomejs/biome format --write <files>

deno run -A npm:@biomejs/biome format --write <files>

Você pode analisar e aplicar correções seguras em arquivos e diretórios utilizando o comando lint com o parâmetro --apply:

npx @biomejs/biome lint --apply <files>

yarn biome lint --apply <files>

pnpm biome lint --apply <files>

bunx @biomejs/biome lint --apply <files>

deno run -A npm:@biomejs/biome lint --apply <files>

Você pode aplicar ambos com o comando check

npx @biomejs/biome check --apply <files>

yarn biome check --apply <files>

pnpm biome check --apply <files>

bunx @biomejs/biome check --apply <files>

deno run -A npm:@biomejs/biome check --apply <files>

O comando check executa múltiplas ferramentas de uma vez. Até o momento, ele:

formata arquivos
analisa arquivos
organiza as importações

Instale um plugin de editor

Recomendamos instalar um plugin de editor para aproveitar ao máximo o Biome. Dê uma olhada na página de editores para saber qual oferece suporte ao Biome.

Configuração para integração contínua (CI)

Se você está usando Node.js, a forma recomendada de executar o Biome em CI é utilizando o seu package manager favorito. Isso garante que sua pipeline de integração contínua (CI) utilize a mesma versão do Biome que você usa dentro do editor ou ao executar comandos locais pelo CLI.

Próximos passos

Parabéns! Agora você está pronto para utilizar o Biome. 🥳

Saiba mais sobre como usar e configurar o formatter
Saiba mais sobre como usar e configurar o linter
Familiarize-se com as opções do CLI
Familiarize-se com as opções de configuração
Entre na nossa comunidade do Discord