240109 TIL - Spotless

오늘은 이번 팀 프로젝트의 컨벤션 중 하나인 spotless 를 정리해보겠다. 

spotless란 코드 포맷을 원하는 방식으로 제한을 두어서 팀원들이 모두 같은 포맷으로 코드를 작성할 수 있도록 도와주는 spring의 기능이다. 우리 팀에서는 아래와같이 spotless규칙을 설정해 두었다. 

 

 우리 팀에서는 처음에는 commit시에 자동으로 spotless가 적용되어서 commit될 수 있게 프로젝트의 root디렉토리에서 .git/hooks/pre-commit 파일에 스크립트를 추가해서 사용하려고 했지만 커밋하려고 체크한 파일들만 spotless적용에 실패해서 Github CI의 기능을 사용해서 ./gradlew spotlessApply를 하지 않고 포맷이다르게 푸쉬된뒤 PullRequest를 하게되면 머지에 실패하도록 

gradle.yml파일에 코드를 위처럼 추가 해주었고

 

이와 같이 PR시에 Spotless Check를 해주는 모습을 확인하였다. 이번프로젝트를 할 때 팀원분들의 의견이 모여서 통일된 코드를 향해 가는 모습을 보니 협업하고있다는 것을 다시 한 번 느끼는 것 같다. 오늘도 밤늦게까지 팀원들과 의견을 맞추었고 spotless부분은 해결이 되어서 다행인 것 같다. 내일도 힘내서 프로젝트를 해야겠다.