빠른 시작
이 페이지에서는 Oxlint 권장 설정과 가장 흔한 워크플로를 복사해 붙여넣을 수 있는 명령과 함께 안내합니다.
설치
oxlint를 개발 의존성으로 설치합니다:
sh
$ npm add -D oxlintsh
$ pnpm add -D oxlintsh
$ yarn add -D oxlintsh
$ bun add -D oxlintpackage.json에 린트 스크립트를 추가합니다:
json
{
"scripts": {
"lint": "oxlint",
"lint:fix": "oxlint --fix"
}
}실행:
sh
npm run lintsh
pnpm run lintsh
yarn run lintsh
bun run lint수정 적용:
sh
npm run lint:fixsh
pnpm run lint:fixsh
yarn run lint:fixsh
bun run lint:fix사용법
CLI 옵션 전체는 CLI 레퍼런스를 참고하세요.
sh
oxlint [OPTIONS] [PATH]...PATH를 생략하면 현재 작업 디렉터리를 린트합니다.
일반적인 워크플로
lint-staged로 커밋 전
json
{
"lint-staged": {
"*.{js,jsx,ts,tsx,mjs,cjs}": "npm run lint"
}
}json
{
"lint-staged": {
"*.{js,jsx,ts,tsx,mjs,cjs}": "pnpm run lint"
}
}json
{
"lint-staged": {
"*.{js,jsx,ts,tsx,mjs,cjs}": "yarn run lint"
}
}json
{
"lint-staged": {
"*.{js,jsx,ts,tsx,mjs,cjs}": "bun run lint"
}
}설정 파일 만들기
기본값으로 .oxlintrc.json을 초기화합니다:
sh
oxlint --init그다음 필요에 따라 .oxlintrc.json을 수정합니다. 자세한 내용은 설정을 참고하세요.
또는 TypeScript 설정 파일 oxlint.config.ts를 사용할 수 있습니다. 설정을 참고하세요.
Oxlint 실행:
sh
oxlintTIP
ESLint에서 마이그레이션하는 경우 「ESLint에서 마이그레이션」 페이지에서 단계별 안내를 확인하세요.
문제 수정
안전한 수정만 적용:
sh
oxlint --fix제안 적용(프로그램 동작이 바뀔 수 있음):
sh
oxlint --fix-suggestions위험한 수정과 제안까지 적용:
sh
oxlint --fix-dangerously각 모드 사용 시점은 자동 수정을 참고하세요.
파일 무시
명시적인 무시 파일 사용:
sh
oxlint --ignore-path .oxlintignoreCLI에서 무시 패턴 추가:
sh
oxlint --ignore-pattern "dist/**" --ignore-pattern "*.min.js"무시 처리 끄기:
sh
oxlint --no-ignore무시 파일을 참고하세요.
CI에서 안정적으로 실패
오류만 보고:
sh
oxlint --quiet경고가 있으면 실패:
sh
oxlint --deny-warnings경고 개수가 임계값을 넘으면 실패:
sh
oxlint --max-warnings 0CI 설정을 참고하세요.
기계가 읽기 쉬운 출력
출력 형식 선택:
sh
oxlint -f jsondefault, json, unix, checkstyle, github, gitlab, junit, stylish 등이 있습니다. 자세한 내용은 출력 형식을 참고하세요.
실제 적용될 설정 확인
특정 파일에 쓰일 설정을 출력:
sh
oxlint --print-config path/to/file.ts사용 가능한 규칙 목록
현재 Oxlint 설정으로 등록된 규칙(켜진 규칙 포함) 나열:
sh
oxlint --rules전체 목록은 규칙 레퍼런스에 있습니다.