개요

실무에서 다양한 이유로 코딩 컨벤션을 정의하고 프로덕트 개발을 진행하게 됩니다. 자바 진영에서는 Google 코딩 컨벤션을 기준으로 확장에서 많이 사용하는데요.

코틀린 진영에서는 Jetbrain에서 공식적으로 제공하는 코딩 컨벤션을 제공합니다. 아래의 코딩 컨벤션을 기준으로 개발환경을 구성하는 방법을 알아보도록 하겠습니다.

Coding conventions | Kotlin

ktlint

ktlint는 Kotlin의 공식 가이드 기반으로 코드 스타일을 검사해 주는 도구입니다. gradle plugin을 통해서 보다 쉽게 설정할수 있습니다.

우리는 ktlint를 Wrapping 한 jlleitschuh/ktlint-gradle 플러그인을 사용해 보도록 하겠습니다.

Gradle 설정

아래와 같이 gradle.build 파일에 플러그인 설정을 추가합니다.

plugins {
    id("org.jlleitschuh.gradle.ktlint") version "10.0.0"
}

JLLeitschuh/ktlint-gradle

위의 플러그인 추가 만으로 우리는 코드 스타일 검사를 위한 최소한의 준비가 끝났습니다.

.editorconfig 파일 설정

EditorConfig 은 디렉토리 수준에서 코드 스타일을 정의하고 관리할 수 있는 기능을 제공합니다.

여기서 의문이 발생하는 지점이 생기실 텐데요. ktlint 와 역할이 겹치는 부분이 존재하는거 같은데 왜 설정하는 걸까? 라고 궁금해하실거 같습니다. EditorConfig를 사용하는 이유는 아래와 같습니다.