IntelliJ에 Google-Java-Style-format 적용및 Git에서 체크하는 과정

1) Google-Java-Style-Format 적용 배경

스프링 프로젝트를 진행하는 와중에 팀원들마다 코딩 스타일이라던지 들여쓰기 등이 다르다 보니 코드 리뷰를 할 때 가독성이 떨어진다는 느낌을 받았습니다.

그래서 팀원들끼리 코드 스타일을 어떻게 통일할 지 고민하던 와중 Google에서 코드 스타일을 통일해주는 format이 있다는 걸 알게 되었으며, 저희 프로젝트에 적용해보고자 합니다.

2) Google-Java-Style-Format 적용 방법

• 1) IntelliJ IDEA -> Preferences 접속
  

• 2) Preferences -> Editor -> Code Style 접속
  

• 3) Scheme -> Import Scheme -> IntelliJ IDEA code style XML
  

• 4) https://github.com/google/styleguide 에 접속하여 intellij-java-google-style.xml 파일을 다운 후, 아래와 같이 파일 open 후 저장
  

• 5) GoogleStyle로 변경완료
  

3) Google-Java-Style-Format 사용법

위에 절차를 따르고, Mac기준 Option+Command+L 키를 누르시면 Google-Java-Style-Format 에 맞게 코드가 변경됩니다.

4) Git에서 Google-Java-Style-Format이 통일되었는 지 체크

아래와 같은 google-java-format.yml 파일을 작성하면 Pull Request나 Merge를 할 때 Google-Java-Style-Format 을 지켰는 지 테스트 해줍니다.

name: google-java-format # 워크플로우의 이름
on: [ push, pull_request ] # 깃 저장소의 push, pull_request 이벤트에 의해 트리거된다.
jobs:
  formatting:
    runs-on: ubuntu-latest # 워크플로우의 이름
    steps:
      - uses: actions/checkout@v2 # 깃허브 저장소를 체크아웃 하는 액션
      - uses: axel-op/googlejavaformat-action@v3 # 본격적인 google-java-format 실행
        with:
          args: "--replace" # --replace (파일을 수정한다)
          commit-message: "style: google-java-format"

Google-Java-Style-Format을 지켰으면 초록색 체크표시가 뜨며, 지키지 못한 경우 저 처럼 빨간 x 표시가 뜹니다.