CI 및 기타 통합 설정

빌드 오류가 발생할 경우 빌드를 실패시키도록, 당신은 (그리고 반드시) 자신의 CI 파이프라인을 구성하여 Oxlint을 실행해야 합니다.

이 페이지에서는 리뷰 전 커밋 훅과 같은 다른 통합 기능도 다룹니다.

CI

다음 지침은 이미 package.json의 개발 종속성에 oxlint를 추가하고, 저장소에 옥린트 구성 파일이 있는 것으로 가정합니다.

GitHub Actions

기존에 lint 스크립트가 없다면, package.json에 lint 스크립트를 추가하세요:

package.json

{
  "scripts": {
    "lint": "oxlint"
  }
}

그런 다음 .github/workflows/oxlint.yml을 생성하세요:

.github/workflows/oxlint.yml

name: 린트

on:
  pull_request:
  push:
    branches: [main]

permissions: {}

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

      - uses: pnpm/action-setup@v4

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

      # 대신 여기에 npm install / yarn install 사용 가능
      - run: pnpm install --frozen-lockfile
      - run: pnpm run lint

또는 더 나은 경고/오류 주석을 위해 github 형식 옵션을 사용해 출력할 수도 있습니다:

package.json

{
  "scripts": {
    "lint:github": "oxlint --format=github"
  }
}

GitLab CI

GitLab CI를 사용하는 경우, --format=gitlab와 함께 사용하여 GitLab의 코드 품질 기능을 활용하면 머지 요청에서 린트 위반에 대한 인라인 주석을 얻을 수 있습니다.

설정하려면 package.json에 gitlab 형식으로 출력하고 파일에 저장하는 스크립트를 추가할 수 있습니다:

package.json

{
  "scripts": {
    "lint:gitlab": "oxlint --format=gitlab > gitlab-oxlint-report.json"
  }
}

그리고 .gitlab-ci.yml에 작업을 추가하여 스크립트를 실행하고 보고서를 코드 품질 아티팩트로 업로드하세요:

.gitlab-ci.yml

oxlint:
  image: node:lts
  stage: test
  before_script:
    # 대신 여기에 pnpm install / yarn install 사용 가능
    - npm install
  script:
    - npm run lint:gitlab
  artifacts:
    reports:
      codequality:
        # 이 경로는 저장소 루트 기준이므로, 저장소 구조가 다르거나 보고서 위치가 다를 경우 조정하세요
        - gitlab-oxlint-report.json

코드 품질 기능을 사용하지 않으려면, 단순히 CI 작업에서 --format=gitlab 없이 oxlint를 실행하면 됩니다.

타입 인식 규칙을 사용하려면 이를 활성화했는지 확인하고, 의존성 설치 속도를 높이기 위해 node_modules 캐싱을 고려하세요.

Git 훅

lint-staged

lint-staged를 사용하는 자바스크립트/타입스크립트 프로젝트의 경우, 다음과 같이 사전 커밋 훅으로 oxlint를 실행할 수 있습니다:

package.json

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

의존성 설치 시 자동으로 git 훅을 설치하려면 husky도 함께 사용하는 것을 고려하세요.

pre-commit

pre-commit을 사용하여 git 훅을 관리하는 경우, 다음과 같이 Oxlint을 설정할 수 있습니다:

.pre-commit-config.yaml

repos:
  - repo: https://github.com/oxc-project/mirrors-oxlint
    rev: v0.0.0
    hooks:
      - id: oxlint
        verbose: true

v0.0.0을 최신 버전으로 바꿔주세요.

기타 통합

Unplugin

Unplugin은 제3자 패키지를 통해 지원됩니다.

Vite 플러그인

Vite 플러그인은 제3자 패키지를 통해 지원됩니다.