[Spring Boot] Kotlin Ktlint 적용하기

 

[ Ktlint ] 

ktlint는 Kotlin 코드에 대한 정적 코드 분석 및 스타일 가이드 적용 도구입니다. Kotlin 프로젝트에서 코드 스타일을 일관되게 유지하고 개발자들 간에 표준 스타일을 적용하는 데 도움을 줍니다. ktlint는 코틀린 코드를 스캔하고 정의된 스타일 규칙에 따라 코드를 자동으로 형식화하고 수정할 수 있습니다.

 

 

플러그인 사용:

• 대부분의 Kotlin 프로젝트는 ktlint 플러그인을 사용하여 빌드 스크립트에 통합합니다.
• Gradle을 사용하는 경우, build.gradle.kts 파일에 다음과 같이 플러그인을 추가할 수 있습니다:

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

 

 

.editorconfig

• .editorconfig 파일은 다양한 에디터 및 IDE에서 공통된 스타일을 유지하기 위해 사용됩니다. 여러 개발자들이 동일한 프로젝트에서 작업할 때 코드 스타일의 일관성을 유지하는 데 도움이 됩니다.
• 코드 스타일과 포맷팅 규칙을 정의하는 데 사용됩니다.
• 프로젝트 바로아래(build.gradle.kts 같은경로) .editorconfig 파일을 생성하여 줍니다.

root = true

[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 4
insert_final_newline = true
max_line_length = 120
trim_trailing_whitespace = true
no-wildcard-import=enabled

[*.{kt,kts}]
ij_kotlin_allow_trailing_comma =true

 

• root = true: 이 설정은 .editorconfig 파일이 해당 디렉토리에서 루트 수준에 있는 최상위 설정 파일임을 나타냅니다.
• [*]: 이 설정은 모든 파일 유형에 대한 기본 설정을 지정합니다.
  • charset = utf-8: UTF-8 문자 집합을 사용하도록 지정합니다.
  • end_of_line = lf: 줄 바꿈 문자를 LF (Unix 스타일)로 설정합니다.
  • indent_style = space: 들여쓰기에 공백을 사용하도록 설정합니다.
  • indent_size = 4: 들여쓰기의 크기를 4로 설정합니다.
  • insert_final_newline = true: 파일의 끝에 빈 줄을 추가하도록 지정합니다.
  • max_line_length = 120: 한 줄의 최대 길이를 120으로 설정합니다.
  • trim_trailing_whitespace = true: 줄 끝의 공백을 자동으로 제거하도록 설정합니다.
  • no-wildcard-import=enabled: 와일드카드 임포트를 허용하지 않도록 설정합니다.
• [*.{kt,kts}]: Kotlin 및 Kotlin 스크립트 파일에 대한 설정입니다.
  • ij_kotlin_allow_trailing_comma = true: IntelliJ IDEA에서 콤마 뒤에 공백을 허용하는 옵션입니다.

 

intelij 오른쪽 gradle 에서 Tasks-> formatting -> ktlintFormat을 눌러 실행시켜 주시면 됩니다.