@ctrl/oxlint-config

A shareable oxlint config for myself

Getting Started

Install and pin dev dependencies:

pnpm add -D oxlint oxfmt @ctrl/oxlint-config

Usage

In your project's .oxlintrc.json file, add the following:

{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "env": {
    "node": true
  },
  "plugins": ["react", "unicorn", "typescript", "oxc", "import"],
  "extends": ["./node_modules/@ctrl/oxlint-config/.oxlintrc.json"]
}

Add a .oxfmtrc.json config

{
  "$schema": "./node_modules/oxfmt/configuration_schema.json",
  "printWidth": 100,
  "singleQuote": true,
  "arrowParens": "avoid",
  "sortImports": {
    "groups": ["side_effect", "builtin", "external", "internal", "parent", "index", "sibling"],
    "newlinesBetween": true
  },
  "sortPackageJson": true,
  "sortTailwindcss": {
    "classOrder": "shadcn"
  }
}

Add scripts to your package.json

{
  "scripts": {
    "lint": "oxlint . && oxfmt --check",
    "lint:fix": "oxlint . --fix && oxfmt"
  }
}