[BSVR-54] Spotless pre-commit hook 추가 #4

EunjiShin · 2024-06-30T17:17:09Z

📌 개요 (필수)

코드 포맷팅을 자동화하기 위해, spotless 플러그인과 pre-commit hook을 추가해요.

🔨 작업 사항 (필수)

spotless plugin 추가
spotless java extension 설정 추가
- google java code style format 적용
- import order 적용
- unused import 삭제 적용 (근데 이거 일 안하더라구요..?? 공식 깃헙에 이슈 올라와있는걸보니 버전 이슈인 것 같기도)
- 라인 끝 공백 적용
- 파일 끝에 새로운 라인 추가 적용
commit 찍을 때 자동으로 spotlessApply 돌도록 hook 추가
- 매번 직접 ./gradlew spotlessApply 돌려주기는 귀찮기도하고, 깜빡하기도 쉬우니까 훅으로 추가했어요
google java code editorconfig 추가
codeowners 추가
- spotless랑 관련있는 변경은 아닌데, 너모 작은 변경이라 슬쩍 같이 추가했어요!ㅎ.ㅎ

🌱 연관 내용 (선택)

처음 pull 받은 후, 훅 적용을 위해 ./gradlew compileJava 한번만 돌려주세요!
application/* 변경사항은 spotless 돌리면서 포맷팅 된 것들이에요! 내용 변경은 없으니 참고해주세요~

wjdwnsdnjs13 · 2024-06-30T17:22:28Z

음... 간단한 내용이 아닌 듯해서 해당 PR 내용 중 모르는 부분은 내일 오전에 조금 찾아본 다음, 다시 PR 확인하고
approve 할까 하는데, approve는 지금 하는 게 나은가요??

EunjiShin · 2024-06-30T17:24:38Z

음... 간단한 내용이 아닌 듯해서 해당 PR 내용 중 모르는 부분은 내일 오전에 조금 찾아본 다음, 다시 PR 확인하고 approve 할까 하는데, approve는 지금 하는 게 나은가요??

아하 급한 내용은 아니라서, 그럼 찾아보고 리뷰 주시면 될 것 같아요~~~ (근데 저희 코드리뷰에선 다시 존댓말하나요??)

wjdwnsdnjs13 · 2024-06-30T17:26:40Z

음... 간단한 내용이 아닌 듯해서 해당 PR 내용 중 모르는 부분은 내일 오전에 조금 찾아본 다음, 다시 PR 확인하고 approve 할까 하는데, approve는 지금 하는 게 나은가요??

아하 급한 내용은 아니라서, 그럼 찾아보고 리뷰 주시면 될 것 같아요~~~ (근데 저희 코드리뷰에선 다시 존댓말하나요??)

여긴 좀 공적이라 존댓말이 낫지 않나 싶었는데, 편한 쪽으로 해도 될 거 같아요 ㅋㅋㅋ

…feat/BSVR-54

github-actions · 2024-06-30T17:33:30Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

EunjiShin · 2024-06-30T17:34:59Z

This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@depromeet/15th-6team-server

요거 editorconfig 때문인데, 이게 google java style을 다 담고 있는 파일이라... 사이즈가 클 수 밖에 없다 ^.ㅠ
배포되고 있는 컨벤션을 그대로 넣은 만큼, 리뷰 대상이 아니라서 이번 PR label은 무시해줘도 될 듯!!

wjdwnsdnjs13 · 2024-07-01T05:23:44Z

spotless 얘도 xml 파일 intellij에서 코드 스타일 적용해줘야 하는 거지??

EunjiShin · 2024-07-01T05:45:52Z

build.gradle.kts

+    spotless {
+        java {
+            // Google Java 포맷 적용
+            googleJavaFormat().aosp()
+            // 아래 순서로 import문 정렬
+            importOrder("java", "javax", "jakarta", "org", "com")
+            // 사용하지 않는 import 제거
+            removeUnusedImports()
+            // 각 라인 끝에 있는 공백을 제거
+            trimTrailingWhitespace()
+            // 파일 끝에 새로운 라인 추가
+            endWithNewline()
+        }
+    }


@wjdwnsdnjs13 놉! 요기 build.gradle 보면 spotless에서 어떤 포맷을 사용할건지 설정해두었어~
그래서 별다른 설정 안해도 ./gradlew spotlessApply만 하면 알아서 적용될거야!

그런데 매번 spotlessApply를 하면 번거로우니까,

./gradlew compileJava를 돌릴때 (build.gradle tasks.named compileJava 부분)

commit을 찍을 때 (.githooks의 pre-commit 부분)

내가 굳이 spotless을 돌리지 않아도 자동으로 동작하게 만들어둔게 pre-commit 설정~~

EunjiShin · 2024-07-01T05:46:21Z

spotless 얘도 xml 파일 intellij에서 코드 스타일 적용해줘야 하는 거지??

여기에 답변 달아두었오~

wjdwnsdnjs13

슬랙 내용까지 전부 확인 완료!

pminsung12

수고하셨습니다~

pminsung12 · 2024-07-01T05:46:28Z

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @EunjiShin @wjdwnsdnjs13 @pminsung12


루트 디렉토리의 모든 파일에 대해 특정 사용자 지정하는 방법이구나 👍🏻

pminsung12 · 2024-07-01T05:54:36Z

build.gradle.kts

+            // Google Java 포맷 적용
+            googleJavaFormat().aosp()
+            // 아래 순서로 import문 정렬
+            importOrder("java", "javax", "jakarta", "org", "com")
+            // 사용하지 않는 import 제거
+            removeUnusedImports()
+            // 각 라인 끝에 있는 공백을 제거
+            trimTrailingWhitespace()
+            // 파일 끝에 새로운 라인 추가
+            endWithNewline()


주석 👍🏻 이해완.

pminsung12 · 2024-07-01T06:05:07Z

build.gradle.kts

+
+    // git commit시 자동으로 spotless 적용되도록 설정
+    // 최초 적용시 && script 변경시 ./gradlew compileJava 한번 실행해주세요
+    tasks.register<Copy>("updateGitHooks") {


여기서 .git/hooks에 파일을 바로 정의하지 않고, pre-commit에 정의해서 컴파일 하기 전에 복사하는 이유는 버전관리 떄문이야?

고것도 있는데, .git 폴더가 기본적으로 숨김폴더라서 직접 스크립트를 넣을 수가 없더라고!
또 .git은 로컬에서 관리되는 값이지 리모트 저장소로 올라가는 값이 아니라서, .git에 바로 정의하면 팀원끼리 해당 스크립트를 공유할 수가 없다고 하더라고??

저 스크립트가 각자의 로컬에 있어야 원하는대로 훅이 동작해서, 스크립트 공유 목적으로 빼둔거라고 생각하면 될 것 같아!

아 그러네 .git은 당연히 공유가 안되겠다 .github랑 개념을 혼동했다. 확인~

pminsung12 · 2024-07-01T06:06:42Z

build.gradle.kts

+    tasks.register<Exec>("makeGitHooksExecutable") {
+        commandLine("chmod", "+x", "${rootProject.rootDir}/.git/hooks/pre-commit")
+        dependsOn("updateGitHooks")
+    }
+
+    tasks.named<JavaCompile>("compileJava") {
+        dependsOn("makeGitHooksExecutable")
+    }


compile 전에 githook이 무조건 걸리는구나 👍🏻

EunjiShin added 7 commits July 1, 2024 01:31

build: spotless plugin 추가

2f213ad

docs : google java code style editorconfig 추가

88a881f

build(spotless): commit 찍을 때 자동으로 spotless 돌도록 설정

25dcf39

build: spotless pre-commit register 수정

2184adc

test(pre-commit): spotless pre commit 테스트

738d138

build: 사용하지 않는 build.gradle 블럭 삭제

30c7341

build: pre-commit script 수정

ceabc41

EunjiShin requested a review from a team June 30, 2024 17:17

EunjiShin self-assigned this Jun 30, 2024

EunjiShin added ✨ Feature 기능 개발 🛠 Setting 개발 환경 세팅 and removed ✨ Feature 기능 개발 labels Jun 30, 2024

docs: codeowners 추가

0492c8a

EunjiShin added 2 commits July 1, 2024 02:29

Merge branch 'main' of https://github.com/depromeet/SPOT-server into …

1c2239b

…feat/BSVR-54

fix: github workflow 디렉터리 이름 오타 수정

728c6c9

github-actions bot added the size/XL label Jun 30, 2024

EunjiShin commented Jul 1, 2024

View reviewed changes

wjdwnsdnjs13 approved these changes Jul 1, 2024

View reviewed changes

pminsung12 approved these changes Jul 1, 2024

View reviewed changes

EunjiShin merged commit 44a65e4 into main Jul 1, 2024
1 check passed

EunjiShin deleted the feat/BSVR-54 branch July 1, 2024 06:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BSVR-54] Spotless pre-commit hook 추가 #4

[BSVR-54] Spotless pre-commit hook 추가 #4

EunjiShin commented Jun 30, 2024 •

edited

Loading

wjdwnsdnjs13 commented Jun 30, 2024 •

edited

Loading

EunjiShin commented Jun 30, 2024

wjdwnsdnjs13 commented Jun 30, 2024

github-actions bot commented Jun 30, 2024

EunjiShin commented Jun 30, 2024 •

edited

Loading

wjdwnsdnjs13 commented Jul 1, 2024

EunjiShin Jul 1, 2024

EunjiShin commented Jul 1, 2024

wjdwnsdnjs13 left a comment

pminsung12 left a comment

pminsung12 Jul 1, 2024

pminsung12 Jul 1, 2024 •

edited

Loading

pminsung12 Jul 1, 2024 •

edited

Loading

EunjiShin Jul 1, 2024 •

edited

Loading

pminsung12 Jul 1, 2024

pminsung12 Jul 1, 2024 •

edited

Loading

[BSVR-54] Spotless pre-commit hook 추가 #4

[BSVR-54] Spotless pre-commit hook 추가 #4

Conversation

EunjiShin commented Jun 30, 2024 • edited Loading

📌 개요 (필수)

🔨 작업 사항 (필수)

🌱 연관 내용 (선택)

wjdwnsdnjs13 commented Jun 30, 2024 • edited Loading

EunjiShin commented Jun 30, 2024

wjdwnsdnjs13 commented Jun 30, 2024

github-actions bot commented Jun 30, 2024

EunjiShin commented Jun 30, 2024 • edited Loading

wjdwnsdnjs13 commented Jul 1, 2024

EunjiShin Jul 1, 2024

Choose a reason for hiding this comment

EunjiShin commented Jul 1, 2024

wjdwnsdnjs13 left a comment

Choose a reason for hiding this comment

pminsung12 left a comment

Choose a reason for hiding this comment

pminsung12 Jul 1, 2024

Choose a reason for hiding this comment

pminsung12 Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

pminsung12 Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

EunjiShin Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

pminsung12 Jul 1, 2024

Choose a reason for hiding this comment

pminsung12 Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

EunjiShin commented Jun 30, 2024 •

edited

Loading

wjdwnsdnjs13 commented Jun 30, 2024 •

edited

Loading

EunjiShin commented Jun 30, 2024 •

edited

Loading

pminsung12 Jul 1, 2024 •

edited

Loading

pminsung12 Jul 1, 2024 •

edited

Loading

EunjiShin Jul 1, 2024 •

edited

Loading

pminsung12 Jul 1, 2024 •

edited

Loading