CodeRabbit Android & Jetpack Compose AI 코드 리뷰 설정 가이드

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: ko-KR
early_access: false
 
reviews:
  profile: chill            # 처음에는 chill, 익숙해지면 assertive
  high_level_summary: true
  collapse_walkthrough: true
  poem: false

reviews:
  path_filters:
    # Kotlin/Compose 소스
    - "**/*.kt"
    - "**/*.kts"
    # AndroidManifest
    - "**/AndroidManifest.xml"
    # Gradle / 버전 카탈로그
    - "**/*.gradle"
    - "**/*.gradle.kts"
    - "**/libs.versions.toml"
    - "**/gradle.properties"
 
    # 빌드 산출물
    - "!**/build/**"
    - "!**/.gradle/**"
    - "!**/out/**"
    - "!**/generated/**"
    - "!**/buildSrc/build/**"
    # KSP/KAPT 생성 코드
    - "!**/ksp/**"
    - "!**/kapt/**"
    # 리소스(텍스트가 아닌 이진 파일·자동생성 R.java/BuildConfig)
    - "!**/R.java"
    - "!**/BuildConfig.java"
    # 자동 생성 보호
    - "!**/*.pb.kt"
    - "!**/databinding/**"
    # 의존성 잠금/락 파일
    - "!**/gradle-wrapper.properties"

reviews:
  auto_review:
    enabled: true
    auto_incremental_review: true
    drafts: false
    base_branches:
      - main
      - develop
    ignore_usernames:
      - dependabot
      - "dependabot[bot]"
      - renovate
      - "renovate[bot]"

reviews:
  path_instructions:
    - path: "**/*.kt"
      instructions: |
        Kotlin best practices to check:
 
        Language correctness:
        - Null safety: nullable 타입을 적절히 다루고, 불필요한 !! 단언 사용 금지
        - Immutability: var보다 val을 우선, 가능한 경우 immutable collection 사용
        - Data class: DTO와 값 객체에는 data class를 사용
        - Sealed class/sealed interface: 제한된 계층 표현에 적극 활용
 
        Coroutines:
        - Structured concurrency: viewModelScope, lifecycleScope 등 적절한 스코프 사용
        - GlobalScope 사용 금지 (테스트 가능성과 취소 전파 문제)
        - Dispatcher 사용: IO는 blocking I/O에, Default는 CPU 집약 작업에
        - withContext로 디스패처 전환 시 의도가 명확한지 확인
 
        Performance:
        - hot path에서 불필요한 객체 할당 피하기
        - 큰 collection에 여러 연산을 체인할 때는 sequence 활용
 
        Error handling:
        - 예외 삼키기(swallow) 금지
        - 실패 가능한 작업은 Result 또는 sealed class로 표현 고려
 
        Security:
        - 하드코딩된 secret/credential 금지
        - 보안 민감 작업에는 SecureRandom 사용
        - 안전하지 않은 역직렬화 금지

    # 1) 화면 단위 Composable - 파일명 컨벤션, 모듈 깊이와 무관
    - path: "**/*Screen.kt"
      instructions: |
        Jetpack Compose 화면 best practices:
        - state hoisting: stateful/stateless 분리, ViewModel 비즈니스 상태를 컴포저블이 직접 보관 금지
        - rememberSaveable로 구성 변경에서 살아남아야 하는 상태 보존
        - LaunchedEffect/DisposableEffect의 key가 의도와 일치하는지 검증
        - Modifier 매개변수는 default Modifier로 두고 첫 번째 옵셔널 위치에 배치
        - stringResource/MaterialTheme 사용, 하드코딩 색상/문자열 회피
        - 의미 있는 contentDescription, 최소 48dp 터치 영역(접근성)
 
    # 2) 재사용 UI / 디자인 시스템 - core/ui, core/designsystem
    - path: "**/core/{ui,designsystem}/**/*.kt"
      instructions: |
        디자인 시스템·재사용 컴포넌트 best practices:
        - @Composable 함수명은 PascalCase, public API라면 KDoc 주석 권장
        - Modifier 매개변수 default와 위치(첫 번째 옵셔널)
        - 매개변수 데이터 클래스에 @Stable/@Immutable 검토(재구성 최적화)
        - SideEffect/derivedStateOf로 불필요한 재구성 줄이기
        - 디자인 토큰을 우회하는 하드코딩(0xFFxxxxxx, 임의 dp) 발견 시 토큰 추출 권장
        - @Preview 함수에 라이트/다크 모드, 폰트 크기 변형 제공
 
    # 3) 보조 패턴 - 단일 모듈 프로젝트의 ui/screen/components 디렉터리
    - path: "**/{ui,screen,screens,components,composables}/**/*.kt"
      instructions: |
        Jetpack Compose best practices:
 
        함수 시그니처:
        - @Composable 함수명은 PascalCase (예: `UserCard`, `LoginScreen`)
        - 결과를 반환하지 않는 한 반환 타입을 명시하지 않음 (Unit 명시 X)
        - Modifier 매개변수는 default 값으로 `Modifier`를 두고, 매개변수 목록 가장 앞 또는 첫 번째 옵셔널 위치에 배치
 
        State hoisting:
        - 가능한 경우 stateful 컴포저블 안의 상태를 상위로 끌어올려 stateless로 분리
        - `remember { mutableStateOf(...) }`는 정말 UI-local일 때만 사용
        - 화면 회전 등 구성 변경에서 살아남아야 하는 상태는 `rememberSaveable` 사용
        - ViewModel의 비즈니스 상태를 컴포저블 안에서 직접 보관하지 않기
 
        Recomposition 최적화:
        - 매개변수로 받는 데이터 클래스에는 `@Stable` 또는 `@Immutable` 어노테이션 검토
        - 람다 내부에서 `remember`로 캐싱이 필요한지 확인 (특히 큰 리스트 항목)
        - `derivedStateOf`로 파생 상태를 캐싱해 불필요한 재구성 줄이기
        - `key()`로 리스트 항목의 안정적 ID를 부여 (LazyColumn items)
 
        Side effects:
        - `LaunchedEffect`의 key가 의도와 일치하는지 (key 변경 = 재실행)
        - 컴포저블 외부 자원을 다룰 때는 `DisposableEffect`로 cleanup 보장
        - `SideEffect`는 매 재구성마다 호출됨 (성능 주의)
        - `produceState`/`snapshotFlow` 사용 시 적절한 dispatcher와 스코프 확인
 
        Modifier:
        - Modifier 체인 순서가 의미적으로 맞는지 (padding, clickable, background 순서 영향)
        - 부모 Modifier를 자식에 전달할 때 누락 없음
        - 자체 Modifier를 만들기 전에 표준 Modifier 조합으로 표현 가능한지 확인
 
        리소스:
        - 텍스트는 가능한 한 `stringResource(R.string.x)` 사용 (i18n)
        - 색상/크기는 `MaterialTheme.colorScheme`/`MaterialTheme.typography`/dp·sp 단위 사용
        - 하드코딩된 색상값(0xFFxxxxxx) 발견 시 디자인 토큰으로 추출 권장
 
        Preview:
        - `@Preview` 함수에는 적절한 `name`/`group`/`showBackground` 지정
        - 다양한 폰트 크기·라이트/다크 모드 Preview를 함께 제공하면 더 좋음
        - Preview 함수 내부에서 ViewModel을 직접 생성하지 않고, 더미 상태/콜백만 주입
 
        Accessibility:
        - 의미 있는 contentDescription 제공 (장식 요소는 null로 명시)
        - clickable에는 `Modifier.clickable(onClickLabel = ...)` 또는 `semantics { ... }` 활용
        - 충분한 터치 영역(최소 48dp) 확보

    - path: "**/*ViewModel.kt"
      instructions: |
        ViewModel best practices:
 
        의존성과 스코프:
        - @HiltViewModel + @Inject constructor로 의존성 주입(필드 주입 금지)
        - 코루틴 실행은 viewModelScope 기준, GlobalScope/runBlocking 사용 금지
        - 외부에서 주입받은 CoroutineDispatcher를 사용해 테스트 결정성 확보
        - SavedStateHandle을 생성자로 받아 nav args/process death 상태 복원
          (예: `savedStateHandle.getStateFlow(KEY, default)` 패턴)
 
        UI 상태 모델링 (sealed + StateFlow):
        - UI 상태는 sealed interface(또는 sealed class)로 명시적 상태 표현
          (예: `sealed interface FeedUiState { object Loading; data class Success(...); object Error }`)
        - 단일 source of truth로 `StateFlow<XxxUiState>` 한 개를 외부에 노출
        - 중간 상태(Loading, Empty, Error)를 누락하지 않기. 빈 결과와 미초기화 상태는 구분
          (NowInAndroid의 SearchResultUiState: Loading/EmptyQuery/SearchNotReady/LoadFailed/Success)
        - data class Success는 immutable 필드만, 컬렉션은 List/Set 사용
 
        Cold flow → hot StateFlow 변환:
        - Repository/UseCase의 cold Flow는 viewModelScope 안에서 stateIn으로 hot 변환
        - SharingStarted.WhileSubscribed(5_000) 권장: 화면 회전 같은 짧은 구독 단절은
          업스트림을 유지하고, 진짜로 떠난 경우 5초 후 정리
        - initialValue는 sealed UI state의 Loading 상태로 명시
 
        Derived state 구성:
        - 여러 source 결합은 combine(...)으로 처리하고 그 결과를 stateIn
        - 입력에 따라 업스트림이 바뀌는 경우 flatMapLatest 사용(이전 구독 자동 취소)
        - map(SuccessFactory::Success)처럼 매핑 함수로 sealed 분기 깔끔하게
 
        Mutable 상태는 캡슐화:
        - MutableStateFlow는 private, 외부에는 StateFlow asStateFlow()/직접 val 노출
        - 사용자 액션은 fun으로 노출(예: `fun onTopicSelected(id: String)`)하고
          내부에서 viewModelScope.launch { repository.update(...) }로 처리
 
        일회성 이벤트:
        - 토스트, 네비게이션 같은 단발 이벤트는 StateFlow 부적합
        - SharedFlow(replay=0, extraBufferCapacity>=1) 또는 Channel(BufferOverflow.DROP_OLDEST) 사용
        - 가능하다면 이벤트도 상태로 환원해 SavedStateHandle에 저장 후 소비 시 비우기 검토
 
        리소스 누수:
        - Activity/Fragment/Context 참조를 ViewModel 필드에 보관 금지
          (Application Context가 꼭 필요하면 @ApplicationContext로 주입)
        - 콜백/리스너 등록은 onCleared()에서 해제
        - 직접 만든 CoroutineScope 사용 시 onCleared에서 cancel
 
        테스트:
        - 모든 의존성은 생성자 주입(테스트에서 fake/test double로 교체)
        - 테스트 dispatcher(StandardTestDispatcher) 사용 + Dispatchers.setMain
        - StateFlow 검증은 Turbine으로(`viewModel.state.test { ... }`)
        - SavedStateHandle 직접 생성해 nav args/복원 시나리오 검증

    # 1) DI 디렉터리 안의 모든 코드
    - path: "**/{di,inject}/**/*.kt"
      instructions: |
        Dependency Injection (Hilt) best practices:
 
        - @Module 클래스는 적절한 `@InstallIn` 컴포넌트(SingletonComponent, ViewModelComponent 등) 명시
        - `@Provides` 함수는 가능하면 `@Singleton`/`@ViewModelScoped` 등 명시적 스코프
        - 인터페이스 바인딩은 `@Binds`(추상 함수)로, `@Provides`보다 선호
        - Application Context가 필요한 경우 `@ApplicationContext` 한정자 사용
        - Activity Context는 라이프사이클 컴포넌트에서만 주입받기
 
        - 의존성이 너무 많은 모듈은 책임 단위로 분리
        - 테스트 모듈에서 `@TestInstallIn(replaces = ...)`을 사용해 fake로 교체 가능한지 확인
 
    # 2) /di 디렉터리 밖에 있는 모듈도 잡기 위한 파일명 패턴
    - path: "**/*Module.kt"
      instructions: |
        Hilt @Module 파일 검증:
        - @Module + @InstallIn 함께 명시
        - flavor별 모듈(예: demo/, prod/)이 있을 때 동일 키 충돌이 없는지
        - 테스트용 fake 모듈이 운영 모듈과 일관된 인터페이스를 노출하는지

    - path: "**/*.gradle.kts"
      instructions: |
        Gradle Kotlin DSL review:
 
        - 더 이상 사용하지 않는 jcenter() 저장소 사용 금지 (mavenCentral 권장)
        - 알려진 취약점이 있는 의존성 버전 확인
        - 버전 하드코딩보다 version catalog (libs.versions.toml) 사용 권장
        - deprecated된 Gradle API 사용 시 마이그레이션 코멘트
        - JVM target과 Kotlin compileSdk/targetSdk 일관성 확인
        - applicationId, versionCode, versionName이 `BuildConfig`를 통해서만 노출되는지 확인
        - signing config에 평문 keystore 비밀번호가 들어가 있지 않은지 (환경 변수/secrets로 분리)
        - 디버그 전용 라이브러리(`debugImplementation`)와 릴리즈 라이브러리 분리 확인
 
    - path: "**/libs.versions.toml"
      instructions: |
        Version catalog review:
        - 명확한 versions/libraries/plugins/bundles 분리
        - 의존성 그룹화 누락(예: Compose BOM 의존성을 bundle로 묶기) 확인
        - 동일 라이브러리의 중복 정의/충돌 확인

    - path: "**/AndroidManifest.xml"
      instructions: |
        AndroidManifest review:
 
        - 새로 추가된 위험 권한(`READ_PHONE_STATE`, `READ_CONTACTS`, `ACCESS_FINE_LOCATION` 등)에 대한 사유와 런타임 권한 요청 코드가 PR에 함께 있는지 확인
        - exported 액티비티/서비스/리시버에 대한 명시적 `android:exported` 속성과 노출 사유
        - intent-filter가 너무 광범위하지 않은지 (deeplink scheme, host)
        - `android:debuggable`, `usesCleartextTraffic`, `allowBackup`이 의도와 일치하는지
        - 백업 정책(`android:fullBackupContent`, `android:dataExtractionRules`)이 비밀 데이터를 제외하는지

    - path: "**/{test,androidTest}/**/*.kt"
      instructions: |
        Android 테스트 best practices:
 
        공통:
        - 테스트 이름은 시나리오와 기대 결과가 드러나도록 (예: `loginScreen_emptyEmail_showsError`)
        - Arrange-Act-Assert 패턴
        - 테스트는 한 가지 논리적 개념만 검증
        - 공유 가변 상태로 인한 테스트 간 의존성 금지
 
        ViewModel/Coroutine:
        - `runTest` + 주입된 TestDispatcher로 결정론적 테스트
        - StateFlow 검증은 Turbine 라이브러리 사용 권장
        - 시간 기반 테스트는 `advanceTimeBy`/`advanceUntilIdle` 활용
 
        Compose UI 테스트:
        - `createComposeRule` 또는 `createAndroidComposeRule`
        - 테스트에서 검색은 `onNodeWithText`/`onNodeWithTag`/`onNodeWithContentDescription` 사용
        - flaky 방지를 위해 `composeTestRule.waitForIdle()` 또는 `waitUntil` 활용
 
        스크린샷 테스트:
        - Roborazzi/Paparazzi 사용 시 결과 PNG 차이 검토(예: `*.snap.png`, `screenshots/` 폴더)
        - PreviewParameterProvider 활용해 라이트/다크/폰트 크기 변형을 자동 커버
        - record/verify 모드 분리 운영(record는 의도적 갱신 PR에서만)
 
        Hilt 테스트:
        - `@HiltAndroidTest` + `HiltAndroidRule` 사용
        - 모듈 교체에는 `@TestInstallIn(replaces = ProductionModule::class)` 사용
 
        매크로벤치마크/Baseline Profile:
        - `:benchmarks` 모듈에서 BaselineProfileRule, MacrobenchmarkRule 사용
        - profile 결과(`baseline-prof.txt`)가 PR에 함께 들어왔는지 확인
        - cold/warm/hot startup 시나리오와 critical user journey가 빠지지 않았는지

reviews:
  tools:
    # Kotlin 정적 분석
    detekt:
      enabled: true
      # 프로젝트 루트에 detekt.yml이 있다면 명시
      # config_file: "detekt.yml"
 
    # 시크릿 스캐닝
    gitleaks:
      enabled: true

    - path: "build-logic/**/*.kt"
      instructions: |
        Convention plugin best practices:
        - 모든 plugin 클래스명은 의도가 드러나도록(`AndroidLibraryComposeConventionPlugin` 등)
        - `pluginManager.apply(...)` 호출 시 적용 순서가 의존성 규칙과 일치하는지
        - configureAndroid()/configureKotlin() 같은 헬퍼는 한 책임만 가지도록 분리
        - 버전은 반드시 `libs.versions.toml`에서 끌어오고 하드코딩 금지
        - 새 컨벤션 추가 시 `settings.gradle.kts` 또는 `pluginManagement.includeBuild`에 등록되어 있는지
 
    - path: "**/feature/**/api/**/*.kt"
      instructions: |
        Feature API 모듈 best practices:
        - public 인터페이스만 노출, 구현 세부는 impl 모듈에 두기
        - data class·sealed interface 등 안정적 타입만 export
        - api 모듈에 Hilt @Inject 직접 사용 금지(impl로 위임)

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: ko-KR
early_access: false
 
reviews:
  profile: chill
  high_level_summary: true
  collapse_walkthrough: true
  poem: false
 
  path_filters:
    - "**/*.kt"
    - "**/*.kts"
    - "**/AndroidManifest.xml"
    - "**/*.gradle"
    - "**/*.gradle.kts"
    - "**/libs.versions.toml"
    - "!**/build/**"
    - "!**/.gradle/**"
    - "!**/out/**"
    - "!**/generated/**"
    - "!**/ksp/**"
    - "!**/kapt/**"
    - "!**/R.java"
    - "!**/BuildConfig.java"
    - "!**/databinding/**"
    - "!**/*.md"
 
  auto_review:
    enabled: true
    auto_incremental_review: true
    drafts: false
    base_branches:
      - main
      - develop
    ignore_usernames:
      - dependabot
      - "dependabot[bot]"
      - renovate
      - "renovate[bot]"
 
  path_instructions:
    - path: "**/*.kt"
      instructions: |
        Kotlin best practices: null safety(!! 금지), val 우선, structured concurrency,
        viewModelScope/lifecycleScope 사용, GlobalScope 금지, Result/sealed로 실패 표현,
        하드코딩 시크릿 금지, SecureRandom 사용.
 
    # Composable 화면 (파일명 기반 - 모듈식 프로젝트 대응)
    - path: "**/*Screen.kt"
      instructions: |
        Compose 화면: state hoisting, rememberSaveable로 구성 변경 대응,
        LaunchedEffect/DisposableEffect의 key 검증, MaterialTheme/stringResource 사용,
        하드코딩 색상·문자열 회피, contentDescription/48dp 터치 영역 접근성 점검.
 
    # 디자인 시스템·재사용 UI (NowInAndroid 식 모듈 분리 대응)
    - path: "**/core/{ui,designsystem}/**/*.kt"
      instructions: |
        디자인 시스템: @Composable PascalCase, Modifier 매개변수 디폴트와 위치,
        @Stable/@Immutable 검토(재구성 최적화), 디자인 토큰 우회 하드코딩 금지,
        @Preview 라이트/다크/폰트 변형 제공.
 
    # 단일 모듈 프로젝트 보조 패턴
    - path: "**/{ui,screen,screens,components,composables}/**/*.kt"
      instructions: |
        Jetpack Compose: @Composable PascalCase, Modifier 매개변수 디폴트와 위치,
        state hoisting, rememberSaveable로 구성 변경 대응, 데이터 클래스에 @Stable/@Immutable 검토,
        LaunchedEffect/DisposableEffect의 key 검증, MaterialTheme 사용,
        하드코딩 색상/문자열 회피, contentDescription/접근성 점검.
 
    - path: "**/*ViewModel.kt"
      instructions: |
        ViewModel: viewModelScope 기준, MutableStateFlow는 private+StateFlow 노출,
        Activity/Context 참조 보관 금지, 의존성 생성자 주입, 일회성 이벤트는 SharedFlow/Channel.
 
    - path: "**/{di,inject}/**/*.kt"
      instructions: |
        Hilt: @InstallIn 명시, 적절한 스코프, @Binds 우선, ApplicationContext 한정자 사용,
        테스트 모듈은 @TestInstallIn으로 교체 가능 구조 확인.
 
    # /di 디렉터리 밖에 있는 모듈도 잡기 위한 파일명 패턴
    - path: "**/*Module.kt"
      instructions: |
        Hilt @Module 파일: @Module + @InstallIn 함께 명시, flavor별 동일 키 충돌 점검,
        테스트용 fake 모듈이 운영 모듈과 일관된 인터페이스를 노출하는지.
 
    # 컨벤션 플러그인(build-logic) - 모듈식 프로젝트
    - path: "build-logic/**/*.kt"
      instructions: |
        Convention plugin: 클래스명에 의도 반영, 한 책임 원칙, libs.versions.toml에서 버전 끌어오기,
        plugin 적용 순서 점검.
 
    - path: "**/*.gradle.kts"
      instructions: |
        Gradle: jcenter() 금지, version catalog 사용, deprecated API 마이그레이션,
        signing config에 평문 비밀번호 금지, debug/release 의존성 분리.
 
    - path: "**/libs.versions.toml"
      instructions: |
        Version catalog: versions/libraries/plugins/bundles 정리, Compose BOM bundle 묶음,
        중복 정의 금지.
 
    - path: "**/AndroidManifest.xml"
      instructions: |
        Manifest: 위험 권한 추가에 사유/런타임 요청 동반, exported 명시,
        intent-filter scope, debuggable/cleartextTraffic/allowBackup 의도 일치 확인.
 
    - path: "**/{test,androidTest}/**/*.kt"
      instructions: |
        Android 테스트: 시나리오/기대 결과가 드러나는 이름, AAA 패턴, runTest+TestDispatcher,
        StateFlow는 Turbine, Compose UI는 createComposeRule, Hilt 테스트는 @HiltAndroidTest.
 
  tools:
    detekt:
      enabled: true
    gitleaks:
      enabled: true
 
chat:
  auto_reply: true