Ktlint에 대해 알아보자

오늘의 코틀린 이야기는 Ktlint이다.

열심히 코딩을 하다보면, 코딩인벤션을 제대로 지켰는지, 띄어쓰기는 제대로했는지 의문을 가질때가 있다.




물론 crtl+alt+L을 수도없이 누르기는 한다지만..

코틀린 스타일가이드

물론 회사에서 케바케인만큼 확실하게 이렇다 말은 못하겠지만, 구글 공식사이트에 따르면 코틀린 스타일 가이드가 존재하고, 지금 알아볼 Ktlint는 위의 스타일 가이드에 따라 코드를 검사해준다.

코드를 검사하고!! 심지어!! 변환까지 해준다😍😎😋

이제 알아보자.

일단 라이브러리부터 다운받아야 한다.

jlleitschuh/ktlint-gradle

fork한것중에서도 이것을 가장 많이 쓴다고 들었다. 일단 플러그인을 설치하고 가장 최신버전을 적는다.

plugins {
  id "org.jlleitschuh.gradle.ktlint" version "<current_version>"
  id "org.jlleitschuh.gradle.ktlint-idea"   version "<current_version>"
}

그리고 앱의 root에 .editorConfig를 만들어서 아래의것을 복사 붙여넣기 해준다.

root = true

[*]
charset=utf-8
end_of_line=lf
indent_style=space
indent_size=4
insert_final_newline=true
disabled_rules=no-wildcard-imports,import-ordering,comment-spacing

[*.{kt,kts}]
insert_final_newline=false

오른쪽의 Gradle을 클릭하면, 상단 메뉴에 코끼리그림이 그려진것이 있을것이다.

gradlew ktlintCheck

여기서 아래의 코드를 입력할때 검사를 할수있다.

gradlew ktlintCheck

입력시 로딩창이 뜨면서 무엇이 잘못되었는지 확인할수 있다.

gradlew ktlintFormat

ktlintFormat

위의 코드를 입력할 시, ktlint가 스타일가이드 대로 변환 시켜준다.
실무에서나, 토이프로젝트에서나 유용하게 쓰일것같다.