agents.md

AI Agent Development Guidelines

🚀 필수 실행 지침

⚠️ 코드 편집 완료 후 필수 작업

# 모든 Kotlin 코드 편집이 완료되면 반드시 실행
./gradlew detekt

중요: detektFormat은 존재하지 않는 task입니다. ./gradlew detekt를 사용하세요.

목적:

• 코드 분석 및 품질 검사
• 자동 formatting 적용 (autoCorrect: true 설정)
• ktlint 규칙 및 Compose 규칙 적용
• 일관된 코드 품질 유지

📋 프로젝트 설정 정보

🔧 도구 구성

• detekt: 1.23.7 (기본 룰셋 사용)
• ktlint: detekt-formatting을 통해 통합
• Compose Rules: 0.4.14 (Compose 전용 규칙)

📏 코딩 규칙

• 최대 라인 길이: 120자
• Composable 함수: 대문자로 시작, modifier 매개변수 필수
• 네이밍: Android 컨벤션 준수 (camelCase, PascalCase)
• 들여쓰기: 4 spaces

🎯 주요 체크 포인트

1. Modifier 관련:

   • 모든 Composable에 modifier 매개변수 포함
   • modifier에 기본값 = Modifier 설정
   • Root에서 modifier 사용 확인

2. CompositionLocal 사용:

   • 허용된 CompositionLocal만 사용
   • 네이밍 규칙: Local 접두사

3. 매개변수 순서:

   • Composable에서 modifier는 첫 번째 선택적 매개변수
   • lambda는 마지막 매개변수

🛠️ detekt 사용법

사용 가능한 task들

# 기본 detekt 실행 (분석 + 자동 formatting)
./gradlew detekt

# 다른 유용한 task들
./gradlew detektMain        # production 코드만 분석
./gradlew detektTest        # test 코드만 분석
./gradlew detektBaseline    # baseline 파일 생성

주요 이슈 유형

• Formatting: autoCorrect로 자동 수정됨
• Complexity: 수동 리팩토링 필요 (함수 분할, 매개변수 축소)
• Naming: 네이밍 컨벤션 수동 수정
• Compose: Compose 규칙 준수 확인

예외 처리 설정 완료

• @Composable: complexity 규칙에서 제외
• @Preview: UnusedPrivateMember에서 제외
• modifier: UnusedParameter에서 제외
• fromXXX: ReturnCount에서 제외

📚 참고 리소스

• Compose Rules
• detekt Documentation
• Android Coding Style