💡 Tips!

🔍 Lint

Lint는 소스 코드를 분석하여 프로그램 오류, 버그, 스타일 오류, 의심스러운 구조 등을 찾아내는 도구입니다. 이번 프로젝트에서는 코드 스타일의 통일성을 유지하기 위해 Lint를 사용하였습니다. 또한, GitHub Actions와 연동하여 PR 요청 시 Lint를 이용해 코드 스타일을 자동으로 확인하고 있습니다.

Lint 도구에는 여러 종류가 있는데, 그중 Kotlin 진영에서 통일된 스타일 유지에 적합한 ktlint를 선택했습니다. .editorconfig 파일을 통해 Lint와 Android Studio의 포맷팅을 설정할 수 있어 편리합니다.

수동 확인

현재 작성된 코드의 스타일이 적절한지 확인하고 싶으시다면, 터미널에서 다음 명령어를 실행해 보세요:

./gradlew ktlintCheck

실행 결과는 빌드 창에서 바로 확인할 수 있습니다. 더 자세한 내용을 보고 싶으시다면, build/reports/ktlint 경로에 생성된 보고서를 참고해 주세요.

자동 포맷

Lint 규칙이 적용되지 않은 코드 중 자동 포맷팅이 가능한 경우, 다음 명령어를 통해 간편하게 수정할 수 있습니다:

./gradlew ktlintFormat

단, 모든 규칙을 자동으로 수정할 수 있는 것은 아닙니다. 자동 포맷팅이 실패한 경우에는 직접 코드를 확인하고 수정해 주시기 바랍니다.

추가 팁

IntelliJ(Android Studio)에서는 터미널을 이용하는 것보다 더 쉽게 Lint를 사용할 수 있는 방법이 있습니다.

1. Ctrl 키를 빠르게 두 번 누르면 빠른 실행 창이 나타납니다.
2. 이 창에서 위에서 언급한 명령어를 실행할 수 있습니다.
3. 최소 한 번이라도 빠른 실행 창에서 명령을 수행했다면, 다음부터는 더욱 간편하게 이용할 수 있습니다.

위 이미지처럼 실행 창에 Lint 관련 옵션이 추가되어, 쉽게 실행할 수 있습니다.

이렇게 Lint를 활용하면 팀 전체의 코드 품질을 향상시키고, 일관된 스타일을 유지하는 데 큰 도움이 됩니다.

🤖 Android Studio 설정

커밋시 자동 적용

Settings > Version Control > Commit

• Reformat code(체크 추천: 코드 자동 정렬)
• Optimize imports(체크 추천: 사용하지 않는 import 제거)

cleanup은 조금 위험할 수 있음

EOF(파일 끝에 빈 줄 추가)

EOF가 필요한 이유

Settings > Editor > General > On Save

• Remove trailing blank lines at the end of the file(체크 추천: 파일 끝에 빈 줄이 많다면 제거)
• Ensure every file ends with a line break(체크 추천: 파일 끝에 빈 줄이 없다면 추가)