oxc-project / oxc-project/backlog

move `@oxlint/migrate` npm package to `oxlint`

Open
#190 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-linter
Dominant language
No language data
Stars
7
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Background

@oxlint/migrate is a tool, which converts ESLint flat configuration to an .oxlintrc.json file.
This tool was created when there was no integration between rust and js.

Because oxlint requires node, we could probably detect some command/flag like oxlint migrate or oxlint --migrate and execute the migration script.
Maybe we can even migrate the complete code into rust.

How the script works

It will search for a eslint.config.js file (or similar):
https://github.com/oxc-project/oxlint-migrate/blob/main/bin/config-loader.ts
Execute it:
https://github.com/oxc-project/oxlint-migrate/blob/124a25362f825961c163e8d6dd009617738e6b99/bin/oxlint-migrate.ts#L89-L91
and remaps the object structure to a compatible .oxlintrc.json file.
https://github.com/oxc-project/oxlint-migrate/blob/main/src/index.ts

Why?

  1. Better integration with the supported rules
  2. Maybe faster (because of rust)
  3. No need for users to install another NPM package

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked @oxlint/migrate entry points: bin/config-loader.ts, bin/oxlint-migrate.ts, and src/index.ts, then compare how oxlint currently exposes commands or flags. Done means the migration workflow is integrated with oxlint, converts an ESLint flat configuration into .oxlintrc.json, and no longer requires users to install a separate npm package.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, rust, typescript
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.