Migre do ESLint e Prettier

O Biome fornece comandos dedicados para facilitar a migração do ESLint e do Prettier.

Se você não quiser saber os detalhes, apenas execute os seguintes comandos:

1
biome migrate eslint --write
2
biome migrate prettier --write

Migre do ESLint

Muitas regras do linter do Biome são inspiradas ou idênticas às regras do ESLint ou às regras de um plugin do ESLint. Lidamos com alguns plugins do ESLint, como TypeScript ESLint, ESLint JSX A11y, ESLint React e ESLint Unicorn. No entanto, o Biome tem sua própria convenção de nomenclatura para suas regras. O Biome usa camelCaseRuleName enquanto o ESLint usa kebab-case-rule-name. Além disso, o Biome muitas vezes optou por usar nomes diferentes para transmitir melhor a intenção de suas regras. A fonte de uma regra pode ser encontrada na página que descreve a regra. Você também pode encontrar a regra equivalente do Biome a partir de uma regra do ESLint usando a página dedicada.

Para facilitar a migração, o Biome fornece o subcomando biome migrate eslint. Este subcomando lerá sua configuração do ESLint e tentará portar suas configurações para o Biome. O subcomando é capaz de lidar com os arquivos de configuração legacy e flat. Ele suporta o campo extends da configuração legacy e carrega tanto as configurações compartilhadas quanto as de plugins. Para arquivos de configuração flat, o subcomando tentará procurar apenas por extensões JavaScript (js, cjs, mjs) para serem carregadas no Node.js. O subcomando precisa do Node.js para carregar e resolver todos os plugins e extends configurados no arquivo de configuração do ESLint. O subcomando também migra o .eslintignore.

Dada a seguinte configuração do ESLint:

1
{
2
  "extends": ["plugin:unicorn/recommended"],
3
  "plugins": ["unicorn"],
4
  "ignore_patterns": ["dist/**"],
5
  "globals": {
6
    "Global1": "readonly"
7
  },
8
  "rules": {
9
    "eqeqeq": "error"
10
  },
11
  "overrides": [
12
    {
13
      "files": ["tests/**"],
14
      "rules": {
15
        "eqeqeq": "off"
16
      }
17
    }
18
  ]
19
}

E a seguinte configuração do Biome:

1
{
2
  "linter": {
3
    "enabled": true,
4
    "rules": {
5
      "recommended": true
6
    }
7
  }
8
}

Execute o seguinte comando para migrar sua configuração do ESLint para o Biome.

1
npx @biomejs/biome migrate eslint --write

1
pnpm exec biome migrate eslint --write

1
bunx --bun biome migrate eslint --write

1
deno run -A npm:@biomejs/biome migrate eslint --write

1
yarn exec biome migrate eslint --write

O subcomando sobrescreve sua configuração inicial do Biome. Por exemplo, ele desativa recommended. Isso resulta na seguinte configuração do Biome:

1
{
2
  "organizeImports": { "enabled": true },
3
  "linter": {
4
    "enabled": true,
5
    "rules": {
6
      "recommended": false,
7
      "complexity": {
8
        "noForEach": "error",
9
        "noStaticOnlyClass": "error",
10
        "noUselessSwitchCase": "error",
11
        "useFlatMap": "error"
12
      },
13
      "style": {
14
        "noNegationElse": "off",
15
        "useForOf": "error",
16
        "useNodejsImportProtocol": "error",
17
        "useNumberNamespace": "error"
18
      },
19
      "suspicious": {
20
        "noDoubleEquals": "error",
21
        "noThenProperty": "error",
22
        "useIsArray": "error"
23
      }
24
    }
25
  },
26
  "javascript": { "globals": ["Global1"] },
27
  "overrides": [
28
    {
29
      "include": ["tests/**"],
30
      "linter": { "rules": { "suspicious": { "noDoubleEquals": "off" } } }
31
    }
32
  ]
33
}

Por enquanto, o biome migrate eslint não suporta configurações escritas em YAML.

Por padrão, o Biome não migra regras inspiradas. Você pode usar a flag da CLI --include-inspired para migrá-las.

1
npx @biomejs/biome migrate eslint --write --include-inspired

1
pnpm exec biome migrate eslint --write --include-inspired

1
bunx --bun biome migrate eslint --write --include-inspired

1
deno run -A npm:@biomejs/biome migrate eslint --write --include-inspired

1
yarn exec biome migrate eslint --write --include-inspired

Note que é improvável que você obtenha exatamente o mesmo comportamento do ESLint, porque o Biome optou por não implementar algumas opções de regras ou por se desviar ligeiramente da implementação original.

Como o ESLint leva em consideração os arquivos de ignorados do VCS, recomendamos que você habilite a integração com VCS do Biome.

Migre do Prettier

O Biome tenta corresponder ao formatador do Prettier o mais próximo possível. No entanto, o Biome usa padrões diferentes para seu formatador. Por exemplo, ele usa tabs para indentação em vez de espaços. Você pode migrar facilmente para o Biome executando biome migrate prettier --write.

Dada a seguinte configuração do Prettier:

1
{
2
  "useTabs": false,
3
  "singleQuote": true,
4
  "overrides": [
5
    {
6
          "files": ["*.json"],
7
          "options": { "tabWidth": 2 }
8
      }
9
  ]
10
}

Execute o seguinte comando para migrar sua configuração do Prettier para o Biome.

1
npx @biomejs/biome migrate prettier --write

1
pnpm exec biome migrate prettier --write

1
bunx --bun biome migrate prettier --write

1
deno run -A npm:@biomejs/biome migrate prettier --write

1
yarn exec biome migrate prettier --write

Isso resulta na seguinte configuração do Biome:

1
{
2
  "formatter": {
3
    "enabled": true,
4
    "formatWithErrors": false,
5
    "indentStyle": "space",
6
    "indentWidth": 2,
7
    "lineEnding": "lf",
8
    "lineWidth": 80,
9
    "attributePosition": "auto"
10
  },
11
  "organizeImports": { "enabled": true },
12
  "linter": { "enabled": true, "rules": { "recommended": true } },
13
  "javascript": {
14
    "formatter": {
15
      "jsxQuoteStyle": "double",
16
      "quoteProperties": "asNeeded",
17
      "trailingCommas": "all",
18
      "semicolons": "asNeeded",
19
      "arrowParentheses": "always",
20
      "bracketSpacing": true,
21
      "bracketSameLine": false,
22
      "quoteStyle": "single",
23
      "attributePosition": "auto"
24
    }
25
  },
26
  "overrides": [
27
    {
28
      "include": ["*.json"],
29
      "formatter": {
30
        "indentWidth": 2
31
      }
32
    }
33
  ]
34
}

O subcomando precisa do Node.js para carregar configurações JavaScript como .prettierrc.js. biome migrate prettier não suporta configurações escritas em JSON5, TOML ou YAML.

Como o Prettier leva em consideração os arquivos de ignorados do VCS, recomendamos que você habilite a integração com VCS do Biome.