detekt + reviewdog으로 정적 코드 분석 자동화하기

간단 소개

detekt와 reviewdog을 활용하여 정적 코드 분석을 자동화하고, PR 리뷰에 결과를 반영하는 방법을 설명합니다.

AI Summary

정적 코드 분석 자동화의 필요성
- 코드 품질 향상: 일관된 규칙으로 코드 분석하여 품질을 높임
- 리뷰어 부담 감소: 코드 스타일 지적 대신 중요한 로직에 집중
- 불필요한 갈등 감소: 자동화된 도구가 규칙 위반을 지적
detekt와 reviewdog 설정 방법
- 수동 분석 환경 구축: multi-module 환경에서 detekt 적용 및 설정 변경
- 자동 분석 설정: GitHub Actions를 통해 PR 생성 시 detekt 실행
- PR 리뷰 생성: reviewdog을 통해 detekt 분석 결과를 PR 리뷰로 게시
reviewdog 설정 옵션
- 변경 사항에 포함되지 않은 경고 노출: filter-mode=nofilter 설정
- 경고 발생 시 Check 실패 처리: fail-level 옵션 조정 (any, info, warning, error)
- 특정 경고만 실패 처리: detekt Rule의 severity를 error로 설정하고 reviewdog의 fail-level을 error로 설정