eslint-plugin-oxlint

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

What is oxlint?

See https://oxc.rs/blog/2023-12-12-announcing-oxlint.html

Installation

1pnpm add eslint-plugin-oxlint -D

Usage

Run oxlint before eslint

Add the following script to your package.json:

1{
2  "scripts": {
3    "lint": "npx oxlint && npx eslint"
4  }
5}

Flat config

This plugin is optimized for flat config usage (eslint >= 9.0). See here for more details.

Example:

1// eslint.config.js
2import oxlint from 'eslint-plugin-oxlint';
3export default [
4  ...// other plugins
5  ...oxlint.configs['flat/recommended'], // oxlint should be the last one
6];

Legacy config

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

1// .eslintrc.js
2module.exports = {
3  ... // other config
4  extends: [
5    ... // other presets
6    "plugin:oxlint/recommended",
7  ],
8}

Detect rules from .oxlintrc.json

If you are using flat configuration (eslint >= 9.0), you can use the following config:

1// eslint.config.js
2import oxlint from 'eslint-plugin-oxlint';
3export default [
4  ..., // other plugins
5  ...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json'),
6];

Or build it by an .oxlintrc.json-like object:

1// eslint.config.js
2import oxlint from 'eslint-plugin-oxlint';
3export default [
4  ..., // other plugins
5  ...oxlint.buildFromOxlintConfig({
6    categories: {
7      correctness: 'warn'
8    },
9    rules: {
10      eqeqeq: 'warn'
11    }
12  }),
13];

buildFromOxlintConfigFile is not supported for legacy configuration (eslint < 9.0).

All Configs

1  configs: {
2    // recommended only contains the `correctness` category
3    recommended: { plugins: [Array], rules: [Object] },
4    'flat/recommended': { rules: [Object] },
5
6    // all rules available
7    all: { plugins: [Array], rules: [Object] },
8    'flat/all': { rules: [Object] },
9
10    // turn eslint rules off by plugin
11    'flat/eslint': { rules: [Object] },
12    'flat/import': { rules: [Object] },
13    'flat/jest': { rules: [Object] },
14    'flat/jsdoc': { rules: [Object] },
15    'flat/jsx-a11y': { rules: [Object] },
16    'flat/nextjs': { rules: [Object] },
17    'flat/react': { rules: [Object] },
18    'flat/react-perf': { rules: [Object] },
19    'flat/tree-shaking': { rules: [Object] },
20    'flat/typescript': { rules: [Object] },
21    'flat/unicorn': { rules: [Object] },
22
23    // turn eslint rules off by oxlint category
24    'flat/pedantic': { rules: [Object] },
25    'flat/style': { rules: [Object] },
26    'flat/correctness': { rules: [Object] },
27    'flat/restriction': { rules: [Object] },
28    'flat/suspicious': { rules: [Object] }
29  }

VSCode Support

You need to install both the oxc and eslint extensions

Contributing

Generate rules

Generates the rules from installed oxlint version

1pnpm generate
2pnpm format

Test

Tests the source code

1pnpm test

License

MIT