@oxlint/migrate

Generates a .oxlintrc.json from a existing eslint flat config.

Usage

npx @oxlint/migrate <optional-eslint-flat-config-path>

When no config file provided, the script searches for the default eslint config filenames in the current directory.

Options

Options	Description
`--merge`	* merge eslint configuration with an existing .oxlintrc.json configuration
`--with-nursery`	Include oxlint rules which are currently under development
`--output-file <file>`	The oxlint configuration file where to eslint v9 rules will be written to, default: `.oxlintrc.json`

* WARNING: When some categories are enabled, this tools will enable more rules with the combination of plugins. Else we need to disable each rule plugin/categories combination, which is not covered by your eslint configuration. This behavior can change in the future.

User Flow

Upgrade oxlint and @oxlint/migrate to the same version.
Execute npx @oxlint/migrate
(Optional): Disable supported rules via eslint-plugin-oxlint

Contributing

Generate rules

Generates the rules from installed oxlint version

pnpm generate
pnpm format

Unit + Integration Test

pnpm vitest

Manual Testing

pnpm manual-test