Setup CI and other integrations ​

You can - and should - setup your CI pipeline to run Oxlint and fail the build on lint errors.

This page also covers other integrations you may want to include, like git pre-commit hooks.

CI ​

GitHub Actions ​

Create .github/workflows/oxlint.yml:

name: Lint

on:
  pull_request:
  push:
    branches: [main]

jobs:
  oxlint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: lts/*
          cache: pnpm

      - uses: pnpm/action-setup@v4

      - run: pnpm install --frozen-lockfile
      - run: pnpm run lint --deny-warnings # given package.json scripts "lint": "oxlint"

Git hooks ​

lint-staged ​

For JS/TS projects using lint-staged, you can set up oxlint to run pre-commit as follows:

{
  "lint-staged": {
    "*.{js,jsx,ts,tsx,mjs,cjs}": "pnpm run lint"
  }
}

pre-commit ​

If you use pre-commit to manage git hooks, you can set up Oxlint as follows:

repos:
  - repo: https://github.com/oxc-project/mirrors-oxlint
    rev: v0.0.0 # change to the latest version
    hooks:
      - id: oxlint
        verbose: true

Other integrations ​

Unplugin ​

Unplugin is supported via a third-party package

Vite plugin ​

A Vite plugin is supported via a third-party package