Skip to content

명령줄 인터페이스

사용법

oxlint [-c=<./.oxlintrc.json>] [경로]...

기본 설정

  • -c, --config=<./.oxlintrc.json> — Oxlint 설정 파일
  • 모든 런타임에서 .json, .jsonc 설정 지원

  • JavaScript/TypeScript 설정 파일은 실험적이며 Node.js로 실행해야 함

  • 설정 파일에 주석 사용 가능

  • ESLint v8 형식과의 호환을 목표로 함

    지정하지 않으면 현재 작업 디렉터리에서 .oxlintrc.json, .oxlintrc.jsonc, oxlint.config.ts를 찾습니다.

  • --tsconfig=<./tsconfig.json> — import 해석에 쓰는 TypeScript 설정을 덮어씁니다. Oxlint는 파일마다 적절한 tsconfig.json을 자동으로 찾습니다. 비표준 이름·위치일 때만 사용하세요.

    이 옵션은 가급적 쓰지 마세요. import 해석과 타입 인지 린팅 사이에 차이가 날 수 있습니다. 타입 인지 린팅은 이 옵션을 따르지 않으며, 파일마다 적절한 tsconfig.json을 항상 자동 탐색합니다. :::

  • --init — 기본값으로 oxlint 설정 초기화

여러 린트 허용/거부

명령줄에서 규칙과 카테고리를 왼쪽에서 오른쪽으로 누적합니다.

예: -D correctness -A no-debugger 또는 -A all -D no-debugger. 카테고리:

  • correctness — 명백히 잘못되었거나 쓸모없는 코드(기본)
  • suspicious — 잘못되었거나 쓸모없을 가능성이 큰 코드
  • pedantic — 다소 엄격하거나 가끔 거짓 양성이 있는 린트
  • perf — 더 나은 성능으로 쓸 수 있는 코드
  • style — 더 관용적인 방식으로 쓸 수 있는 코드
  • restriction — 언어·라이브러리 기능 사용을 막는 린트
  • nursery — 아직 개발 중인 새 린트
  • all — 위 목록 중 nursery를 제외한 전체. 플러그인을 자동으로 켜지는 것은 아님.

인자:

  • -A, --allow=이름 — 규칙 또는 카테고리 허용(린트 억제)
  • -W, --warn=이름 — 규칙 또는 카테고리 거부(경고)
  • -D, --deny=이름 — 규칙 또는 카테고리 거부(오류)

플러그인 켜기/끄기

  • --disable-unicorn-plugin — 기본 켜짐인 unicorn 플러그인 끄기
  • --disable-oxc-plugin — 기본 켜짐인 oxc 전용 규칙 플러그인 끄기
  • --disable-typescript-plugin — 기본 켜짐인 TypeScript 플러그인 끄기
  • --import-plugin — import 플러그인 켜고 ESM 문제 탐지
  • --react-plugin — 기본 꺼짐인 react 플러그인 켜기
  • --jsdoc-plugin — jsdoc 플러그인 켜고 JSDoc 문제 탐지
  • --jest-plugin — Jest 플러그인 켜고 테스트 문제 탐지
  • --vitest-plugin — Vitest 플러그인 켜고 테스트 문제 탐지
  • --jsx-a11y-plugin — JSX-a11y 플러그인 켜고 접근성 문제 탐지
  • --nextjs-plugin — Next.js 플러그인 켜고 Next.js 문제 탐지
  • --react-perf-plugin — React 성능 플러그인 켜고 렌더링 성능 문제 탐지
  • --promise-plugin — promise 플러그인 켜고 Promise 사용 문제 탐지
  • --node-plugin — node 플러그인 켜고 Node 사용 문제 탐지
  • --vue-plugin — vue 플러그인 켜고 Vue 문제 탐지

문제 수정

  • --fix — 가능한 한 많이 수정. 출력에는 고치지 못한 이슈만 표시
  • --fix-suggestions — 자동 수정 가능한 제안 적용. 동작이 바뀔 수 있음
  • --fix-dangerously — 위험한 수정과 제안 적용

무시 파일

  • --ignore-path=경로.eslintignore로 쓸 파일 지정

  • --ignore-pattern=패턴 — 무시할 파일 패턴 추가(.eslintignore 외)

    구문은 .eslintignore, .gitignore와 동일. 글로브는 셰이 해석을 피하도록 따옴표로 감싸세요.

  • --no-ignore.eslintignore, --ignore-path, --ignore-pattern로 제외하는 동작 끄기

경고 처리

  • --quiet — 경고 출력 끄기, 오류만 표시
  • --deny-warnings — 경고도 0이 아닌 종료 코드
  • --max-warnings=정수 — 경고 개수 임계값. 프로젝트의 경고 수준이 너무 많으면 오류로 종료

출력

  • -f, --format= — 출력 형식. checkstyle, default, github, gitlab, json, junit, stylish, unix

기타

  • --silent — 진단을 표시하지 않음
  • --no-error-on-unmatched-pattern — 무시 패턴 적용 후 린트할 파일이 없어도 오류로 종료하지 않음
  • --threads=정수 — 사용할 스레드 수. CPU 코어 1개만 쓰려면 1
  • --print-config — 사용할 설정을 출력. 지정 시 린트는 수행하지 않으며 설정 관련 옵션만 유효

인라인 설정 주석

  • --report-unused-disable-directives// oxlint-disable-line 같은 지시 주석이 실제로는 불필요할 때 보고
  • --report-unused-disable-directives-severity=심각도 — 위와 같지만 보고 심각도 지정. 두 옵션은 동시에 하나만 사용

사용 가능한 위치 인자:

  • 경로 — 단일 파일, 단일 경로 또는 경로 목록

사용 가능한 옵션:

  • --rules — 현재 등록된 규칙 전부 나열
  • --lsp — 언어 서버 시작
  • --disable-nested-config — 중첩 설정 파일 자동 로드 끄기
  • --type-aware — 타입 정보가 필요한 규칙 켜기
  • --type-check — 실험적 타입 검사 켜기(TypeScript 컴파일러 진단 포함)
  • -h, --help — 도움말 출력
  • -V, --version — 버전 정보 출력