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.

Installation

``shell
pnpm add -D eslint-plugin-oxlint
`

Usage

$3

Add the following script to your package.json:

`json
{
"scripts": {
"lint": "oxlint && eslint"
}
}
`

$3

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

Example:

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

$3

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

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

$3

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

`js
// eslint.config.js
import oxlint from 'eslint-plugin-oxlint';
export default [
..., // other plugins
...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json'),
];
`

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

`js
// eslint.config.js
import oxlint from 'eslint-plugin-oxlint';
export default [
..., // other plugins
...oxlint.buildFromOxlintConfig({
categories: {
correctness: 'warn'
},
rules: {
eqeqeq: 'warn'
}
}),
];
`

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

All Configs

`js
configs: {
// recommended only contains the correctness category
recommended: { plugins: [Array], rules: [Object] },
'flat/recommended': { rules: [Object] },

// all rules available
all: { plugins: [Array], rules: [Object] },
'flat/all': { rules: [Object] },

// turn eslint rules off by plugin
'flat/eslint': { rules: [Object] },
'flat/import': { rules: [Object] },
'flat/jest': { rules: [Object] },
'flat/jsdoc': { rules: [Object] },
'flat/jsx-a11y': { rules: [Object] },
'flat/nextjs': { rules: [Object] },
'flat/react': { rules: [Object] },
'flat/react-perf': { rules: [Object] },
'flat/tree-shaking': { rules: [Object] },
'flat/typescript': { rules: [Object] },
'flat/unicorn': { rules: [Object] },

// turn eslint rules off by oxlint category
'flat/pedantic': { rules: [Object] },
'flat/style': { rules: [Object] },
'flat/correctness': { rules: [Object] },
'flat/restriction': { rules: [Object] },
'flat/suspicious': { rules: [Object] }
}
``