eslint-plugin-oxlint - GitLite

KO | EN

gitlite — search

#open-source #cloud-native #php #editor #macos #security #shell #github #graphql #database

eslint-plugin-oxlint

(★ 452)

Turn off all rules already supported by oxlint

File Explorer

ZIP Download

- - build.yml
  - bump_oxlint.yml
  - generate.yml
  - release.yml
  - security.yml
  - test.yml
- renovate.json
- SECURITY.md
- pre-commit
- extensions.json
- settings.json
- - rules-generator.spec.ts.snap
- config-generator.ts
- constants.ts
- generate.ts
- rules-generator.spec.ts
- rules-generator.ts
- traverse-rules.ts
- - configs.spec.ts.snap
- - categories.spec.ts
  - categories.ts
  - extends.spec.ts
  - extends.ts
  - ignore-patterns.spec.ts
  - ignore-patterns.ts
  - index.ts
  - overrides.spec.ts
  - overrides.ts
  - plugins.ts
  - rules.spec.ts
  - rules.ts
  - types.ts
  - utilities.ts
- - configs-by-category.ts
  - configs-by-scope.ts
  - rules-by-category.ts
  - rules-by-scope.ts
- build-from-oxlint-config.spec.ts
- config-helper.spec.ts
- config-helper.ts
- configs.spec.ts
- configs.ts
- constants.ts
- index.ts
- helpers.ts
.gitignore
.mise.toml
.node-version
.prettierignore
AGENTS.md
CONTRIBUTING.md
LICENSE
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
tsconfig.json
vite.config.ts

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`pnpm`

View Details ▼

Fast, disk space efficient package manager for Node.js.
Manage Node.js projects and their module dependencies.

pnpm init

Create a `package.json` file:

pnpm {{[i|install]}}

Download all the packages listed as dependencies in `package.json`:

pnpm add {{module_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

# Project Badges

GitHub Actions Workflow Status
NPM Version
NPM Downloads

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Turn off all rules already supported by [`oxlint`](https://oxc.rs/docs/guide/usage/linter). The rules are extracted from [here](https://github.com/oxc-project/oxc/blob/main/crates/oxc_linter/src/rules.rs).

## Installation

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

## Usage

### Run oxlint before eslint

Add the following script to your `package.json`:

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

### Flat config

This plugin is optimized for flat config usage (eslint >= 9.0). See [here](https://eslint.org/docs/latest/use/configure/configuration-files-new) 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
];
```

### Legacy config

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",
  ],
}
```

### Detect rules from `.oxlintrc.json`

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 or `oxlint.config.ts` 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] }
  }
```

# [Sponsored By](https://oxc.rs/sponsor)

<p align="center">
  <a href="https://oxc.rs/sponsor">
    <img src="https://raw.githubusercontent.com/oxc-project/sponsors/main/sponsors.svg" alt="Our sponsors" />
  </a>
</p>