eslint-plugin-oxlint

For older ESLint versions using .eslintrc.js or similar, use the extends property to include the plugin:oxlint/recommended preset.

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

To maximize performance, run oxlint before eslint. This allows oxlint to handle rules that it supports, effectively turning them off in ESLint to avoid redundant work. Add a combined lint script to your package.json.

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

The plugin is optimized for ESLint's Flat Config. You can import the plugin and spread its recommended configuration at the end of your configuration array. It is recommended that oxlint configs are the last ones in the array to ensure they correctly override/disable rules.

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

Install the plugin as a development dependency using pnpm.

pnpm add -D eslint-plugin-oxlint

In Flat Config (ESLint >= 9.0), you can dynamically build your ESLint configuration based on your existing oxlint settings. This ensures that any rule enabled in oxlint is automatically disabled in ESLint.

Use buildFromOxlintConfigFile to point to a .oxlintrc.json file, or buildFromOxlintConfig to pass a configuration object directly.

// eslint.config.js
import oxlint from 'eslint-plugin-oxlint';

// Option 1: From a file
export default [
  ..., // other plugins
  ...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json'),
];

// Option 2: From a config object
export default [
  ..., // other plugins
  ...oxlint.buildFromOxlintConfig({
    categories: {
      correctness: 'warn'
    },
    rules: {
      eqeqeq: 'warn'
    }
  }),
];

Use buildFromOxlintConfigFile to transform an existing .oxlintrc.json file directly into an array of EslintPluginOxlintConfig objects.

If the file cannot be found or parsed, the function returns an empty array [] and emits an error to console.error. This prevents applying incorrect deactivation rules if the configuration state is unknown.

import { buildFromOxlintConfigFile } from 'eslint-plugin-oxlint';

// Path to your .oxlintrc.json file
const configs = buildFromOxlintConfigFile('.oxlintrc.json', { typeAware: true });

If you are using the legacy ESLint configuration format, you can use overrideDisabledRulesForVueAndSvelteFiles to automatically move rules that are incompatible with Vue, Svelte, or Astro files into an overrides block. This prevents these rules from being applied to those specific file types.

This function identifies rules in your top-level rules object that are part of the rulesDisabledForVueAstroAndSvelteFiles set, removes them from the main configuration, and adds them to an override block that excludes *.vue, *.svelte, and *.astro files.

import { overrideDisabledRulesForVueAndSvelteFiles } from 'eslint-plugin-oxlint';

const config = {
  rules: {
    'some-rule': 'error',
    'rule-disabled-for-vue': 'error',
  },
};

const fixedConfig = overrideDisabledRulesForVueAndSvelteFiles(config);

If you have a collection of Flat Config objects (e.g., a configuration map), use splitDisabledRulesForVueAstroAndSvelteFilesDeep to process all of them at once. It iterates through the provided object and applies the splitting logic to each configuration entry, returning a new object where each value is a SplittedFlatConfig tuple.

import { splitDisabledRulesForVueAstroAndSvelteFilesDeep } from 'eslint-plugin-oxlint';

const configs = {
  base: { rules: { 'rule-disabled-for-vue': 'error' } },
  app: { rules: { 'other-rule': 'error' } },
};

const processedConfigs = splitDisabledRulesForVueAstroAndSvelteFilesDeep(configs);
// processedConfigs.base will be [baseConfig, exceptionConfig]
// processedConfigs.app will be [appConfig]

For projects using the ESLint Flat Config format, use splitDisabledRulesForVueAstroAndSvelteFiles to split your configuration into two parts: your original config (with incompatible rules removed) and a new configuration object that explicitly disables those rules for Vue, Svelte, and Astro files using ignores.

This function returns a SplittedFlatConfig, which is a tuple of either [C] (if no rules needed splitting) or [C, FlatConfig] (if rules were moved to a new config object named oxlint/vue-svelte-astro-exceptions).

import { splitDisabledRulesForVueAstroAndSvelteFiles } from 'eslint-plugin-oxlint';

const config = {
  name: 'my-config',
  rules: {
    'some-rule': 'error',
    'rule-disabled-for-vue': 'error',
  },
};

const [originalConfig, exceptionConfig] = splitDisabledRulesForVueAstroAndSvelteFiles(config);

Use buildFromOxlintConfig to transform an OxlintConfig object (the structure used in .oxlintrc.json) into an array of EslintPluginOxlintConfig objects. This is useful for automatically deactivating ESLint rules that are already handled by oxlint, ensuring no duplicate linting occurs.

If config.options.typeAware is set to true and no explicit typeAware option is provided in the options argument, typeAware will be enabled by default.

Returns an array of ESLint configuration objects, which may include a configuration for ignorePatterns if they are defined in the Oxlint config.

import { buildFromOxlintConfig } from 'eslint-plugin-oxlint';

const oxlintConfig = {
  rules: {
    'no-unused-vars': 'error'
  },
  options: {
    typeAware: true
  }
};

const eslintConfigs = buildFromOxlintConfig(oxlintConfig, { typeAware: true });