chore: 코딩 컨벤션 설정을 위한 Spotless 세팅 (#14)

* chore: plain jar 생성되지 않도록 변경

* chore: spotless 추가 및 설정

* style: spotless 포맷팅 적용

* chore: 커밋 전 spotless 적용을 위한 pre-commit 작성

* docs: CODEOWNER 변경

* chore: palantir java format 사용하도록 변경

* style: spotless 적용

.github/CODEOWNERS

@@ -1 +1 @@
-@GDSC-Hongik/backend-dev
+* @GDSC-Hongik/backend-dev

.github/ISSUE_TEMPLATE/♻️-refactor.md

@@ -8,4 +8,4 @@ assignees: ''
 ---
 
 ## 📌 Description
-- 
+-

.github/ISSUE_TEMPLATE/⚙️-chore.md

@@ -8,4 +8,4 @@ assignees: ''
 ---
 
 ## 📌 Description
-- 
+-

.github/ISSUE_TEMPLATE/✅-test.md

@@ -8,4 +8,4 @@ assignees: ''
 ---
 
 ## 📌 Description
-- 
+-

.github/ISSUE_TEMPLATE/✨-feature.md

@@ -8,4 +8,4 @@ assignees: ''
 ---
 
 ## 📌 Description
-- 
+-

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,10 +2,10 @@
 - close #
 
 ## 📌 작업 내용 및 특이사항
-- 
+-
 
 ## 📝 참고사항
-- 
+-
 
 ## 📚 기타
-- 
+-

.github/workflows/pull_request_gradle_build.yml

@@ -20,7 +20,7 @@ jobs:
 
       - name: gradlew 권한 부여
         run: chmod +x ./gradlew
-        
+
       - name: Gradle Build
         uses: gradle/gradle-build-action@v2
         with:

build.gradle

@@ -1,52 +1,79 @@
 plugins {
-	id 'java'
-	id 'org.springframework.boot' version '3.2.1'
-	id 'io.spring.dependency-management' version '1.1.4'
-	id 'org.asciidoctor.jvm.convert' version '3.3.2'
+    id 'java'
+    id 'org.springframework.boot' version '3.2.1'
+    id 'io.spring.dependency-management' version '1.1.4'
+    id 'org.asciidoctor.jvm.convert' version '3.3.2'
+    id 'com.diffplug.spotless' version '6.23.3'
 }
 
 group = 'com.gdschongik'
 version = '0.0.1-SNAPSHOT'
 
 java {
-	sourceCompatibility = '17'
+    sourceCompatibility = '17'
 }
 
 configurations {
-	compileOnly {
-		extendsFrom annotationProcessor
-	}
+    compileOnly {
+        extendsFrom annotationProcessor
+    }
 }
 
 repositories {
-	mavenCentral()
+    mavenCentral()
 }
 
 ext {
-	set('snippetsDir', file("build/generated-snippets"))
+    set('snippetsDir', file("build/generated-snippets"))
 }
 
 dependencies {
-	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
-	implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
-	implementation 'org.springframework.boot:spring-boot-starter-security'
-	implementation 'org.springframework.boot:spring-boot-starter-validation'
-	implementation 'org.springframework.boot:spring-boot-starter-web'
-	compileOnly 'org.projectlombok:lombok'
-	runtimeOnly 'com.h2database:h2'
-	runtimeOnly 'com.mysql:mysql-connector-j'
-	annotationProcessor 'org.projectlombok:lombok'
-	testImplementation 'org.springframework.boot:spring-boot-starter-test'
-	testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
-	testImplementation 'org.springframework.security:spring-security-test'
+    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+    implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
+    implementation 'org.springframework.boot:spring-boot-starter-security'
+    implementation 'org.springframework.boot:spring-boot-starter-validation'
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    compileOnly 'org.projectlombok:lombok'
+    runtimeOnly 'com.h2database:h2'
+    runtimeOnly 'com.mysql:mysql-connector-j'
+    annotationProcessor 'org.projectlombok:lombok'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
+    testImplementation 'org.springframework.security:spring-security-test'
 }
 
 tasks.named('test') {
-	outputs.dir snippetsDir
-	useJUnitPlatform()
+    outputs.dir snippetsDir
+    useJUnitPlatform()
 }
 
 tasks.named('asciidoctor') {
-	inputs.dir snippetsDir
-	dependsOn test
+    inputs.dir snippetsDir
+    dependsOn test
+}
+
+jar {
+    enabled = false
+}
+
+spotless {
+    format 'misc', {
+        target '**/*.yml', '**/*.gradle', '**/*.md'
+        trimTrailingWhitespace()
+        indentWithSpaces(4)
+        endWithNewline()
+    }
+
+    java {
+        removeUnusedImports()
+        palantirJavaFormat()
+        formatAnnotations()
+    }
+}
+
+tasks.register('updateGitHooks', Copy) {
+    from './scripts/pre-commit'
+    into '.git/hooks'
+
+    compileJava.dependsOn(this)
 }

scripts/pre-commit

@@ -0,0 +1,14 @@
+# 변경된 파일들 이름만 추출하여 저장
+stagedFiles=$(git diff --staged --name-only)
+
+# SpotlessApply 실행
+echo "Running spotlessApply. Formatting code..."
+./gradlew spotlessApply
+
+# 변경사항이 발생한 파일들 다시 git add
+for file in $stagedFiles; do
+  if test -f "$file"; then
+    git add "$file"
+  fi
+done
+

src/main/java/com/gdschongik/gdsc/GdscApplication.java

@@ -6,7 +6,7 @@
 @SpringBootApplication
 public class GdscApplication {
 
-	public static void main(String[] args) {
-		SpringApplication.run(GdscApplication.class, args);
-	}
+    public static void main(String[] args) {
+        SpringApplication.run(GdscApplication.class, args);
+    }
 }

src/test/java/com/gdschongik/gdsc/GdscApplicationTests.java

@@ -6,8 +6,6 @@
 @SpringBootTest
 class GdscApplicationTests {
 
-	@Test
-	void contextLoads() {
-	}
-
+    @Test
+    void contextLoads() {}
 }