Skip to content

oxc-project/eslint-plugin-oxlint

Repository files navigation

eslint-plugin-oxlint

GitHub Actions Workflow Status NPM Version NPM Downloads

Turn off all rules already supported by oxlint. The rules are extracted from here

What is oxlint?

You can see https://oxc-project.github.io/blog/2023-12-12-announcing-oxlint.html

Installation

pnpm add eslint-plugin-oxlint --D

Usage

Flat config

This plugin is optimized for flat config usage (eslint >= 9.0). See here for more details. Use it like this:

// eslint.config.js
import oxlint from "eslint-plugin-oxlint";
export default [
  ...// other plugins
  oxlint.configs["flat/recommended"], // oxlint should be the last one
];

Legacy config

If you are using legacy configuration (eslint < 9.0), you can use the following config:

// .eslintrc.js
module.exports = {
  ... // other config
  extends: [
    ... // other presets
    "plugin:oxlint/recommended",
  ],
}

Run it before eslint

And then you can add the following script to your package.json:

{
  "scripts": {
    "lint": "npx oxlint && npx eslint"
  }
}

VSCode Support

You need to install both the oxc and eslint extensions

License

MIT