vite-plugin-oxlint weekly downloads statistics

⚓️+⚡️Vite Plugin Oxlint

A Vite plugin for integrating the Oxlint linter into your Vite project.

Table of Contents

• Installation • Usage • Options • Advanced Usage • Configuration file • Working directory • Ignore patterns • Allow / Deny / Warn rules • Oxlint binary path • Output format • Fail on errors or warnings • Additional CLI options • Integration with ESLint

Installation

Usage

Options

| Option | Type | Default | Description |

| configFile | string | — | Path to a custom oxlint config file (see Configuration file) | | path | string | . | Directory where oxlint runs | | ignorePattern | string \| string[] | — | Glob patterns of files to ignore | | allow | string[] | — | Rules/categories to allow (turn off) | | deny | string[] | — | Rules/categories to deny (turn on) | | warn | string[] | — | Rules/categories to warn | | oxlintPath | string | — | Path to the oxlint binary (useful in monorepos) | | format | string | default | Output format (default, agent, checkstyle, github, gitlab, json, junit, sarif, stylish, unix) | | quiet | boolean | false | Suppress warnings, only report errors | | fix | boolean | false | Enable auto-fixing | | failOnError | boolean | false | Fail the build on lint errors | | failOnWarning | boolean | false | Fail the build on lint warnings | | lintOnStart | boolean | true | Run oxlint when the build starts | | lintOnHotUpdate | boolean | true | Run oxlint on every HMR update during dev | | params | string | — | Additional raw CLI flags passed to oxlint |

Advanced Usage

All examples below assume the following setup:

Configuration file

Oxlint discovers its own config files (.oxlintrc.json, .oxlintrc.jsonc, oxlint.config.ts) automatically, including nested configs — no option needed. Use configFile only for a custom name or location (a legacy oxlintrc.json at the project root is also picked up). Note: an explicit config file disables nested config discovery, and allow/deny/warn options override its rules.

Under Vite+ (vp dev / vp build), oxlint behaves like vp lint: it reads the lint block of vite.config.* and ignores .oxlintrc.json files — without a lint block, oxlint silently falls back to its default rules. Set configFile to keep using a separate config file.

Working directory

Restrict linting to a subdirectory. Default is the project root.

Ignore patterns

Ignore files using .gitignore-style patterns. See oxlint ignore docs. Quote patterns to avoid shell glob interpretation.

Allow / Deny / Warn rules

Control which rules or categories are active. Run npx oxlint --rules to list available rules and categories. These options override any rules defined in the config file.

Oxlint binary path

In monorepos, if you get "command not found: oxlint" errors, specify the binary path explicitly. Without this option, the plugin falls back to npx (or your package manager's equivalent).

Output format

Change how lint diagnostics are reported. See oxlint output formats. Available: default, agent, checkstyle, github, gitlab, json, junit, sarif, stylish, unix.

Fail on errors or warnings

By default, lint issues are logged but don't fail the build.

Additional CLI options

Pass any raw CLI flags as a string. See oxlint CLI options.

Integration with ESLint

If your project still needs ESLint, use vite-plugin-eslint alongside this plugin, and configure ESLint with eslint-plugin-oxlint to disable rules already covered by oxlint.

License

MIT LICENSE

Description from the npm listing.