Skip to content

Update Oxlint migration guide for changes in @oxlint/migrate. #921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Boshen merged 2 commits into from
Feb 24, 2026
Merged

Update Oxlint migration guide for changes in @oxlint/migrate. #921

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41e8619
Remove section in Migrate page about the init flag, could be confusin…
connorshea Feb 21, 2026
6159034
Update Oxlint migration guide for changes in @oxlint/migrate.
connorshea Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions src/docs/guide/usage/linter/migrate-from-eslint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

This guide is for existing JavaScript and TypeScript projects that currently use ESLint and want to migrate to Oxlint.

If you are starting a new project, or do not need to preserve an existing ESLint configuration, we recommend initializing a fresh Oxlint config instead:

```bash
oxlint --init
```

## Overview

Oxlint and ESLint share similar configuration concepts, but they differ in supported rules and config formats.
Expand Down Expand Up @@ -65,16 +59,12 @@ For further information on Oxlint's type-aware support, see [the Type-Aware Lint

### JavaScript plugins

If your ESLint config uses plugins that are not supported natively by Oxlint, you can retain them using JavaScript plugins.

To migrate ESLint plugins along with the natively-supported plugins, use the `--js-plugins` flag:

```bash
npx @oxlint/migrate --js-plugins
```
If your ESLint config uses plugins that are not supported natively by Oxlint, you can retain them using JavaScript plugins. `@oxlint/migrate` will migrate these plugins for you by default.

This allows you to continue using those rules via Oxlint alongside the native rules/plugins. The JS Plugins functionality does not support all ESLint plugins, but Oxlint's JavaScript plugin system covers a vast majority of the ESLint v9 API and is actively being improved. Most ESLint plugins covering JavaScript/TypeScript code should work in Oxlint without problems.

If you do not want to migrate your ESLint plugins to use as JS Plugins, you can pass `--js-plugins=false`.

For more information on JavaScript Plugins, see [the JS Plugins page](/docs/guide/usage/linter/js-plugins).

#### Local custom ESLint plugins
Expand Down