Maven & Gradle

ktlint (kotlin lint) 적용

길순이 2022. 3. 31. 22:45

소스 코드를 분석하여 프로그램 오류, 버그, 스타일 오류, 의심스러운 구조체에 표시를 달아놓기 위한 도구입니다.

  • 개발 팀원들이 비지니스 로직에만 집중하도록 이외의 것들은 표준화 시킬 수 있습니다.
  • 때에 따라 커스텀하게 디벨롭 시켜나갈 수 있습니다.
  • 비지니스 로직 이외의 것들에 대한 표준화가 되면 유지보수 및 장애대응의 퍼포먼스를 가져갈 수 있습니다.

.editorconfig 설정

.editorconfig 파일을 기반으로 스타일 검사를 진행합니다. 자세한 내용은 EditorConfig에 설명되어 있습니다. .editorconfig 파일이 없는 경우 기본룰 Ktlint 버전에 따라서 Standard rules를 기본적으로 따르지만 버전이 변경이 되면 Standard rules로 변경이 될 수 있기 때문에 root 디렉터리에 .editorconfig파일을 설정하는 것을 권장합니다.

사용 방법

  • 아래의 formatting의 ktlint format 은 auto로 잡아 주지만 간헐적으로 소스파일을 삭제하기 때문에 조심히 사용하는 것을 권장드립니다.

빌드 성공 시:

 

빌드 실패 시:

 

IntelliJ kotlin style guide 적용 방법

  1. IntelliJ > Preferences(MacOS 기준 Command + ,) > Editor > Code Style > kotlin 메뉴로 진입
  2. 우측 상단의 (Set from...) 클릭
  3. kotlin style guide 클릭
  4. 그 다음 중간 상단 탭의 Imports 클릭
  5. Top-Level Symbols 클릭 -> Use single name import 클릭
  6. Java Statics and Enum Members -> Use single name import 클릭
  7. 아래의 Packages to Use Import with 에서 import java.util.* remove
  8. apply 후 ok 클릭

reference: