Integrando o Biome no seu editor

Plugins oficiais

Section titled Plugins oficiais

Esse são plugins mantidos pela equipe do Biome e fazem parte da organização Biome.

VS Code

Section titled VS Code

A integração do Biome com o VSCode permite você:

• Formatar arquivos ao salvar ou ao executar o comando de formatação.
• Lintar arquivos e aplicar correções de código.

Instale nossa extensão oficial do Biome para o VSCode no Visual Studio Marketplace.

Para tornar o Biome o formatador padrão, abra um arquivo suportado e:

• Abra a Paleta de Comandos (Command Pallete) (View ou Ctrl/⌘+⇧+P)
• Selecione Formatar documento com… (Format Document With…)
• Selecione Configurar o formatador padrão (Configure Default Formatter)
• Selecione Biome.

IntelliJ

Section titled IntelliJ

Para instalar o plugin Biome no IntelliJ, acesse a página oficial do plugin ou siga esses passos:

IDEs da JetBrains:

1. Abra o IntelliJ IDEA.
2. Acesse as Configurações/Preferências.
3. Selecione Plugins no menu à esquerda.
4. Clique na guia Marketplace.
5. Pesquise por “Biome” e clique no botão Instalar.
6. Reinicie a IDE para ativar o plugin.

Instalação local:

1. Baixe o arquivo .zip do plugin na seção Releases no GitHub.
2. Aperte ⌘Сmd para abrir as configurações da IDE e então selecione Plugins.
3. Na página de Plugins, clique no botão de Configurações e, em seguida, clique em Instalar Plugin do Disco….

Plugins de terceiros

Section titled Plugins de terceiros

Esses são plugins mantidos por outras comunidades, que você instala em seu editor:

• neovim: você vai precisar instalar o nvim-lspconfig, e seguir essas instruções;
• helix: siga as instruções desse manual
• coc-biome: extensão Biome para coc.nvim
• sublime text: siga as instruções de instalação do LSP-biome

Note

Existe um plugin para um editor que não está listado aqui? Por favor, abra um Pull Request e ficaremos felizes em adicioná-lo à lista.

Escrevendo o seu plugin

Section titled Escrevendo o seu plugin

O Biome tem suporte de primeira classe para LSP. Se o seu editor implementa o LSP, a integração do Biome deve ser tranquila.

Usando a proxy do LSP (Language Server Protocol)

Section titled Usando a proxy do LSP (Language Server Protocol)

O Biome tem um comando chamado lsp-proxy. Quando executado, ele vai inicializar dois processos:

• Um daemon que executa as operações solicitadas;
• Um servidor que funciona como um proxy entre as requisições do cliente - do editor - e do servidor - o daemon;

Se o seu editor for capaz de interagir com o servidor e enviar requisições JSON-RPC, você só precisa configurar o editor para executar esse comando.

Você pode conferir como o neo-vim biome plugin faz isso.

Usando stdin (entrada padrão)

Section titled Usando stdin (entrada padrão)

Se o seu editor não suporta LSP, você pode usar o binário biome diretamente e chamá-lo usando entrada padrão.

Os seguintes comandos podem ser executados via entrada padrão:

• format
• lint
• check

O Biome retornará a nova saída (ou a saída original se não houverem ocorrido alterações) para a saída padrão e os diagnósticos para o erro padrão.

Quando você usa o stdin, é necessário passar o parâmetro --stdin-file-path. O caminho do arquivo não precisa existir e pode ter qualquer nome. O importante é fornecer a extensão do arquivo correta para que o Biome saiba como tratar o seu arquivo.

É responsabilidade do editor localizar e resolver o caminho do binário e, em seguida, chamá-lo quando necessário. Os binários são distribuídos via npm com base nas arquiteturas e sistemas operacionais que suportamos:

• @biomejs/cli-darwin-arm64
• @biomejs/cli-darwin-x64
• @biomejs/cli-linux-arm64
• @biomejs/cli-linux-x64
• @biomejs/cli-win32-arm64
• @biomejs/cli-win32-x64

O nome do binário é biome ou biome.exe, e ele pode ser encontrado no diretório raiz da biblioteca, por exemplo: @biomejs/cli-darwin-arm64/biome, @biomejs/cli-win32-x64/biome.exe.

Usando o daemon com o binário

Section titled Usando o daemon com o binário

Usar o binário via CLI é muito eficiente, embora você não seja capaz de fornecer logs para seus usuários. A CLI permite que você inicialize um daemon e, em seguida, use os comandos da CLI por meio do próprio daemon. Para fazer isso, primeiro você precisa iniciar um daemon com o comando start:

biome start

Em seguida, todo comando precisa adicionar a opção --use-server, por exemplo:

echo "console.log('')" | biome format --use-server --stdin-file-path=dummy.js

Note

Se decidir usar o daemon, você também é responsável por reiniciar/encerrar o processo com o comando stop para evitar processos fantasmas.

Caution

As operações por meio do daemon são significativamente mais lentas do que a CLI em si, portanto, é aconselhável executar operações apenas em arquivos individuais.

Logs do daemon

Section titled Logs do daemon

O daemon do Biome salva logs em seu sistema de arquivos. Os logs são armazenados em uma pasta chamada biome-logs. Você pode encontrar esta pasta no diretório temporário do seu sistema operacional.

No Windows, usando o PowerShell:

$env:TEMP

No Linux/macOS, usando um terminal:

echo $TMPDIR

Os arquivos de log são rotacionados a cada hora.