eslint-plugin-oxlint-x

English | 中文

Runs Oxlint as an ESLint rule. This allows you to integrate Oxlint's fast linting capabilities directly into your ESLint workflow, including support for eslint --fix.

Features

• Integration: Runs oxlint as a standard ESLint rule.
• Auto-fix: Supports eslint --fix to automatically apply Oxlint fixes.
• Configuration: Supports .oxlintrc.json configuration files and ESLint rule options.
• Performance: Leverages Oxlint's speed for heavy lifting linting tasks.

Installation

npm install eslint-plugin-oxlint-x oxlint -D
# or
pnpm add eslint-plugin-oxlint-x oxlint -D
# or
yarn add eslint-plugin-oxlint-x oxlint -D

Usage

Flat Config (ESLint v9+)

import oxlintPlugin from 'eslint-plugin-oxlint-x';

export default [
  {
    plugins: {
      'oxlint-x': oxlintPlugin,
    },
    rules: {
      // Priority is higher than auto-reading .oxlintrc.json, can override .oxlintrc.json configuration
      'oxlint-x/oxlint': ['error', {
        // oxlint config
      }], 
    },
  },
];

Auto-read Configuration

{
  "plugins": ["oxlint-x"],
  "rules": {
    // Automatically reads and uses .oxlintrc.json configuration
    "oxlint-x/oxlint": "warn"
  }
}