KtLint 가이드

[sunjoolee]

KtLint 가이드

번거롭겠지만, Kotlin 스타일 가이드 준수를 위해 아래 가이드 확인해주시면 감사하겠습니다! ^_^

• PR 올리기 전, 로컬 터미널에서 Lint 체크 & 포맷 명령어 실행
  • Lint 체크 명령어: ./gradlew ktlintCheck
  • 포맷 명령어: ./gradlew ktlintFormat
  • 명령어 실행 후, 터미널 로그 확인 -> 자동 포맷 실패된 내용은 소스코드 직접 수정!
  • 실패 로그 예.

  C:\Users\User\(경로 생략)\HomeResponseData.kt:8:26 A comment in a 'value_parameter_list' is only allowed when placed on a separate line (cannot be auto-corrected)
  

• PR 올린 후, ReviewDog 자동 생성 코멘트 확인
  • .editorconfig 파일 설정해놨으나, github action에 사용되는 KtLint 플러그인과 차이 존재
    -> 로컬에서 발견되지 않은 Lint 문제 있을 수 있음 ㅠㅠ
  • 코멘트 내용 확인하여, 소스코드 직접 수정!

[harry7408]

네 확인했습니다!!