명령줄 인터페이스

사용법

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

기본 구성

• -c, --config=<./.oxlintrc.json> — Oxlint 구성 파일

• 모든 런타임에서 .json 구성 파일을 지원합니다.

• JavaScript/TypeScript 구성 파일은 실험적인 기능이며, Node.js를 통해 실행해야 합니다.

• 구성 파일에서 주석을 사용할 수 있습니다.

• ESLint v8의 형식과 호환되도록 노력합니다.

  제공되지 않은 경우, Oxlint은 현재 작업 디렉터리에서 .oxlintrc.json을 검색합니다.

• --tsconfig=<./tsconfig.json> — import 플러그인을 위해 경로 별칭 및 프로젝트 참조를 읽기 위한 TypeScript tsconfig.json 경로입니다. 제공되지 않은 경우, 현재 작업 디렉터리에서 tsconfig.json을 검색합니다.
• --init — 기본값으로 오브젝트를 초기화하여 구성 설정

여러 린트 허용 / 차단

명령줄에서 왼쪽에서 오른쪽으로 규칙과 범주를 누적합니다.

예: -D correctness -A no-debugger 또는 -A all -D no-debugger
범주는 다음과 같습니다:

• correctness - 명백하게 잘못되거나 무의미한 코드 (기본값)
• suspicious - 대부분 잘못되거나 무의미한 코드
• pedantic - 다소 엄격하거나 때때로 거짓 긍정이 있는 린트
• perf - 더 성능이 좋은 방식으로 작성될 수 있는 코드
• style - 더 자연스럽고 관습적으로 작성되어야 하는 코드
• restriction - 언어나 라이브러리 기능 사용을 막는 린트
• nursery - 여전히 개발 중인 새로운 린트
• all - 위에 나열된 모든 범주(단, nursery 제외). 플러그인을 자동으로 활성화하지 않습니다.

옵션:

• -A, --allow=NAME — 규칙이나 범주를 허용 (린트 억제)
• -W, --warn=NAME — 규칙이나 범주를 차단 (경고 발생)
• -D, --deny=NAME — 규칙이나 범주를 차단 (오류 발생)

플러그인 활성화 / 비활성화

• --disable-unicorn-plugin — 기본적으로 활성화된 유니콘 플러그인 비활성화
• --disable-oxc-plugin — 기본적으로 활성화된 oxc 고유 규칙 비활성화
• --disable-typescript-plugin — 기본적으로 활성화된 TypeScript 플러그인 비활성화
• --import-plugin — import 플러그인 활성화 및 ESM 문제 감지. 프로젝트의 tsconfig.json 이름이 tsconfig.json이 아닌 경우, --tsconfig 플래그와 함께 사용해야 합니다.
• --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 플러그인 활성화 및 프라미스 사용 문제 감지
• --node-plugin — Node 플러그인 활성화 및 노드 사용 문제 감지
• --vue-plugin — Vue 플러그인 활성화 및 Vue 사용 문제 감지

문제 수정

• --fix — 가능한 한 많은 문제를 수정합니다. 출력에서는 수정되지 않은 문제만 보고됩니다.
• --fix-suggestions — 자동 수정 가능한 제안 적용. 프로그램 동작을 변경할 수 있습니다.
• --fix-dangerously — 위험한 수정 및 제안 적용

파일 무시

• --ignore-path=PATH — .eslintignore로 사용할 파일 지정

• --ignore-pattern=PAT — 무시할 파일 패턴 지정 (.eslintignore에 포함된 항목 외에도 추가로 무시)

  지원되는 구문은 .eslintignore 및 .gitignore 파일과 동일합니다. 글로벌 패턴 해석을 피하기 위해 패턴을 따옴표로 묶어야 합니다.

• --no-ignore — .eslintignore 파일, --ignore-path 플래그 및 --ignore-pattern 플래그에 의해 파일 제외를 비활성화합니다.

경고 처리

• --quiet — 경고 보고를 비활성화하고 오류만 보고합니다.
• --deny-warnings — 경고가 발생하면 0이 아닌 종료 코드를 반환하도록 보장합니다.
• --max-warnings=INT — 경고 임계치 지정. 프로젝트 내에서 경고 수준의 규칙 위반이 너무 많으면 오류 상태로 종료하도록 강제할 수 있습니다.

출력

• -f, --format=ARG — 특정 출력 형식 사용. 가능한 값: checkstyle, default, github, gitlab, json, junit, stylish, unix

기타 사항

• --silent — 진단 정보를 표시하지 않습니다.
• --threads=INT — 사용할 스레드 수. 1개의 CPU 코어만 사용하려면 1로 설정합니다.
• --print-config — 사용될 구성 정보를 출력합니다. 이 옵션이 존재할 경우 린팅이 수행되지 않으며, 구성 관련 옵션만 유효합니다.

인라인 구성 주석

• --report-unused-disable-directives — 해당 줄에 실제로 경고가 발생하지 않는 경우에도 // oxlint-disable-line과 같은 지시어 주석을 보고합니다.
• --report-unused-disable-directives-severity=SEVERITY — --report-unused-disable-directives와 동일하지만, 보고되는 오류의 심각도 수준을 지정할 수 있습니다. 이 두 옵션은 동시에 하나만 사용할 수 있습니다.

사용 가능한 위치 인수:

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

사용 가능한 옵션:

• --rules — 현재 등록된 모든 규칙 목록 출력
• --lsp — 언어 서버 시작
• --disable-nested-config — 중첩된 구성 파일의 자동 로딩 비활성화
• --type-aware — 타입 정보가 필요한 규칙 활성화
• --type-check — 실험적인 타입 체크 활성화 (TypeScript 컴파일러 진단 포함)
• -h, --help — 도움말 정보 출력
• -V, --version — 버전 정보 출력