Primeiros Passos

O Biome é melhor instalado como uma dependência de desenvolvimento dos seus projetos, mas também está disponível como um executável standalone que não requer Node.js.

1
npm i -D -E @biomejs/biome

1
pnpm add -D -E @biomejs/biome

1
bun add -D -E @biomejs/biome

1
deno add -D npm:@biomejs/biome

1
yarn add -D -E @biomejs/biome

Configuração

Embora o Biome possa executar sem configuração alguma, você provavelmente vai querer ajustar algumas configurações para atender às necessidades do seu projeto, e nesse caso você pode executar o seguinte comando para gerar um arquivo de configuração biome.json.

1
npx @biomejs/biome init

1
pnpm exec biome init

1
bunx --bun biome init

1
deno run -A npm:@biomejs/biome init

1
yarn exec biome init

Uso

Vamos ter uma visão geral rápida de como usar o Biome no seu projeto.

Interface de linha de comando

O Biome fornece uma interface de linha de comando para formatar, fazer lint e verificar seu código.

1
# Formatar todos os arquivos
2
npx @biomejs/biome format --write
3

4
# Formatar arquivos específicos
5
npx @biomejs/biome format --write <files>
6

7
# Fazer lint nos arquivos e aplicar correções seguras a todos os arquivos
8
npx @biomejs/biome lint --write
9

10
# Fazer lint nos arquivos e aplicar correções seguras a arquivos específicos
11
npx @biomejs/biome lint --write <files>
12

13
# Formatar, fazer lint e organizar importações de todos os arquivos
14
npx @biomejs/biome check --write
15

16
# Formatar, fazer lint e organizar importações de arquivos específicos
17
npx @biomejs/biome check --write <files>

1
# Formatar todos os arquivos
2
pnpm exec biome format --write
3

4
# Formatar arquivos específicos
5
pnpm exec biome format --write <files>
6

7
# Fazer lint e aplicar correções seguras a todos os arquivos
8
pnpm exec biome lint --write
9

10
# Fazer lint nos arquivos e aplicar correções seguras a arquivos específicos
11
pnpm exec biome lint --write <files>
12

13
# Formatar, fazer lint e organizar importações de todos os arquivos
14
pnpm exec biome check --write
15

16
# Formatar, fazer lint e organizar importações de arquivos específicos
17
pnpm exec biome check --write <files>

1
# Formatar todos os arquivos
2
bunx biome format --write
3

4
# Formatar arquivos específicos
5
bunx biome format --write <files>
6

7
# Fazer lint e aplicar correções seguras a todos os arquivos
8
bunx biome lint --write
9

10
# Fazer lint nos arquivos e aplicar correções seguras a arquivos específicos
11
bunx biome lint --write <files>
12

13
# Formatar, fazer lint e organizar importações de todos os arquivos
14
bunx biome check --write
15

16
# Formatar, fazer lint e organizar importações de arquivos específicos
17
bunx biome check --write <files>

1
# Formatar arquivos específicos
2
deno run -A npm:@biomejs/biome format --write <files>
3

4
# Formatar todos os arquivos
5
deno run -A npm:@biomejs/biome format --write
6

7
# Fazer lint nos arquivos e aplicar correções seguras a todos os arquivos
8
deno run -A npm:@biomejs/biome lint --write
9

10
# Fazer lint nos arquivos e aplicar correções seguras a arquivos específicos
11
deno run -A npm:@biomejs/biome lint --write <files>
12

13
# Formatar, fazer lint e organizar importações de todos os arquivos
14
deno run -A npm:@biomejs/biome check --write
15

16
# Formatar, fazer lint e organizar importações de arquivos específicos
17
deno run -A npm:@biomejs/biome check --write <files>

1
# Formatar todos os arquivos
2
yarn exec biome format --write
3

4
# Formatar arquivos específicos
5
yarn exec biome format --write <files>
6

7
# Fazer lint nos arquivos e aplicar correções seguras a todos os arquivos
8
yarn exec biome lint --write
9

10
# Fazer lint nos arquivos e aplicar correções seguras a arquivos específicos
11
yarn exec biome lint --write <files>
12

13
# Formatar, fazer lint e organizar importações de todos os arquivos
14
yarn exec biome check --write
15

16
# Formatar, fazer lint e organizar importações de arquivos específicos
17
yarn exec biome check --write <files>

Integrações com editores

O Biome está disponível como uma extensão oficial nos seus editores favoritos.

Também existem extensões da comunidade para outros editores, como Vim, Neovim e Sublime Text, para citar alguns.

Integração Contínua

Execute biome ci como parte do seu pipeline de CI para garantir qualidade e consistência do código em toda a sua equipe. Funciona exatamente como o comando biome check, mas é otimizado para ambientes de CI.

Consulte as receitas de Integração Contínua para mais exemplos.

Próximos Passos

Pronto! Agora você está pronto para usar o Biome. 🥳

Migrar do ESLint e Prettier
Aprenda mais sobre como configurar o Biome
Aprenda mais sobre como usar e configurar o formatador
Aprenda mais sobre como usar e configurar o linter
Familiarize-se com os comandos e opções da CLI
Familiarize-se com as opções de configuração
Junte-se à nossa comunidade no Discord