detekt에 custom rule 추가하기
백엔드
detekt에 custom rule 추가하기
두줄요약
detekt에 custom rule을 추가해 팀 컨벤션을 자동 검증하는 방법을 설명합니다. `println()` 금지 rule 예시와 테스트, 적용 설정까지 단계별로 다뤘습니다.
핵심 내용
- detekt 기본 rule에 없는 팀 컨벤션을 custom rule로 구현하는 방법 소개
code-quality모듈을 분리해 detekt-api, detekt-test를 추가하고 RuleSetProvider를 ServiceLoader로 등록하는 구성- 예시로
println()사용을 금지하는NoPrintlnrule과 detekt-test 기반 테스트 작성 detekt.yml에서 custom rule을 활성화하고detektPlugins로 외부 모듈에 적용하는 절차
적용해볼 점
- 반복되는 코드 리뷰 기준을 custom rule로 자동화
- detekt 실행 오류 시
detektPlugins의존성과 Gradle daemon 상태 점검