kotlin gradle 프로젝트에 ktlint 적용하기

ktlint 적용

ktlint 에서 권장하는대로 Gradle 플러그인을 사용하여 적용하겠습니다.

Kotlinter Gradle 을 사용합니다.

build.gradle.kts 에 플러그인을 추가합니다.

plugins{
    id("org.jmailen.kotlinter") version "3.2.0"
}

설정

Kotlinter Gradle 플러그인은 따로 린트 설정을 할 필요가 없습니다.

기본적으로 아래와 같은 설정이 적용됩니다.

ignoreFailures = false
indentSize = 4
reporters = arrayOf("checkstyle", "plain")
experimentalRules = false
disabledRules = emptyArray<String>()

설정을 변경하고 싶다면 .editorconfig 파일을 생성하여 적용합니다

내용은 ktlint - EditorConfig 를 참고하세요.

예시

root = true

[*.{kt, kts}]
disabled_rules = import-ordering
max_line_length = 140
charset = utf-8
end_of_line = crlf
indent_size = 2
insert_final_newline = true
trim_trailing_whitespace = false

ktlint 실행

터미널에서 다음과 같이 실행합니다.

gradlew formatKotlin lintKotlin

Main 과 Test 에 대해 포맷과 린트를 검사, 수정합니다.

gitHooks에 추가

/.git/hooks 에 pre-commit 파일을 생성합니다.

chmod +x pre-commit

pre-commit 파일의 권한을 변경합니다.

다음과 같이 작성하면 커밋시 ktlint를 실행하여 코드를 체크합니다.

#!/bin/bash

gradlew formatKotlin lintKotlin