diff --git a/configs/oxlint/README.md b/configs/oxlint/README.md new file mode 100644 index 0000000..96817c7 --- /dev/null +++ b/configs/oxlint/README.md @@ -0,0 +1,54 @@ +# @robonen/oxlint + +Composable [oxlint](https://oxc.rs/docs/guide/usage/linter.html) configuration presets. + +## Install + +```bash +pnpm install -D @robonen/oxlint oxlint +``` + +## Usage + +Create `oxlint.config.ts` in your project root: + +```ts +import { defineConfig } from 'oxlint'; +import { compose, base, typescript, vue, vitest, imports } from '@robonen/oxlint'; + +export default defineConfig( + compose(base, typescript, vue, vitest, imports), +); +``` + +Append custom rules after presets to override them: + +```ts +compose(base, typescript, { + rules: { 'eslint/no-console': 'off' }, + ignorePatterns: ['dist'], +}); +``` + +## Presets + +| Preset | Description | +| ------------ | -------------------------------------------------- | +| `base` | Core eslint, oxc, unicorn rules | +| `typescript` | TypeScript-specific rules (via overrides) | +| `vue` | Vue 3 Composition API / `