코틀린 코드 스타일을 자동으로(ktlint)

Published: by

ktlint란?

개발자에게 코틀린 코드 스타일 가이드에 맞는 방법을 알려주고, 포멧을 변경해주는 오픈소스다.

ktlint 사용법

./gradlew ktlint

ktlint는 우리가(?) 잘 알고 있는 린트를 잡아준다. 몇 번째 라인에 무슨 문제가 있는지 상세하게 알려준다.

./gradlew ktlintFormat

ktlintFormat은 실제로 포멧을 변경해준다.

위의 두 가지 명령은 안드로이드 스튜디오 메뉴에서도 실행 가능하다. gradle > 앱명 > app > Tasks > other > ktlint 또는 ktlintFormat을 실행하면 된다.

ktlint 설치 및 설정

https://www.androidhuman.com/lecture/kotlin/2016/09/06/ktlint_on_android/

ktlint에서 권장하는 설치 및 사용법

설치

brew install ktlint
Updating Homebrew...
==> Auto-updated Homebrew!
Updated 1 tap (homebrew/core).
==> Updated Formulae
astrometry-net          cfitsio                 cpl                     gdal                    llvm                    root                    swiftformat             vips
ccfits                  checkstyle              direnv                  healpix                 mpv                     siril                   vim                     wcslib

==> Downloading https://github.com/pinterest/ktlint/releases/download/0.36.0/ktlint
Already downloaded:/Users/peter/Library/Caches/Homebrew/downloads/b4a278246b4e--ktlint
🍺  /usr/local/Cellar/ktlint/0.36.0: 3 files, 48MB, built in 4 seconds

사용

ktlint applyToIDEAProject
# or if you want to be compliant with Android Kotlin Style Guide
ktlint --android applyToIDEAProject

결론

설치 방법은 ktlint에서 권장하는 방법(plugin)이 나아보인다. 이는 프로젝트마다 설정할 필요가 없어지기 때문이다.

코드 스타일 가드이를 하나하나 눈여겨 보기란 쉽지 않고, 불가능하다. 팀원들과 함께 개발한다면 더더욱 ktlint와 같은 도구를 사용해야 한다.