[AN] Bottari Convention Plugin Guide

📘 Bottari Convention Plugin Guide

멀티모듈 Android 프로젝트의 빌드 설정을 중앙화하고,
모듈 간 일관된 개발 경험을 제공하기 위해 설계된 Convention Plugin 세트입니다.

각 플러그인은 역할·적용 영역·사용 방법을 기준으로 구성되어 있으며,
실제 프로젝트에서는 alias(libs.plugins.bottari.*) 형태로 선언해 사용합니다.

1. Overview

Convention Plugin의 목적은 다음과 같습니다.

• 반복되는 Android/Kotlin 설정 제거
• 모듈 간 compileSdk/minSdk 등 환경 통일
• 라이브러리/Feature/App 레벨의 공통 로직 자동화
• Compose, Hilt, KSP 등 종속된 기능을 선언적 방식으로 활성화
• 모듈 구조가 커져도 유지관리 비용이 증가하지 않는 환경 구성

프로젝트 내 플러그인 구성은 다음과 같이 나뉩니다.

Plugin	Target	Purpose
AndroidApplicationConventionPlugin	app	기본 Android/Kotlin 설정
AndroidApplicationComposeConventionPlugin	app	Compose 세팅
AndroidLibraryConventionPlugin	library modules	공통 라이브러리 설정
AndroidLibraryComposeConventionPlugin	library modules	Compose + 라이브러리
AndroidFeatureConventionPlugin	feature modules	Feature 조합형 플러그인
AndroidHiltConventionPlugin	any	Hilt/KSP 설정
JvmKotlinConventionPlugin	domain	순수 JVM 모듈 설정

2. Plugin Details

2.1. AndroidApplicationConventionPlugin

✔ 역할

• compileSdk/minSdk/targetSdk 기본 설정
• versionCode, versionName 자동 주입
• debug/release buildTypes 정의 (minify 옵션 포함)
• :domain, :di, :presentation, :logger 기본 의존성 연결
• Kotlin 옵션(JVM Target 등) 통일 적용

2.2. AndroidApplicationComposeConventionPlugin

✔ 역할

• Compose build feature 자동 활성화
• Compose BOM 및 핵심 라이브러리 추가 (material, ui-tooling 등)
• Debug Tooling Preview 환경 구성

2.3. AndroidLibraryConventionPlugin

✔ 역할
Android 라이브러리 모듈에서 공통 설정을 제공:

• compileSdk/minSdk/targetSdk 일관화
• 라이브러리용 buildTypes 구성
• 테스트 타겟 환경 통일
• Java/Kotlin 설정 공통화

2.4. AndroidLibraryComposeConventionPlugin

✔ 역할
Compose UI가 포함된 라이브러리 모듈에서 필요한 설정을 자동 적용:

• Compose build feature
• Compose BOM 및 기본 의존성
• Preview/Tooling 지원

2.5. AndroidFeatureConventionPlugin

Feature 모듈을 위한 조합형 플러그인입니다.

✔ 역할
다음 플러그인을 한 번에 적용:

• AndroidLibraryConventionPlugin
• AndroidLibraryComposeConventionPlugin
• AndroidHiltConventionPlugin 기본 의존성을 자동 추가:
• :domain
• :di
• :logger

2.6. AndroidHiltConventionPlugin

✔ 역할

• Hilt 플러그인 자동 적용
• KSP 적용 및 Hilt compiler 연결
• Hilt core/runtime 의존성 자동 주입

2.7. JvmKotlinConventionPlugin

Android 비의존 모듈(domain 등)을 위한 JVM 설정 플러그인.

✔ 역할

• kotlin-jvm, java-library 플러그인 자동 적용
• JDK/Toolchain 통일
• JVM Target 중앙 설정
• 테스트 환경 기본 설정

---

3. Benefits

Convention Plugin을 적용하면 얻을 수 있는 효과는 다음과 같습니다.
✔ 일관된 빌드 환경

모든 Android/Kotlin 컴파일 옵션을 하나의 구조에서 관리.

✔ 모듈 설정 누락 방지

각 모듈에서 빌드 옵션을 직접 관리할 필요 없음.

✔ 코드 중복 감소

build.gradle.kts 파일들이 50% 이상 간결해짐.

✔ 유지보수성 향상

SDK 버전, Compose 버전, Hilt 의존성이 모두 중앙에서 관리됨.

✔ 모듈 증가에도 관리 비용 일정

프로젝트 구조가 커져도 설정 복잡도가 증가하지 않음.