Migracja z ESLint i Prettier

Biome udostępnia dedykowane polecenia ułatwiające migrację z ESLint i Prettier.

Jeśli nie chcesz znać szczegółów, wystarczy uruchomić następujące polecenia:

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

Migracja z ESLint

Wiele reguł lintera Biome jest inspirowanych lub identycznych z regułami ESLint lub regułami wtyczek ESLint. Obsługujemy niektóre wtyczki ESLint, takie jak TypeScript ESLint, ESLint JSX A11y, ESLint React i ESLint Unicorn. Jednak Biome ma własną konwencję nazewnictwa swoich reguł. Biome używa camelCaseRuleName, podczas gdy ESLint używa kebab-case-rule-name. Ponadto Biome często wybiera różne nazwy, aby lepiej oddać intencję swoich reguł. Źródło reguły można znaleźć na stronie opisującej daną regułę. Możesz również znaleźć odpowiednik reguły Biome dla reguły ESLint, korzystając z dedykowanej strony.

Aby ułatwić migrację, Biome udostępnia podpolecenie biome migrate eslint. To podpolecenie odczyta Twoją konfigurację ESLint i spróbuje przenieść jej ustawienia do Biome. Podpolecenie obsługuje zarówno starszą, jak i płaską (flat) konfigurację. Obsługuje pole extends starszej konfiguracji i ładuje zarówno współdzielone, jak i wtyczkowe konfiguracje. W przypadku płaskich plików konfiguracyjnych podpolecenie będzie próbowało wyszukać tylko rozszerzenia JavaScript (js, cjs, mjs) do załadowania w Node.js. Podpolecenie wymaga Node.js do załadowania i rozwiązania wszystkich wtyczek i extends skonfigurowanych w pliku konfiguracyjnym ESLint. Podpolecenie migruje również .eslintignore.

Mając następującą konfigurację 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
}

I następującą konfigurację Biome:

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

Uruchom następujące polecenie, aby zmigrować konfigurację ESLint do 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

Podpolecenie nadpisuje początkową konfigurację Biome. Na przykład wyłącza recommended. W rezultacie otrzymujemy następującą konfigurację 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
}

Na razie biome migrate eslint nie obsługuje konfiguracji zapisanej w YAML.

Domyślnie Biome nie migruje reguł inspirowanych. Możesz użyć flagi CLI --include-inspired, aby je zmigrować.

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

Należy pamiętać, że prawdopodobnie nie uzyskasz dokładnie takiego samego zachowania jak ESLint, ponieważ Biome zdecydowało się nie implementować niektórych opcji reguł lub nieznacznie odchylić od oryginalnej implementacji.

Ponieważ ESLint bierze pod uwagę pliki ignorowania VCS, zalecamy włączenie integracji VCS w Biome.

Migracja z Prettier

Biome stara się jak najdokładniej dopasować do formatera Prettier. Jednak Biome używa innych domyślnych ustawień dla swojego formatera. Na przykład używa tabulatorów do wcięć zamiast spacji. Możesz łatwo zmigrować do Biome, uruchamiając biome migrate prettier --write.

Mając następującą konfigurację Prettier:

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

Uruchom następujące polecenie, aby zmigrować konfigurację Prettier do 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

W rezultacie otrzymujemy następującą konfigurację 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
}

Podpolecenie wymaga Node.js do załadowania konfiguracji JavaScript, takich jak .prettierrc.js. biome migrate prettier nie obsługuje konfiguracji zapisanej w JSON5, TOML lub YAML.

Ponieważ Prettier bierze pod uwagę pliki ignorowania VCS, zalecamy włączenie integracji VCS w Biome.