🐣 moabam backend

프로젝트 초기 세팅방법

checkstyle

1. Settings → Editor → Code Style → ...(점 3개) 혹은 톱니바퀴 클릭 → import style → import scheme → IntelliJ code style XML → 프로젝트 경로 /config/naver-intellij-formatter-custom.xml 선택

2. Settings → Tools → Actions on Save → Reformat code 체크

   • 이슈 : 저장해도 리포맷 안되는 경우
   • 해결 : 빈 줄에 엔터 입력 -> 저장 -> 엔터 삭제 -> 저장

3. Settings → Editor → General → Auto Import → Java -> Optimize imports on the fly 체크

4. Settings → Plugins → Marketplace -> CheckStyle-Idea 설치

   • Settings → Tools → Checkstyle -> Configuration File -> 플러스 모양 클릭 -> 이름 : naver-custom-checkstyle 입력 -> Use a Local Checkstyle File -> /config/checkstyle/checkstyle.xml -> Next 클릭 -> suppressionFile의 Value 빈칸 클릭 -> config/checkstyle/suppressions.xml 입력 -> finish 클릭 -> 생성된 것 체크(활성화) -> Apply 클릭
   • 좌측 하단 연필 모양 클릭 시, 설정한 chechkstyle에서 위배 확인 가능 또한 warning에 마우스 올릴 시 경고 원인 확인 가능

주의할 점

• 위 과정을 따르면 저장 시, 대부분 컨벤션에 맞게 수정 가능. 단, Enum.java 밑 공백은 미적용. 즉, 직접 수정해야 한다.
• 앞으로 커밋 및 푸쉬 전 gradle에서 clean 및 build하기.
• 컨벤션 틀려도 빌드 실패하니, 참고

config 파일 관리

최초 clone 하는 경우

• git clone https://github.com/team-moabam/moabam-BE.git
• git submodule init
• git submodule update

config 파일 업데이트 된 경우

• git submodule update --merge --remote

주의사항

• 평상시
  • config 파일은 수정한 본인이 아닐 시, 커밋 체크에서 무조건 빼는 것 권장
  • 만약, 커밋을 했다면 어차피 PR 못하게 버튼 사라지도록 하였음. 즉 취소 후 해당 커밋 삭제
• s3 버킷 주소 변경과 같은 상황. 즉, 반드시 바뀐 config를 적용해야 하는 상황
  • config 수정한 사람이 빠르게 dev에 push
  • feature에서 작업중인 사람은 feature 전부 stash -> develop pull -> feature에 merge -> pop stash

예시상황

• A가 config 파일 수정
  • 모든 팀원은 git submodule update --merge --remote