We need a package which exports ESLint's built-in rules as a JS plugin which Oxlint users can use.

I propose:

Package

Package name: oxlint-plugin-eslint.
meta.name defined in package: eslint-js
Usage in config:

{
  "jsPlugins": ["oxlint-plugin-eslint"],
  "rules": {
    "eslint-js/unsupported-rule": "error"
  }
}

It's a bit weird that package name and meta.name don't match, but this is a special case, and this is the simplest for users. All other options I can think of are ugly or problematic in one way or another.

How

Package & directories

Add a package directory npm/oxlint-plugin-eslint (modelled on oxlint-plugins).
Add directory apps/oxlint/src-js/plugin-eslint to contain the implementation.

Implementation will be built with TSDown and the dist files copied into npm/oxlint-plugin-eslint.

Implementation

Design goals

All ESLint's rules are included in the package (including the ones which Oxlint already implements natively).
Code for rule is lazy-loaded only when that rule is used.
Avoid including all the rest of ESLint's code in this package. Just the rules themselves.

Reason for including all rules is that users can switch to the JS plugin version of a rule as a "hotfix" if they run into a bug in Oxlint's native version of the rule.

Entry point

apps/oxlint/src-js/plugin-eslint will contain only 1 file:

// apps/oxlint/src-js/plugin-eslint/index.js
import rules from "../generated/plugin-eslint/index.js";

export default {
  meta: {
    name: "eslint-js",
  },
  rules,
};

The whole rest of implementation will be generated.

Build script

Create a script in apps/oxlint/scripts which:

Gets list of all files in ESLint's lib/rules directory (eslint is a dev dependency of apps/oxlint).
For each rule, generates a file in apps/oxlint/src-js/generated/plugin-eslint/rules like:

// apps/oxlint/src-js/generated/plugin-eslint/rules/accessor-pairs.cjs
module.exports = require("eslint/lib/rules/accessor-pairs.js");

Generates entry point of the plugin:

// apps/oxlint/src-js/generated/plugin-eslint/index.js
import { createRequire } from "node:module";
const require = createRequire(import.meta.url);

export default {
  get "accessor-pairs"() { return require("./rules/accessor-pairs.cjs") },
  get "array-bracket-newline"() { return require("./rules/array-bracket-newline.cjs") },
  // ... etc for all rules ...
};

Generates files list for inclusion in TSDown build config:

// apps/oxlint/src-js/generated/plugin-eslint/rule_names.ts
export default [
  "accessor-pairs",
  "array-bracket-newline",
  // ... etc for all rules ...
];

Main build script

Make scripts/build.ts run the sub-build script before running TSDown.

After running TSDown, it should delete the generated/plugin-eslint directory again.

TSDown config

Add to TSDown config a separate config which builds the plugin-eslint directory.

It should use the list of rule names imported from generated rule_names.ts to construct entry property of this config.

The build should be generated in dist-pkg-plugin-eslint directory.

Release workflow

Add to release workflow that it copies contents of dist-pkg-plugin-eslint directory into npm/oxlint-plugin-eslint and bumps the version etc. Copy the workflow for npm/oxlint-plugin.

Uh oh!

linter: introduce oxlint-plugin-eslint #19746

Description

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions

linter: introduce `oxlint-plugin-eslint` #19746