Como o Biome funciona

Configuração

Section titled Configuração

O arquivo de configuração é considerado opcional, o Biome já inclui configurações padrões robustas. Use o arquivo de configuração para alterar essas configurações predefinidas.

O arquivo de configuração do Biome é chamado biome.json e deve ser colocado no diretório raíz do projeto. Geralmente, o diretório raíz é o diretório onde fica o package.json do projeto.

Esse arquivo de configuração habilita o formatador e define o estilo de indentação e seu tamanho, além de desabilitar o linter:

biome.json

{
  "formatter": {
    "enabled": true,
    "indentStyle": "tab",
    "lineWidth": 120
  },
  "linter": {
    "enabled": false
  }
}

Configuração padrão

Section titled Configuração padrão

Quando você executa o comando biome init, ele gera o seguinte arquivo de configuração:

biome.json

{
  "$schema": "https://biomejs.dev/schemas/1.9.1/schema.json",
  "vcs": {
    "enabled": false,
    "clientKind": "git",
    "useIgnoreFile": false
  },
  "files": { "ignoreUnknown": false, "ignore": [] },
  "formatter": { "enabled": true, "indentStyle": "tab" },
  "organizeImports": { "enabled": true },
  "linter": {
    "enabled": true,
    "rules": { "recommended": true }
  },
  "javascript": { "formatter": { "quoteStyle": "double" } }
}

Resolução do arquivo de configuração

Section titled Resolução do arquivo de configuração

O Biome busca de forma automática o arquivo biome.json mais próximo. Ele começa procurando o biome.json no diretório de trabalho atual, e, em seguida, continua procurando nos diretórios pai até:

• Ele achar um arquivo biome.json;
• Ele aplicar a configuração padrão do Biome caso não encontre o arquivo biome.json;

Aqui está um exemplo:

└── app
    ├── backend
    │   ├── package.json
    │   └── biome.json
    └── frontend
        ├── legacy
        │   └── package.json
        ├── new
        │   └── package.json
        └── biome.json

• Comandos do Biome executados no app/backend/package.json utilizarão o arquivo de configuração app/backend/biome.json;
• Comandos do Biome executados no app/frontend/legacy/package.json e app/frontend/new/package.json utilizarão o arquivo de configuração app/frontend/biome.json;

Arquivos ignorados

Section titled Arquivos ignorados

Os seguintes arquivos são ignorados pelo Biome. Isso significa que nenhum diagnóstico será emitido pelo Biome nesses arquivos.

• package.json
• package-lock.json
• npm-shrinkwrap.json
• yarn.lock
• composer.json
• composer.lock
• typescript.json
• tsconfig.json
• jsconfig.json
• deno.json
• deno.jsonc

Os seguintes arquivos são analisados como arquivos JSON com as opções json.parser.allowComments e json.parser.allowTrailingCommas definidas como true. Isso ocorre porque editores, como o VSCode, os tratam dessa maneira.

• tslint.json
• babel.config.json
• .babelrc.json
• .ember-cli
• typedoc.json
• .eslintrc
• .eslintrc.json
• .jsfmtrc
• .jshintrc
• .swcrc
• .hintrc
• .babelrc