-
-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve guides, add 'Migrate from' page
- Loading branch information
Showing
12 changed files
with
283 additions
and
117 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| --- | ||
| title: Migrate from ESLint and Prettier | ||
| description: Learn how you can ease your migration from ESLint and Prettier | ||
| --- | ||
|
|
||
| import PackageManagerBiomeCommand from "@/components/PackageManagerBiomeCommand.astro"; | ||
|
|
||
| Biome provides dedicated commands to ease the migration from ESLint and Prettier. | ||
|
|
||
| ## Migrate from ESLint | ||
|
|
||
| Many Biome linter rules are inspired by or identical to the ESLint rules or the rules of an ESLint plugin. | ||
| We handle some ESLint plugins such as [TypeScript ESLint](https://typescript-eslint.io/), [ESLint JSX A11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y), [ESLint React](https://github.com/jsx-eslint/eslint-plugin-react), and [ESLint Unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn). | ||
| However, Biome has its own naming convention for its rules. | ||
| Biome uses `camelCaseRuleName` while ESLint uses `kebab-case-rule-name`. | ||
| Moreover, Biome has often chosen to use different names to better convey the intent of its rules. | ||
| The source of a rule can be found on the page describing the rule. | ||
| You can also find the equivalent Biome rule from an ESLint rule using the [dedicated page](/linter/rules-sources). | ||
|
|
||
| To ease the migration, Biome provides the `biome migrate eslint` subcommand. | ||
| This subcommand will read your ESLint configuration and attempt to port its settings to Biome. | ||
| The subcommand is able to handle both the legacy and the flat configuration files. | ||
| It supports the `extends` field of the legacy configuration and loads both shared and plugin configurations. | ||
| The subcommand also migrates `.eslintignore`. | ||
|
|
||
| Given the following ESLint configuration: | ||
|
|
||
| ```json title=".eslintrc.json" | ||
| { | ||
| "extends": ["plugin:unicorn/recommended"], | ||
| "plugins": ["unicorn"], | ||
| "ignore_patterns": ["dist/**"], | ||
| "globals": { | ||
| "Global1": "readonly" | ||
| }, | ||
| "rules": { | ||
| "eqeqeq": "error" | ||
| }, | ||
| "overrides": [ | ||
| { | ||
| "files": ["tests/**"], | ||
| "rules": { | ||
| "eqeqeq": "off" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| And the following Biome configuration: | ||
|
|
||
| ```json title="biome.json" | ||
| { | ||
| "linter": { | ||
| "enabled": true, | ||
| "rules": { | ||
| "recommended": true | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Run the following command to migrate your ESLint configuration to Biome. | ||
|
|
||
| <PackageManagerBiomeCommand command="migrate eslint --write"/> | ||
|
|
||
| The subcommand overwrites your initial Biome configuration. | ||
| For example, it disables `recommended`. | ||
| This results in the following Biome configuration: | ||
|
|
||
| ```json title="biome.json" | ||
| { | ||
| "organizeImports": { "enabled": true }, | ||
| "linter": { | ||
| "enabled": true, | ||
| "rules": { | ||
| "recommended": false, | ||
| "complexity": { | ||
| "noForEach": "error", | ||
| "noStaticOnlyClass": "error", | ||
| "noUselessSwitchCase": "error", | ||
| "useFlatMap": "error" | ||
| }, | ||
| "style": { | ||
| "noNegationElse": "off", | ||
| "useForOf": "error", | ||
| "useNodejsImportProtocol": "error", | ||
| "useNumberNamespace": "error" | ||
| }, | ||
| "suspicious": { | ||
| "noDoubleEquals": "error", | ||
| "noThenProperty": "error", | ||
| "useIsArray": "error" | ||
| } | ||
| } | ||
| }, | ||
| "javascript": { "globals": ["Global1"] }, | ||
| "overrides": [ | ||
| { | ||
| "include": ["tests/**"], | ||
| "linter": { "rules": { "suspicious": { "noDoubleEquals": "off" } } } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| The subcommand needs Node.js to load and resolve all the plugins and `extends` configured in the ESLint configuration file. | ||
| For now, `biome migrate eslint` doesn't support configuration written in YAML. | ||
|
|
||
| By default, Biome doesn't migrate inspired rules. | ||
| You can use the CLI flag `--include-inspired` to migrate them. | ||
|
|
||
| <PackageManagerBiomeCommand command="migrate eslint --write --include-inspired"/> | ||
|
|
||
| Note that you are unlikely to get exactly the same behavior as ESLint because Biome has chosen not to implement some rule options or to deviate slightly from the original implementation. | ||
|
|
||
| Since ESLint takes VCS ignore files into account, | ||
| we recommend that you enable Biome's [VCS integration](/guides/integrate-in-vcs). | ||
|
|
||
| :::caution | ||
| Some plugins or shared configurations may export an object with a cyclic reference. | ||
| Biome may fail to load such a configuration. | ||
| ::: | ||
|
|
||
| ## Migrate from Prettier | ||
|
|
||
| Biome tries to match the Prettier formatter as closely as possible. | ||
| However, Biome uses different defaults for its formatter. | ||
| For example, it uses tabs for indentation instead of spaces. | ||
| You can easily migrate to Biome by running `biome migrate prettier --write`. | ||
|
|
||
| Given the following Prettier configuration: | ||
|
|
||
| ```json title=".prettierrc.json" | ||
| { | ||
| "useTabs": false, | ||
| "singleQuote": true, | ||
| "overrides": [ | ||
| { | ||
| "files": ["*.json"], | ||
| "options": { "tabWidth": 2 } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Run the following command to migrate your Prettier configuration to Biome. | ||
|
|
||
| <PackageManagerBiomeCommand command="migrate prettier --write"/> | ||
|
|
||
| This results in the following Biome configuration: | ||
|
|
||
| ```json title="biome.json" | ||
| { | ||
| "formatter": { | ||
| "enabled": true, | ||
| "formatWithErrors": false, | ||
| "indentStyle": "space", | ||
| "indentWidth": 2, | ||
| "lineEnding": "lf", | ||
| "lineWidth": 80, | ||
| "attributePosition": "auto" | ||
| }, | ||
| "organizeImports": { "enabled": true }, | ||
| "linter": { "enabled": true, "rules": { "recommended": true } }, | ||
| "javascript": { | ||
| "formatter": { | ||
| "jsxQuoteStyle": "double", | ||
| "quoteProperties": "asNeeded", | ||
| "trailingComma": "all", | ||
| "semicolons": "asNeeded", | ||
| "arrowParentheses": "always", | ||
| "bracketSpacing": true, | ||
| "bracketSameLine": false, | ||
| "quoteStyle": "single", | ||
| "attributePosition": "auto" | ||
| } | ||
| }, | ||
| "overrides": [ | ||
| { | ||
| "include": ["*.json"], | ||
| "formatter": { | ||
| "indentWidth": 2 | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| The subcommand needs Node.js to load JavaScript configurations such as `.prettierrc.js`. | ||
| `biome migrate prettier` doesn't support configuration written in JSON5, TOML, or YAML. | ||
|
|
||
| Since Prettier takes VCS ignore files into account, | ||
| we recommend that you enable Biome's [VCS integration](/guides/integrate-in-vcs). |
Oops, something went wrong.