从 ESLint 和 Prettier 迁移

Biome 提供了专门的命令来简化从 ESLint 和 Prettier 的迁移过程。

如果你不想了解细节，只需运行以下命令：

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

从 ESLint 迁移

许多 Biome linter 规则的灵感来源于 ESLint 规则或 ESLint 插件的规则，或者与它们完全相同。我们支持一些 ESLint 插件，例如 TypeScript ESLint、ESLint JSX A11y、ESLint React 和 ESLint Unicorn。然而，Biome 对其规则有自己的命名约定。Biome 使用 camelCaseRuleName，而 ESLint 使用 kebab-case-rule-name。此外，Biome 通常会选择使用不同的名称，以更好地传达其规则的意图。规则的来源可以在描述该规则的页面上找到。你也可以使用专门的页面从 ESLint 规则找到等效的 Biome 规则。

为了简化迁移，Biome 提供了 biome migrate eslint 子命令。该子命令将读取你的 ESLint 配置并尝试将其设置移植到 Biome。该子命令能够处理旧版和扁平化（flat）配置文件。它支持旧版配置的 extends 字段，并加载共享配置和插件配置。对于扁平化配置文件，该子命令将尝试仅搜索 JavaScript 扩展名（js、cjs、mjs）以加载到 Node.js 中。该子命令需要 Node.js 来加载和解析 ESLint 配置文件中配置的所有插件和 extends。该子命令还会迁移 .eslintignore。

假设有以下 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
}

以及以下 Biome 配置：

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

运行以下命令将你的 ESLint 配置迁移到 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

该子命令会覆盖你初始的 Biome 配置。例如，它会禁用 recommended。这将生成以下 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
}

目前，biome migrate eslint 不支持以 YAML 格式编写的配置。

默认情况下，Biome 不会迁移受启发的规则。你可以使用 --include-inspired CLI 标志来迁移它们。

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

请注意，你不太可能获得与 ESLint 完全相同的行为，因为 Biome 选择不实现某些规则选项或略微偏离原始实现。

由于 ESLint 会考虑 VCS 忽略文件，我们建议你启用 Biome 的 VCS 集成。

从 Prettier 迁移

Biome 试图尽可能地与 Prettier 格式化程序保持一致。然而，Biome 对其格式化程序使用不同的默认值。例如，它使用制表符（tabs）进行缩进，而不是空格（spaces）。你可以通过运行 biome migrate prettier --write 轻松迁移到 Biome。

假设有以下 Prettier 配置：

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

运行以下命令将你的 Prettier 配置迁移到 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

这将生成以下 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
}

该子命令需要 Node.js 来加载 JavaScript 配置，例如 .prettierrc.js。biome migrate prettier 不支持以 JSON5、TOML 或 YAML 格式编写的配置。

由于 Prettier 会考虑 VCS 忽略文件，我们建议你启用 Biome 的 VCS 集成。