Unplugin-oxlint NPM

unplugin-oxlint

🌋 A universal bundler plugin for integrating the Oxlint linter into your project, based on vite-plugin-oxlint.

Features

🚀 A quick and simple way to use oxlint in your project.

🛠️ Support linting with both bundler plugin and Node.js API.

⚙️ Support common bundlers like Vite, Rollup, esbuild, and Webpack by unplugin.

🔍 Support mixed use in eslint projects by eslint-plugin-oxlint.

😊 Friendly output in terminal, grouped by filepath, and support including targets with glob patterns.

⚡ Only lint the files that have changed for better performance by chokidar.

screenshot

Installation

# npm
npm i -D oxlint unplugin-oxlint

# pnpm
pnpm add -D oxlint unplugin-oxlint

# yar
yarn add -D oxlint unplugin-oxlint

Usage

`Bundler Plugin`

Recommended the bundler plugin way to use the full options of unplugin-oxlint.

// vite.config.ts
import Oxlint from 'unplugin-oxlint/vite'

export default defineConfig({
  plugins: [Oxlint()],
})

// rollup.config.js
import Oxlint from 'unplugin-oxlint/rollup'

export default {
  plugins: [Oxlint()],
}

// esbuild.config.js
import { build } from 'esbuild'

build({
  plugins: [require('unplugin-oxlint/esbuild')()],
})

// webpack.config.js
module.exports = {
  /* ... */
  plugins: [require('unplugin-oxlint/webpack')()],
}

`Command`

You can also use unox command to lint files like eslint

// package.json
{
  "scripts": {
    "lint": "unox",
    "lint:fix": "unox --fix"
  }
}

unox support most of the options of unplugin-oxlint, use them as params like:

unox src/**/*.ts --watch

For further configuration, create a config file named unox.config.{js,cjs,mjs,ts,mts,cts}

Playground

See playground.

ESLint

If you are looking for a way to use oxlint in projects that still need ESLint, You can use eslint-plugin-oxlint to turn off ESLint rules that are already supported by oxlint.

The rules are extracted from here

unplugin-oxlint will automatically run the eslint script after oxlint when build start and file change.

# npm
npm i -D eslint eslint-plugin-oxlint

# pnpm
pnpm add -D eslint eslint-plugin-oxlint

# yarn
yarn add -D eslint eslint-plugin-oxlint

Example

Use eslint-plugin-oxlint with @antfu/eslint-config

// eslint.config.js
import antfu from '@antfu/eslint-config'
import oxlint from 'eslint-plugin-oxlint'

export default antfu({
  ...oxlint.configs['flat/recommended'],
})