Getting started
Install and configure @wanner.work/oxlint-rules in your project.
@wanner.work/oxlint-rules is an oxlint
config wrapper that bundles a set of rules for writing consistent code. It enforces a
small folder convention and a set of declaration-style rules
(component shape, method exports, hook naming, etc.) so that every file in your
project follows the same pattern.
Installation
Install the package alongside oxlint in your project:
pnpm add -D @wanner.work/oxlint-rules oxlint oxlint-tsgolintUsage
Import defineConfigWithRules from the package and use it in place of
defineConfig from oxlint. The wrapper merges the recommended rule set into
your existing config:
import { defineConfigWithRules } from '@wanner.work/oxlint-rules'
export default defineConfigWithRules({
// your own oxlint config goes here
})The recommended set is enabled automatically. You can layer your own
overrides on top — the wrapper uses defu under the hood, so the last value
wins.
What's in this package
The rules are folder-scoped, not whole-project. Adding the package to a project that does not follow the folder convention is harmless — the rules only fire on the folders they care about.