IntelliJ에서 우아한테크코스 코딩 컨벤션 자동 적용: 코드 포매팅 & 클린코드 검사 설정 가이드

핵심 기술

본 콘텐츠는 IntelliJ IDEA에서 Google Java Style Guide 및 우아한테크코스(우테코)의 코드 스타일 가이드라인을 자동으로 적용하는 방법을 상세히 안내합니다. 이를 통해 코드 포매팅과 클린코드 위반 검사를 자동화하여 개발 생산성과 코드 품질을 향상시킬 수 있습니다.

기술적 세부사항

• 코드 스타일 포매팅 자동화: intellij-java-wooteco-style.xml 파일을 IntelliJ IDEA에 임포트하여 자동 코드 포매팅 기능을 설정합니다.
  • 주요 설정 내용: 4-space 들여쓰기, 줄바꿈 시 +8 spaces 추가 들여쓰기, 최대 120자 줄 길이, static import 후 일반 import 순서.
  • 적용 방법: Settings > Editor > Code Style > Java > ... > Import Scheme > IntelliJ IDEA code style XML 선택.
  • 활성화 후 Ctrl + Alt + L 또는 저장 시 코드 자동 정렬.
• 클린코드 위반 검사 자동화: checkstyle.xml 파일을 Checkstyle 플러그인을 통해 IntelliJ IDEA에 연동하여 클린코드 위반 시 경고를 표시합니다.
  • 주요 검사 항목: 메서드 길이 15줄 이하, 인자 수 4개 이하, 중첩 구조 1단계 이하, else 사용 금지, 복잡도(Cyclomatic Complexity) ≤ 10, 파일 길이 300줄 이하, 줄 길이 120자 이하.
  • 적용 방법: Settings > Plugins > Marketplace에서 Checkstyle 플러그인 설치 후, Settings > Tools > Checkstyle에서 checkstyle.xml 파일 등록.
• 파일 다운로드: wooteco-convention-intellij-config.zip 파일에 두 가지 설정 파일(intellij-java-wooteco-style.xml, checkstyle.xml)이 포함되어 있습니다.

개발 임팩트

• 개발자가 포매팅과 컨벤션 준수에 대한 부담 없이 코드 작성에 집중할 수 있도록 도와 개발 생산성을 크게 향상시킵니다.
• 프로젝트 전반에 걸쳐 일관된 코드 스타일을 유지하여 가독성을 높이고, 코드 리뷰 시 불필요한 논쟁을 줄여 효율적인 협업을 가능하게 합니다.
• 잠재적인 코드 품질 문제를 조기에 발견하고 수정하여 유지보수 비용을 절감합니다.

커뮤니티 반응

(원문에 커뮤니티 반응에 대한 직접적인 언급은 없으나, 이러한 자동화 설정은 개발자 커뮤니티에서 코드 품질 향상 및 생산성 증대를 위해 널리 공유되고 실천되는 방법론입니다.)