Formatador

O Biome é uma ferramenta de formatação com convicções fortes que tem o objetivo de acabar com os contínuos debates sobre estilo de código. Ele segue uma filosofia semelhante à do Prettier (link em inglês), dando suporte a apenas algumas opções para evitar que debates sobre estilos se tornem debates sobre as opções de configuração do Biome. Ele deliberadamente resiste ao afã de adicionar novas opções para evitar discussões triviais nas equipes, para que elas possam se concentrar no que realmente importa.

Opções

Section titled Opções

As opções, agnósticas da linguagem, suportadas pelo Biome são:

• estilo de indentação (padrão: tab): Use espaços ou tabulações para a indentação
• largura da tabulação (padrão: 2): O número de espaços por nível de indentação
• comprimento de linha (padrão: 80): Número de colunas máximo a partir do qual Biome quebra a linha

Outras opções de formatação também estão disponíveis para linguagens específicas. Consulte as opções de configuração para obter detalhes.

Use o formatador com a linha de comando

Section titled Use o formatador com a linha de comando

Por padrão, o formatador verifica o código e emite diagnósticos se houver alterações na formatação:

npm

npx @biomejs/biome format ./src

yarn

yarn biome format ./src

pnpm

pnpm biome format ./src

bun

bunx @biomejs/biome format ./src

deno

deno run -A npm:@biomejs/biome format ./src

Se você quiser aplicar a nova formatação, passe a opção --write:

npm

npx @biomejs/biome format --write ./src

yarn

yarn biome format --write ./src

pnpm

pnpm biome format --write ./src

bun

bunx @biomejs/biome format --write ./src

deno

deno run -A npm:@biomejs/biome format --write ./src

Use a flag --help para saber quais são as opções disponíveis:

npm

npx @biomejs/biome format --help

yarn

yarn biome format --help

pnpm

pnpm biome format --help

bun

bunx @biomejs/biome format --help

deno

deno run -A npm:@biomejs/biome format --help

Ou confira a seção de referência da linha de comando.

Configuração

Section titled Configuração

Você pode querer configurar o Biome usando biome.json. Os seguintes padrões são aplicados:

biome.json

{
  "formatter": {
    "enabled": true,
    "formatWithErrors": false,
    "ignore": [],
    "attributePosition": "auto",
    "indentStyle": "tab",
    "indentWidth": 2,
    "lineEnding": "lf",
    "lineWidth": 80
  },
  "javascript": {
    "formatter": {
      "arrowParentheses":"always",
      "bracketSameLine": false,
      "bracketSpacing": true,
      "jsxQuoteStyle": "double",
      "quoteProperties": "asNeeded",
      "semicolons": "always",
      "trailingComma": "all"
    }
  },
  "json": {
    "formatter": {
      "trailingCommas": "none"
    }
  }
}

Ignorando Código

Section titled Ignorando Código

Há ocasiões em que o código formatado não é ideal.

Para esses casos, você pode usar um comentário de supressão de formatação:

example.js

// biome-ignore format: <explicação>

Exemplo:

example.js

const expr =
  // biome-ignore format: este array não deve ser formatado
  [
    (2 * n) / (r - l),
    0,
    (r + l) / (r - l),
    0,
    0,
    (2 * n) / (t - b),
    (t + b) / (t - b),
    0,
    0,
    0,
    -(f + n) / (f - n),
    -(2 * f * n) / (f - n),
    0,
    0,
    -1,
    0,
  ];