Add formatting and linting enhancements to the build process

Author: Konstantin Pavlov

Makefile

@@ -1,8 +1,19 @@
 build:
-	mvn clean verify site
+	  mvn clean verify site
 
-lint:
-	# brew install ktlint
-	ktlint --format
-  # https://docs.openrewrite.org/recipes/maven/bestpractices
-  mvn rewrite:run -P lint
+lint:prepare
+	  ktlint && \
+    mvn spotless:check
+
+# https://docs.openrewrite.org/recipes/maven/bestpractices
+format:prepare
+	  ktlint --format && \
+  	mvn spotless:apply && \
+	  mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
+				-Drewrite.activeRecipes=org.openrewrite.maven.BestPractices \
+				-Drewrite.exportDatatables=true
+
+prepare:
+	  brew install ktlint --quiet
+
+all: format lint build

pom.xml

@@ -36,12 +36,12 @@
     <scm>
         <connection>scm:git:git://github.com/kpavlov/langchain4j-kotlin.git</connection>
         <developerConnection>scm:git:ssh://github.com/kpavlov/langchain4j-kotlin.git</developerConnection>
-        <url>https://github.com/kpavlov/langchain4j-kotlin/tree/main</url>
         <tag>HEAD</tag>
+        <url>https://github.com/kpavlov/langchain4j-kotlin/tree/main</url>
     </scm>
 
     <properties>
-        <argLine />
+        <argLine/>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <kotlin.code.style>official</kotlin.code.style>
         <java.version>17</java.version>
@@ -166,8 +166,6 @@
     </dependencies>
 
     <build>
-        <sourceDirectory>src/main/kotlin</sourceDirectory>
-        <testSourceDirectory>src/test/kotlin</testSourceDirectory>
         <pluginManagement>
             <plugins>
                 <plugin>
@@ -229,6 +227,39 @@
                     <artifactId>maven-project-info-reports-plugin</artifactId>
                     <version>3.8.0</version>
                 </plugin>
+                <plugin>
+                    <!-- https://github.com/diffplug/spotless/blob/main/plugin-maven -->
+                    <groupId>com.diffplug.spotless</groupId>
+                    <artifactId>spotless-maven-plugin</artifactId>
+                    <version>2.43.0</version>
+                    <configuration>
+                        <!-- optional: limit format enforcement to just the files changed by this feature branch -->
+                        <ratchetFrom>origin/main</ratchetFrom>
+                        <java>
+                            <palantirJavaFormat/>
+                        </java>
+                        <kotlin>
+                            <ktlint/>
+                        </kotlin>
+                        <markdown>
+                            <includes>
+                                <!-- You have to set the target manually -->
+                                <include>**/*.md</include>
+                            </includes>
+                            <flexmark/>
+                        </markdown>
+                        <pom>
+                            <includes>
+                                <!-- You have to set the target manually -->
+                                <include>**/pom.xml</include>
+                            </includes>
+                            <sortPom>
+                                <nrOfIndentSpace>4</nrOfIndentSpace>
+                                <expandEmptyElements>false</expandEmptyElements>
+                            </sortPom>
+                        </pom>
+                    </configuration>
+                </plugin>
             </plugins>
         </pluginManagement>
 
@@ -308,10 +339,10 @@
                 <artifactId>detekt-maven-plugin</artifactId>
                 <executions>
                     <execution>
-                        <phase>verify</phase>
                         <goals>
                             <goal>check</goal>
                         </goals>
+                        <phase>verify</phase>
                     </execution>
                 </executions>
             </plugin>
@@ -320,10 +351,10 @@
                 <artifactId>dokka-maven-plugin</artifactId>
                 <executions>
                     <execution>
-                        <phase>package</phase>
                         <goals>
                             <goal>javadocJar</goal>
                         </goals>
+                        <phase>package</phase>
                         <configuration>
                             <attach>true</attach>
                         </configuration>
@@ -344,6 +375,8 @@
                 </configuration>
             </plugin>
         </plugins>
+        <sourceDirectory>src/main/kotlin</sourceDirectory>
+        <testSourceDirectory>src/test/kotlin</testSourceDirectory>
     </build>
 
     <profiles>
@@ -358,10 +391,10 @@
                         <executions>
                             <execution>
                                 <id>sign-artifacts</id>
-                                <phase>verify</phase>
                                 <goals>
                                     <goal>sign</goal>
                                 </goals>
+                                <phase>verify</phase>
                             </execution>
                         </executions>
                     </plugin>