빠른 시작
이 페이지는 Oxlint에 대한 추천 설정과 가장 일반적인 워크플로우를 보여주며, 복사하여 붙여넣기 가능한 명령어를 제공합니다.
설치
oxlint를 개발 의존성으로 설치하세요:
$ npm add -D oxlint$ pnpm add -D oxlint$ yarn add -D oxlint$ bun add -D oxlintpackage.json에 린트 명령을 추가하세요:
{
"scripts": {
"lint": "oxlint",
"lint:fix": "oxlint --fix"
}
}실행해보세요:
npm run lintpnpm run lintyarn run lintbun run lint수정 사항 적용:
npm run lint:fixpnpm run lint:fixyarn run lint:fixbun run lint:fix사용법
모든 옵션의 완전한 목록은 CLI 참조를 확인하세요.
oxlint [OPTIONS] [PATH]...PATH가 생략되면, Oxlint은 현재 작업 디렉터리를 검사합니다.
일반 워크플로우
lint-staged와 함께 사전 커밋
{
"lint-staged": {
"*.{js,jsx,ts,tsx,mjs,cjs}": "npm run lint"
}
}{
"lint-staged": {
"*.{js,jsx,ts,tsx,mjs,cjs}": "pnpm run lint"
}
}{
"lint-staged": {
"*.{js,jsx,ts,tsx,mjs,cjs}": "yarn run lint"
}
}{
"lint-staged": {
"*.{js,jsx,ts,tsx,mjs,cjs}": "bun run lint"
}
}구성 파일 생성
기본값으로 .oxlintrc.json 구성 파일을 초기화하세요:
oxlint --init그런 다음 필요에 따라 .oxlintrc.json을 사용자 지정하세요. 자세한 내용은 구성을 참조하세요.
또는, Oxlint은 oxlint.config.ts라는 이름의 타입스크립트 구성 파일을 지원합니다. 자세한 내용은 구성을 참고하세요.
그 후, Oxlint을 실행하세요:
oxlintTIP
ESLint에서 마이그레이션하는 경우, ESLint에서 마이그레이션하기 페이지를 참조하여 상세한 안내를 받으세요.
문제 해결
안전한 수정 사항 적용:
oxlint --fix제안 사항 적용 (프로그램 동작 방식을 변경할 수 있음):
oxlint --fix-suggestions위험한 수정 사항 및 제안 사항 적용:
oxlint --fix-dangerously각 모드를 언제 사용해야 하는지에 대한 가이드는 자동 수정을 참조하세요.
파일 무시
명시적인 무시 파일 사용:
oxlint --ignore-path .oxlintignore명령줄에서 무시 패턴 추가:
oxlint --ignore-pattern "dist/**" --ignore-pattern "*.min.js"무시 처리 비활성화:
oxlint --no-ignore자세한 내용은 파일 무시를 참조하세요.
CI 신뢰성 확보
오류만 보고:
oxlint --quiet경고가 하나라도 발견되면 실패:
oxlint --deny-warnings경고 수가 한계치를 초과하면 실패:
oxlint --max-warnings 0자세한 내용은 CI 설정을 참조하세요.
기계가 읽을 수 있는 출력 사용
출력 형식 선택:
oxlint -f json사용 가능한 형식은 다음과 같습니다: default, json, unix, checkstyle, github, gitlab, junit, stylish.
효과적인 구성 보기
파일에 적용될 구성 내용을 출력:
oxlint --print-config path/to/file.ts사용 가능한 규칙 나열
등록된 규칙(현재 오목린트 구성에 활성화된 항목 포함)을 나열:
oxlint --rules전체 목록은 규칙 참조에 있습니다.