📑 코틀린 컨벤션

Ktlint

https://github.com/JLLeitschuh/ktlint-gradle 사용

적용중인 .editorconfig

root = true

[*]
charset=utf-8
end_of_line=lf
indent_style=space
indent_size=4
insert_final_newline=false

[*.{kt,kts}]
disabled_rules=no-wildcard-imports,import-ordering,comment-spacing,no-blank-line-before-rbrace

주요 명령어

• ./gradlew ktlintCheck - 모든 코틀린 파일들 체크
• ./gradlew ktlintFormat - 모든 코틀린 파일들 코드 스타일에 맞게 수정
• ./gradlew addKtlintCheckGitPreCommitHook - staged file들 check
• ./gradlew addKtlintFormatGitPreCommitHook - staged file들 format
• rm .git/hooks/pre-commit - git hook 제거(만약 다른 git hook한거있으면 같이 없어질듯함)

프로퍼티

val addTaskViewModel: AddTaskViewModel by viewModels()
val addTaskAdapter = AddTaskAdapter()

클래스 내부 함수 배치 순서

• 프로퍼티
• 생성자
• init
• override 함수 (lifecycle 등)
• public 함수
• private 함수
• 다른 class, interface, enum, data class
• companion object

개행

interface Example {
	//개행
	fun A()

	fun B()

	fun C()
	//개행
}

class Sample() : Example {
	//개행
	private val binding

	fun function()

	companion object {
			
	}
	//개행
}

• 클래스, 인터페이스 내 맨 위와 아래는 한 줄씩 띄운다.
• 프로퍼티는 붙여쓰되, 종류가 많아지면 개행으로 구분한다.

Enum

enum class ProductType {

}

• [What]Type

Scope 함수

• apply, also, with, let, run
  • Scope 함수 3개 이상 중첩 지양
  • Scope 함수 중첩 시 it 지양

상수

• resource -> 화면에 보이는가를 기준으로 string.xml에 분리 결정 Android intent extra name은 companion에 const val 선언
  • ex: EXTRA_TITLE_ID = "title_id" 상수 네이밍은 upper snake case
• 의미 있는 숫자, 문자열은 companion에 const val 선언
  • ex: LOOP_COUNT = 10

Layer간 매핑 방식

매핑 함수명

• <자료형>.to[자료형]()

fun ProductResoponseBody.toProduct() = Product()

매핑 작업 Layer

• [DATA]repository: <type>responsebody/entity <-> <type>
• [VIEW]viewmodel, view : <type> <-> <type>UiState

//repository..
fun <type>ResoponseBody.to<type>() = <type>()
fun <type>.to<type>ResoponseBody() = <type>ResoponseBody()

fun <type>Entity.to<type>() = <type>()
fun <type>.to<type>Entity() = <type>Entity()

//viewmodel or view..
fun <type>UiState.to<type>() = <type>()
fun <type>.to<type>UiState() = <type>UiState()

테스트 함수 네이밍

• <테스트 이름>_<케이스 이름>

fun signUp_DuplicateID()

주석

• //comment

//comment

참고 : Kotlin style guide | Android Developers