get-oxlint-rules

Useful utils for Oxlint.

Usage

import { getOxlintPlugins, getRules, getRulesByCategory } from 'get-oxlint-rules'

const rules = await getRulesByCategory('correctness')
// [{ scope: 'eslint', value: 'no-debugger', category: 'correctness', ... }]

const all = await getRules()

const plugins = await getOxlintPlugins()
// ['eslint', 'import', 'jest', 'jsdoc', 'jsx-a11y', ...]

The first call runs the oxlint package installed next to this one, so it works from any working directory. In a Vite+ project without a direct oxlint dependency, the copy bundled by vite-plus is used. If no package is found, oxlint on PATH is used. The result is cached in node_modules/.cache/get-oxlint-rules, keyed by the Oxlint version, so later calls read from disk instead.

Options:

| Option | Description | | ---------- | ----------------------------------------------------------------------------------------------------- | | cwd | Extra directory to resolve oxlint (or vite-plus) from first. | | bin | Path to an oxlint executable, skipping package resolution. | | via | Only use the oxlint that this package depends on, like vite-plus. Throws instead of falling back. | | cacheDir | Directory for cached data. |

License

MIT License © Liang Mi and contributors.