add java linter and formatter

jorbush · Sep 19, 2024 · ed988b8 · ed988b8
1 parent 26a1fd2
commit ed988b8
Show file tree

Hide file tree

Showing 9 changed files with 110 additions and 31 deletions.
diff --git a/.github/workflows/java-formatter.yml b/.github/workflows/java-formatter.yml
@@ -0,0 +1,28 @@
+name: Java Formatter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  spotless:
+    runs-on: ubuntu-latest
+    defaults:
+        run:
+            working-directory: postrify-backend
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Run Spotless Check
+        run: ./mvnw spotless:check
diff --git a/.github/workflows/java-linter.yml b/.github/workflows/java-linter.yml
@@ -0,0 +1,28 @@
+name: Java Linter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  checkstyle:
+    runs-on: ubuntu-latest
+    defaults:
+        run:
+            working-directory: postrify-backend
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Run Checkstyle
+        run: ./mvnw checkstyle:check
diff --git a/README.md b/README.md
@@ -58,3 +58,15 @@ java -jar target/postrify-0.0.1-SNAPSHOT.jar
 ```bash
 ./mvnw test
 ```
+
+#### Linter
+
+```bash
+./mvnw checkstyle:check
+```
+
+#### Format code
+
+```bash
+./mvnw spotless:apply
+```
diff --git a/postrify-backend/pom.xml b/postrify-backend/pom.xml
@@ -66,6 +66,21 @@
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <version>3.1.2</version>
+            </plugin>
+            <plugin>
+                <groupId>com.diffplug.spotless</groupId>
+                <artifactId>spotless-maven-plugin</artifactId>
+                <version>2.37.0</version>
+                <configuration>
+                    <java>
+                        <googleJavaFormat />
+                    </java>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 

diff --git a/postrify-backend/src/main/java/com/postrify/postrifybackend/PostrifyBackendApplication.java b/postrify-backend/src/main/java/com/postrify/postrifybackend/PostrifyBackendApplication.java
@@ -6,8 +6,7 @@
 @SpringBootApplication
 public class PostrifyBackendApplication {
 
-    public static void main(String[] args) {
-        SpringApplication.run(PostrifyBackendApplication.class, args);
-    }
-
+  public static void main(String[] args) {
+    SpringApplication.run(PostrifyBackendApplication.class, args);
+  }
 }
diff --git a/postrify-backend/src/main/java/com/postrify/postrifybackend/config/SecurityConfig.java b/postrify-backend/src/main/java/com/postrify/postrifybackend/config/SecurityConfig.java
@@ -8,13 +8,11 @@
 @org.springframework.context.annotation.Configuration
 public class SecurityConfig {
 
-    @Bean
-    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
-        http.csrf(AbstractHttpConfigurer::disable)
-            .authorizeHttpRequests(auth -> auth
-                    .requestMatchers("/**").permitAll()
-                    .anyRequest().authenticated()
-            );
-        return http.build();
-    }
+  @Bean
+  public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
+    http.csrf(AbstractHttpConfigurer::disable)
+        .authorizeHttpRequests(
+            auth -> auth.requestMatchers("/**").permitAll().anyRequest().authenticated());
+    return http.build();
+  }
 }
diff --git a/postrify-backend/src/main/java/com/postrify/postrifybackend/config/WebConfig.java b/postrify-backend/src/main/java/com/postrify/postrifybackend/config/WebConfig.java
@@ -1,18 +1,19 @@
 package com.postrify.postrifybackend.config;
+
 import org.springframework.web.servlet.config.annotation.CorsRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 @org.springframework.context.annotation.Configuration
 public class WebConfig implements WebMvcConfigurer {
 
-    @Override
-    public void addCorsMappings(CorsRegistry registry) {
-        registry.addMapping("/**")
-                .allowedOrigins("http://localhost:4200")
-                .allowedOrigins("https://postrify.vercel.app")
-                .allowedMethods("GET", "POST", "PUT", "DELETE")
-                .allowedHeaders("*")
-                .allowCredentials(true);
-    }
+  @Override
+  public void addCorsMappings(CorsRegistry registry) {
+    registry
+        .addMapping("/**")
+        .allowedOrigins("http://localhost:4200")
+        .allowedOrigins("https://postrify.vercel.app")
+        .allowedMethods("GET", "POST", "PUT", "DELETE")
+        .allowedHeaders("*")
+        .allowCredentials(true);
+  }
 }
-
diff --git a/postrify-backend/src/main/java/com/postrify/postrifybackend/controller/HomeController.java b/postrify-backend/src/main/java/com/postrify/postrifybackend/controller/HomeController.java
@@ -6,8 +6,8 @@
 @RestController
 public class HomeController {
 
-    @GetMapping("/")
-    public String home() {
-        return "Hello from Postrify Backend!";
-    }
+  @GetMapping("/")
+  public String home() {
+    return "Hello from Postrify Backend!";
+  }
 }
diff --git a/...y-backend/src/test/java/com/postrify/postrifybackend/PostrifyBackendApplicationTests.java b/...y-backend/src/test/java/com/postrify/postrifybackend/PostrifyBackendApplicationTests.java
@@ -6,8 +6,6 @@
 @SpringBootTest
 class PostrifyBackendApplicationTests {
 
-    @Test
-    void contextLoads() {
-    }
-
+  @Test
+  void contextLoads() {}
 }