From 75f594ec189952f4108968ec7e9a1882df14d998 Mon Sep 17 00:00:00 2001
From: Gabriel Roldan <gabriel.roldan@camptocamp.com>
Date: Wed, 23 Oct 2024 11:59:42 -0300
Subject: [PATCH] Switch to spotless maven plugin with palantir formatting

---
 .github/workflows/pull-request.yaml |  6 +++--
 .gitignore                          |  2 ++
 Makefile                            | 22 +++++++++++++---
 pom.xml                             | 41 ++++++++++++++++++-----------
 4 files changed, 49 insertions(+), 22 deletions(-)

diff --git a/.github/workflows/pull-request.yaml b/.github/workflows/pull-request.yaml
index 86b422239..da9b98e4d 100644
--- a/.github/workflows/pull-request.yaml
+++ b/.github/workflows/pull-request.yaml
@@ -38,9 +38,11 @@ jobs:
         java-version: '21'
         cache: 'maven'
 
+    - name: Validate pom formatting
+      run: make lint-pom
+
     - name: Validate source code formatting
-      run: |
-        make lint
+      run: make lint-java
 
     - name: Test
       run: |
diff --git a/.gitignore b/.gitignore
index 6305175bd..16027c07f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -43,3 +43,5 @@ docker-compose_datadir*
 .env.yjp
 
 hs_err_pid*.log
+
+.spotless-index
diff --git a/Makefile b/Makefile
index e507a40a3..1cc7e5b7e 100644
--- a/Makefile
+++ b/Makefile
@@ -13,12 +13,26 @@ clean:
 	./mvnw clean
 
 .PHONY: lint
-lint:
-	./mvnw fmt:check sortpom:verify -Dsort.verifyFailOn=strict -Dsort.verifyFail=stop -ntp -T1C
+lint: lint-pom lint-java
+
+.PHONY: lint-pom
+lint-pom:
+	./mvnw sortpom:verify -Dsort.verifyFailOn=strict -Dsort.verifyFail=stop -ntp -T1C
+
+.PHONY: lint-java
+lint-java:
+	./mvnw spotless:check -ntp -T1C
 
 .PHONY: format
-format:
-	./mvnw sortpom:sort fmt:format -ntp -T1C
+format: format-pom format-java
+
+.PHONY: format-pom
+format-pom:
+	./mvnw sortpom:sort -ntp -T1C
+
+.PHONY: format-java
+format-java:
+	./mvnw spotless:apply -ntp -T1C
 
 .PHONY: install
 install:
diff --git a/pom.xml b/pom.xml
index 1af25852a..962ed20fa 100644
--- a/pom.xml
+++ b/pom.xml
@@ -12,8 +12,11 @@
   </modules>
   <properties>
     <revision>1.9-SNAPSHOT</revision>
-    <fmt.action>format</fmt.action>
     <fmt.skip>false</fmt.skip>
+    <spotless.action>apply</spotless.action>
+    <spotless.apply.skip>${fmt.skip}</spotless.apply.skip>
+    <pom.fmt.action>sort</pom.fmt.action>
+    <pom.fmt.skip>${fmt.skip}</pom.fmt.skip>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <sonar.host.url>https://sonarcloud.io</sonar.host.url>
   </properties>
@@ -215,9 +218,9 @@
     <pluginManagement>
       <plugins>
         <plugin>
-          <groupId>com.spotify.fmt</groupId>
-          <artifactId>fmt-maven-plugin</artifactId>
-          <version>2.21.1</version>
+          <groupId>com.diffplug.spotless</groupId>
+          <artifactId>spotless-maven-plugin</artifactId>
+          <version>2.43.0</version>
         </plugin>
         <plugin>
           <groupId>com.github.ekryd.sortpom</groupId>
@@ -242,37 +245,43 @@
         <artifactId>sortpom-maven-plugin</artifactId>
         <configuration>
           <encoding>UTF-8</encoding>
+          <keepBlankLines>true</keepBlankLines>
+          <spaceBeforeCloseEmptyElement>false</spaceBeforeCloseEmptyElement>
           <createBackupFile>false</createBackupFile>
           <lineSeparator>\n</lineSeparator>
-          <nrOfIndentSpace>2</nrOfIndentSpace>
           <verifyFail>stop</verifyFail>
           <verifyFailOn>strict</verifyFailOn>
-          <skip>${fmt.skip}</skip>
+          <skip>${pom.fmt.skip}</skip>
         </configuration>
         <executions>
           <execution>
-            <id>sort</id>
             <goals>
-              <goal>sort</goal>
+              <goal>${pom.fmt.action}</goal>
             </goals>
-            <phase>validate</phase>
+            <phase>verify</phase>
           </execution>
         </executions>
       </plugin>
       <plugin>
-        <groupId>com.spotify.fmt</groupId>
-        <artifactId>fmt-maven-plugin</artifactId>
+        <groupId>com.diffplug.spotless</groupId>
+        <artifactId>spotless-maven-plugin</artifactId>
         <configuration>
-          <verbose>false</verbose>
-          <filesNamePattern>.*\.java</filesNamePattern>
-          <skip>${fmt.skip}</skip>
-          <style>aosp</style>
+          <java>
+            <palantirJavaFormat>
+              <version>2.50.0</version>
+            </palantirJavaFormat>
+          </java>
+          <upToDateChecking>
+            <enabled>true</enabled>
+            <indexFile>${project.basedir}/.spotless-index</indexFile>
+          </upToDateChecking>
         </configuration>
         <executions>
           <execution>
             <goals>
-              <goal>${fmt.action}</goal>
+              <goal>${spotless.action}</goal>
             </goals>
+            <phase>validate</phase>
           </execution>
         </executions>
       </plugin>