CodeRabbit Kotlin Multiplatform & Compose Multiplatform 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 소스(모든 소스셋: commonMain, androidMain, iosMain, jvmMain, wasmJsMain ...)
    - "**/*.kt"
    - "**/*.kts"
    # iOS 앱 래퍼(Swift)와 권한·보안 표면
    - "**/iosApp/**/*.swift"
    - "**/AndroidManifest.xml"
    - "**/Info.plist"
    - "**/*.entitlements"
    # Gradle / 버전 카탈로그
    - "**/*.gradle.kts"
    - "**/libs.versions.toml"
    - "**/gradle.properties"
    # Compose Multiplatform 리소스(문자열 등 텍스트만)
    - "**/composeResources/**/*.xml"
 
    # Android/Gradle 빌드 산출물
    - "!**/build/**"
    - "!**/.gradle/**"
    - "!**/generated/**"
    # Kotlin/Native·KSP·KAPT 캐시 및 생성물
    - "!**/.kotlin/**"
    - "!**/ksp/**"
    - "!**/kapt/**"
    - "!**/*.klib"
    # iOS 빌드 산출물·의존성
    - "!**/DerivedData/**"
    - "!**/Pods/**"
    - "!**/*.xcodeproj/**"
    - "!**/*.xcworkspace/**"
    # Web(JS/Wasm) 의존성 스토어
    - "!**/kotlin-js-store/**"
    # 잠금/래퍼
    - "!**/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/sealed: DTO·값 객체는 data class, 제한된 상태는 sealed interface/class
 
        Coroutines:
        - Structured concurrency 준수, GlobalScope 금지
        - CoroutineDispatcher는 주입받아 테스트 결정성 확보
        - 멀티플랫폼에서 디스패처 가용성은 타깃마다 다름(아래 commonMain 규칙 참고)
 
        Error handling:
        - 예외 삼키기 금지, 실패는 Result/sealed로 표현
 
        Security:
        - 하드코딩된 secret/credential 금지
        - 멀티플랫폼 시크릿은 BuildKonfig 등으로 빌드 타임 주입, 평문 커밋 금지
 
        Multiplatform 일관성:
        - expect 선언에는 모든 타깃의 actual이 짝으로 존재해야 함
        - 공용 로직은 commonMain으로 끌어올리고, 플랫폼 차이는 최소 표면의 expect/actual로

    - path: "**/commonMain/**/*.kt"
      instructions: |
        commonMain 플랫폼 중립성 best practices:
 
        플랫폼 API 누수 금지:
        - android.*, androidx.*(멀티플랫폼 아닌 것), java.*/javax.*,
          platform.UIKit/Foundation, kotlinx.browser.* 등 플랫폼 전용 import 금지
        - 위 기능이 필요하면 expect 선언으로 추상화하고 각 actual에서 구현
        - 멀티플랫폼 라이브러리(kotlinx-coroutines, kotlinx-serialization,
          kotlinx-datetime, Ktor, SQLDelight, multiplatform-settings)만 사용
 
        디스패처/동시성:
        - Dispatchers.IO는 JS/Wasm 타깃에 없음. 웹 타깃을 포함하면 commonMain에서 직접 참조 금지
        - Dispatchers.Main도 일부 타깃에서 의존성 필요. 디스패처는 주입하거나 expect로 추상화
        - Kotlin/Native에서도 안전하도록 가변 전역 상태·스레드 가정 회피
 
        expect 선언:
        - expect는 플랫폼 차이의 "최소 표면"만 노출(가능한 한 인터페이스/함수 단위로 작게)
        - expect 클래스보다 expect fun + 공용 인터페이스 조합이 유지보수에 유리한지 검토
 
        플랫폼 자원 의존:
        - 시간(Clock), 난수, 파일 경로, 로케일 등은 직접 호출하지 말고 주입/expect로

    # 1) 화면 단위 Composable - 파일명 컨벤션
    - path: "**/*Screen.kt"
      instructions: |
        Compose Multiplatform 화면 best practices:
        - 리소스는 멀티플랫폼 리소스 사용: stringResource(Res.string.x),
          painterResource(Res.drawable.x) (org.jetbrains.compose.resources)
          → Android 전용 R.string / androidx.compose.ui.res.* 사용 금지
        - @Preview는 멀티플랫폼용(org.jetbrains.compose.ui.tooling.preview.Preview) 사용
        - 플랫폼 종속 UI(뒤로가기 처리, 시스템 바, 햅틱, 파일 피커 등)는 expect/actual로 분리
        - state hoisting: 비즈니스 상태를 ViewModel/StateHolder로, Composable은 stateless 지향
        - LaunchedEffect/DisposableEffect의 key 검증, rememberSaveable로 상태 보존
        - 하드코딩 색상/문자열 회피(MaterialTheme + 멀티플랫폼 리소스), 접근성 contentDescription
 
    # 2) 공용 UI / 디자인 시스템 디렉터리(commonMain)
    - path: "**/commonMain/**/{ui,designsystem,components}/**/*.kt"
      instructions: |
        공유 디자인 시스템 best practices:
        - @Composable 함수명은 PascalCase, Modifier 매개변수는 default와 첫 옵셔널 위치
        - 매개변수 데이터 클래스에 @Stable/@Immutable 검토(재구성 최적화)
        - 플랫폼 분기는 expect/actual 또는 LocalPlatform 같은 주입으로, 직접 분기 회피
        - 멀티플랫폼 리소스(Res.*)만 사용, Android 리소스 API 금지
        - @Preview(멀티플랫폼)에 라이트/다크 변형 제공

    - path: "**/{androidMain,iosMain,jvmMain,desktopMain,jsMain,wasmJsMain,nativeMain,appleMain}/**/*.kt"
      instructions: |
        플랫폼 소스셋(actual) best practices:
 
        actual 정합성:
        - actual 선언이 commonMain의 expect 시그니처와 정확히 일치하는지(가시성 포함)
        - 플랫폼 구현 세부는 internal로 캡슐화하고 공용 표면을 늘리지 않기
 
        Android(androidMain):
        - Activity/Context를 long-lived 객체에 보관 금지(메모리 누수)
        - androidx ViewModel/lifecycle은 androidMain에서만, commonMain으로 끌어올리지 않기
 
        iOS(iosMain, appleMain):
        - Kotlin/Native interop 시 메인 스레드 가정 주의(Dispatchers.Main 사용 가능 여부)
        - UIKit/Foundation 호출은 iosMain에 가두고, 공용 인터페이스로만 노출
        - 무거운 작업의 스레드 컨텍스트 전환이 명확한지
 
        JVM/Desktop, JS/Wasm:
        - 데스크톱 전용 파일 시스템/스레딩, 웹 전용 DOM/브라우저 API가 해당 소스셋에만 있는지

    # 공유 모듈이 iOS로 노출하는 Swift 측 소비 코드
    - path: "**/iosApp/**/*.swift"
      instructions: |
        KMP ↔ Swift interop best practices:
        - 공유 모듈의 suspend 함수/Flow를 Swift에서 직접 다루기 어렵다면
          SKIE 또는 KMP-NativeCoroutines로 async/AsyncSequence 브리징 사용
        - 공유 코드가 던지는 에러를 Swift do/catch로 적절히 처리(KotlinException 누수 방지)
        - 공유 타입을 Swift에서 강제 캐스팅(as!)하지 말고 안전하게 처리
        - 메인 스레드 가정: UI 갱신은 메인에서, 공유 모듈 콜백의 스레드 확인
        - Swift 측 코드 스타일·메모리(클로저 [weak self])는 iOS 가이드 규칙과 동일하게 적용

    # 1) DI 디렉터리
    - path: "**/{di,koin,inject}/**/*.kt"
      instructions: |
        Multiplatform DI(Koin) best practices:
        - 공용 모듈은 commonMain의 module { } 로 정의, 플랫폼 의존은 expect fun platformModule(): Module
        - single/factory/scoped 수명이 의도와 일치하는지(특히 single 남용 주의)
        - 의존성은 인터페이스 바인딩 우선, 구체 타입 직접 결합 회피(테스트 교체 가능성)
        - initKoin(...) 진입점에서 플랫폼 모듈이 빠짐없이 등록되는지
        - Android 전용 DI(Hilt) 어노테이션이 commonMain에 들어오지 않았는지
        - 순환 의존성 금지
 
    # 2) /di 디렉터리 밖 모듈 정의도 잡기 위한 파일명 패턴
    - path: "**/*Module.kt"
      instructions: |
        Koin @Module/module { } 검증:
        - 플랫폼별 actual module이 commonMain expect와 일관된 의존성을 제공하는지
        - 테스트용 모듈이 운영 모듈과 동일한 인터페이스를 노출하는지

    - path: "**/build.gradle.kts"
      instructions: |
        Gradle Kotlin Multiplatform review:
        - kotlin { } 타깃 선언이 프로젝트 지원 플랫폼과 일치(androidTarget, iosX64/Arm64/SimulatorArm64, jvm, wasmJs 등)
        - sourceSets 의존성이 올바른 위치에 선언됐는지
          (멀티플랫폼 라이브러리는 commonMain.dependencies, 플랫폼 전용은 해당 소스셋)
        - 의존성은 버전 하드코딩보다 version catalog(libs.versions.toml) 사용
        - iOS framework 블록: baseName 일관성, isStatic/export 설정 의도 확인
        - cocoapods 또는 XCFramework 배포 설정이 일관적인지
        - Compose Multiplatform 플러그인/리소스 설정과 compiler optIn 적절성
        - deprecated된 Gradle/KMP DSL 사용 시 마이그레이션 코멘트
 
    - path: "**/libs.versions.toml"
      instructions: |
        Version catalog review:
        - versions/libraries/plugins/bundles 분리, 멀티플랫폼 라이브러리 버전 일관성
        - Compose Multiplatform/Kotlin/AGP 버전 호환 조합 확인
        - 동일 라이브러리 중복 정의/충돌 확인

    - path: "**/AndroidManifest.xml"
      instructions: |
        AndroidManifest review:
        - 새 위험 권한에 사유와 런타임 요청 코드 동반, exported 명시,
          intent-filter scope, debuggable/cleartextTraffic/allowBackup 의도 일치.
 
    - path: "**/Info.plist"
      instructions: |
        Info.plist review:
        - 개인정보 권한 키에 사유 문자열 + 런타임 요청 코드 동반,
          ATS 전역 허용(NSAllowsArbitraryLoads) 금지, URL scheme·백그라운드 모드 과도 여부 점검.

    - path: "**/commonTest/**/*.kt"
      instructions: |
        commonTest best practices:
        - kotlin.test(assertEquals 등) + kotlinx-coroutines-test(runTest) 사용
        - 플랫폼 전용 API 사용 금지(commonTest는 전 타깃에서 컴파일·실행)
        - StateFlow/Flow 검증은 Turbine(멀티플랫폼) 사용
        - 의존성은 fake/test double로 주입, 외부 통신·디스크 접근 금지
        - Compose UI 테스트는 runComposeUiTest 등 멀티플랫폼 API로
 
    - path: "**/{androidUnitTest,androidInstrumentedTest,iosTest,jvmTest,desktopTest}/**/*.kt"
      instructions: |
        플랫폼별 테스트 best practices:
        - 해당 플랫폼 특화 동작(actual 구현, 플랫폼 통합)만 검증
        - 시나리오/기대 결과가 드러나는 테스트 이름, AAA 패턴
        - 안드로이드 계측 테스트/iOS 테스트의 메인 스레드·디스패처 가정 확인

reviews:
  tools:
    # Kotlin 정적 분석(공유·Android·JVM 코드 전반)
    detekt:
      enabled: true
      # config_file: "config/detekt/detekt.yml"
 
    # iosApp의 Swift 코드 정적 분석
    swiftlint:
      enabled: true
 
    # 시크릿 스캐닝
    gitleaks:
      enabled: true

    # 공유 기능 모듈의 공개 API 경계
    - path: "**/feature/**/commonMain/**/*.kt"
      instructions: |
        공유 기능 모듈 best practices:
        - public으로 노출하는 타입 최소화, 구현 세부는 internal로 은닉
        - 기능 모듈 간 직접 의존 금지(core/shared 모듈 경유), 단방향 의존성
        - 공용 표면은 안정적 값 타입(data class/sealed) 위주로
 
    # 컨벤션 플러그인(build-logic) - 모듈식 프로젝트
    - path: "build-logic/**/*.kt"
      instructions: |
        Convention plugin best practices:
        - KMP 타깃·소스셋 설정을 헬퍼로 일원화하고 한 책임만 갖도록 분리
        - 버전은 libs.versions.toml에서 끌어오고 하드코딩 금지
        - 새 컨벤션은 settings.gradle.kts/pluginManagement에 등록됐는지

# 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"
    - "**/iosApp/**/*.swift"
    - "**/AndroidManifest.xml"
    - "**/Info.plist"
    - "**/*.entitlements"
    - "**/*.gradle.kts"
    - "**/libs.versions.toml"
    - "**/composeResources/**/*.xml"
    - "!**/build/**"
    - "!**/.gradle/**"
    - "!**/.kotlin/**"
    - "!**/generated/**"
    - "!**/ksp/**"
    - "!**/kapt/**"
    - "!**/*.klib"
    - "!**/DerivedData/**"
    - "!**/Pods/**"
    - "!**/*.xcodeproj/**"
    - "!**/*.xcworkspace/**"
    - "!**/kotlin-js-store/**"
 
  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,
        디스패처 주입, GlobalScope 금지, Result/sealed로 실패 표현, 하드코딩 시크릿 금지,
        expect에는 모든 타깃의 actual이 짝으로 존재.
 
    # commonMain 플랫폼 중립성 (KMP 핵심)
    - path: "**/commonMain/**/*.kt"
      instructions: |
        commonMain: 플랫폼 전용 API(android.*, java.*, platform.UIKit, kotlinx.browser) 금지,
        멀티플랫폼 라이브러리만 사용, Dispatchers.IO는 JS/Wasm 미지원이니 직접 참조 금지(주입/expect),
        플랫폼 자원(시간·난수·파일)은 expect/주입으로 추상화.
 
    # Compose Multiplatform 화면
    - path: "**/*Screen.kt"
      instructions: |
        CMP 화면: 멀티플랫폼 리소스(Res.string/Res.drawable, org.jetbrains.compose.resources) 사용,
        Android R.string/androidx.compose.ui.res 금지, @Preview는 멀티플랫폼용,
        플랫폼 종속 UI는 expect/actual, state hoisting, LaunchedEffect key 검증, 접근성.
 
    # 공유 디자인 시스템(commonMain)
    - path: "**/commonMain/**/{ui,designsystem,components}/**/*.kt"
      instructions: |
        공유 디자인 시스템: @Composable PascalCase, Modifier 디폴트·위치,
        @Stable/@Immutable 검토, 플랫폼 분기는 expect/actual, 멀티플랫폼 리소스만 사용.
 
    # 플랫폼 소스셋(actual 구현)
    - path: "**/{androidMain,iosMain,jvmMain,desktopMain,jsMain,wasmJsMain,nativeMain,appleMain}/**/*.kt"
      instructions: |
        플랫폼 소스셋: actual이 expect 시그니처(가시성 포함)와 일치, 플랫폼 세부는 internal 캡슐화,
        androidMain은 Context 누수 금지·lifecycle은 여기서만, iosMain은 메인 스레드 가정·UIKit 가두기.
 
    # KMP ↔ Swift interop (iOS 앱 래퍼)
    - path: "**/iosApp/**/*.swift"
      instructions: |
        Swift interop: 공유 모듈 suspend/Flow는 SKIE/NativeCoroutines로 브리징,
        KotlinException은 do/catch 처리, 강제 캐스팅(as!) 회피, UI는 메인 스레드,
        클로저 [weak self]로 순환 참조 방지.
 
    # DI(Koin)
    - path: "**/{di,koin,inject}/**/*.kt"
      instructions: |
        Koin: 공용 모듈은 commonMain module { }, 플랫폼은 expect fun platformModule(),
        single/factory 수명 점검, 인터페이스 바인딩 우선, initKoin에 플랫폼 모듈 누락 없는지,
        Hilt 어노테이션이 commonMain에 들어오지 않았는지.
 
    - path: "**/*Module.kt"
      instructions: |
        Koin module 파일: 플랫폼 actual module이 commonMain expect와 일관된 의존성 제공,
        테스트 모듈이 운영 모듈과 동일 인터페이스 노출.
 
    # build-logic 컨벤션 플러그인
    - path: "build-logic/**/*.kt"
      instructions: |
        Convention plugin: KMP 타깃/소스셋 설정 일원화, 한 책임 원칙,
        libs.versions.toml에서 버전 끌어오기.
 
    - path: "**/build.gradle.kts"
      instructions: |
        Gradle KMP: kotlin{} 타깃 일관성, 의존성을 올바른 소스셋에 선언
        (멀티플랫폼은 commonMain, 플랫폼 전용은 해당 소스셋), version catalog 사용,
        iOS framework baseName/isStatic/export 일관성, Compose/compiler optIn 적절성.
 
    - path: "**/libs.versions.toml"
      instructions: |
        Version catalog: 멀티플랫폼 라이브러리 버전 일관성,
        Compose Multiplatform/Kotlin/AGP 호환 조합, 중복 정의 금지.
 
    - path: "**/AndroidManifest.xml"
      instructions: |
        Manifest: 위험 권한에 사유/런타임 요청 동반, exported 명시, intent-filter scope,
        debuggable/cleartextTraffic/allowBackup 의도 일치.
 
    - path: "**/Info.plist"
      instructions: |
        Info.plist: 개인정보 권한에 사유 문자열+런타임 요청 동반,
        ATS 전역 허용 금지, URL scheme·백그라운드 모드 과도 여부 점검.
 
    - path: "**/commonTest/**/*.kt"
      instructions: |
        commonTest: kotlin.test + runTest, 플랫폼 API 금지(전 타깃 실행),
        Flow는 Turbine, 의존성은 fake 주입, Compose UI는 runComposeUiTest.
 
    - path: "**/{androidUnitTest,androidInstrumentedTest,iosTest,jvmTest,desktopTest}/**/*.kt"
      instructions: |
        플랫폼별 테스트: 플랫폼 특화 동작·actual만 검증, 시나리오/기대가 드러나는 이름,
        AAA 패턴, 메인 스레드·디스패처 가정 확인.
 
  tools:
    detekt:
      enabled: true
    swiftlint:
      enabled: true
    gitleaks:
      enabled: true
 
chat:
  auto_reply: true