maven spotless apply

devacfr · Jul 25, 2023 · adbdbbe · adbdbbe
1 parent db1753e
commit adbdbbe
Show file tree

Hide file tree

Showing 44 changed files with 691 additions and 869 deletions.
diff --git a/pom.xml b/pom.xml
@@ -1,12 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file
-  distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under
-  the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may
-  obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to
-  in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-  ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file
+  distributed with this work for additional information regarding copyright
+ownership. The ASF licenses this file to You under
+  the Apache License, Version 2.0 (the "License"); you may not use this file
+except in compliance with the License. You may
+  obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to
+  in writing, software distributed under the License is distributed on an "AS IS"
+BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+  ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under
   the License. -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
@@ -87,9 +95,11 @@
     <reflow-current-version>2.3.3</reflow-current-version>
     <main.basedir>${session.executionRootDirectory}</main.basedir>
     <distribution.releaseRepository.id>ossrh</distribution.releaseRepository.id>
-    <distribution.releaseRepositoryUrl>https://oss.sonatype.org/service/local/staging/deploy/maven2</distribution.releaseRepositoryUrl>
+    <distribution.releaseRepositoryUrl>
+      https://oss.sonatype.org/service/local/staging/deploy/maven2</distribution.releaseRepositoryUrl>
     <distribution.snapshotRepositoryId>ossrh</distribution.snapshotRepositoryId>
-    <distribution.snapshotRepositoryUrl>https://oss.sonatype.org/content/repositories/snapshots</distribution.snapshotRepositoryUrl>
+    <distribution.snapshotRepositoryUrl>
+      https://oss.sonatype.org/content/repositories/snapshots</distribution.snapshotRepositoryUrl>
 
     <!-- Set default encoding to UTF-8 (most plugins) -->
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -114,18 +124,22 @@
 
     <siteMainDirectory>${user.home}</siteMainDirectory>
     <pubScmUrl>scm:git:ssh://git@github.com/devacfr/reflow-maven-skin.git</pubScmUrl>
-    <scmPubCheckoutDirectory>\${siteMainDirectory}/Development/maven/reflow-maven-skin-scm</scmPubCheckoutDirectory>
+    <scmPubCheckoutDirectory>
+      \${siteMainDirectory}/Development/maven/reflow-maven-skin-scm</scmPubCheckoutDirectory>
     <site.url>https://devacfr.github.io/reflow-maven-skin/</site.url>
     <site.deploy.id>github</site.deploy.id>
     <site.deploy.name>Deployment through GitHub's site deployment plugin</site.deploy.name>
 
-    <spotbugs.excludefilterfile.path>${main.basedir}/check/spotbugs-exclude-filter.xml</spotbugs.excludefilterfile.path>
+    <spotbugs.excludefilterfile.path>
+      ${main.basedir}/check/spotbugs-exclude-filter.xml</spotbugs.excludefilterfile.path>
     <spotbugs.only.analyze>com.pmi.tpd.-</spotbugs.only.analyze>
     <generate.site.path>${main.basedir}/target/site</generate.site.path>
 
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <!-- Web dependencies version -->
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <anchorJsVesrion>3.2.2</anchorJsVesrion>
     <highlightJsVersion>11.6.0</highlightJsVersion>
     <bootstrapVersion>4.6.2</bootstrapVersion>
@@ -135,9 +149,11 @@
     <fontawesomeVersion>5.15.1</fontawesomeVersion>
     <popperVersion>1.16.0</popperVersion>
 
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <!-- Java dependencies version -->
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <commons-lang.version>3.12.0</commons-lang.version>
     <doxia.sitetools.version>2.0.0-M11</doxia.sitetools.version>
     <doxia.version>2.0.0-M7</doxia.version>
@@ -150,9 +166,11 @@
     <maven-project.version>2.2.1</maven-project.version>
     <velocity-tools.version>3.1</velocity-tools.version>
 
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <!-- Test dependencies version -->
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <junit5.version>5.6.0</junit5.version>
     <mockito.version>3.2.4</mockito.version>
     <hamcrest.version>2.2</hamcrest.version>
@@ -181,6 +199,7 @@
     <maven-project-info-reports-plugin.version>3.4.1</maven-project-info-reports-plugin.version>
     <maven-spotbugs-plugin.version>3.1.12.2</maven-spotbugs-plugin.version>
     <maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
+    <spotless.version>2.38.0</spotless.version>
     <maven-surefire-report-plugin.version>${maven-surefire-plugin.version}</maven-surefire-report-plugin.version>
   </properties>
 
@@ -217,9 +236,11 @@
         <artifactId>velocity-tools-generic</artifactId>
         <version>${velocity-tools.version}</version>
       </dependency>
-      <!-- ================================================================================ -->
+      <!--
+      ================================================================================ -->
       <!-- Log Dependencies -->
-      <!-- ================================================================================ -->
+      <!--
+      ================================================================================ -->
       <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
@@ -255,9 +276,11 @@
         <artifactId>logback-classic</artifactId>
         <version>${logback.version}</version>
       </dependency>
-      <!-- ================================================================================ -->
+      <!--
+      ================================================================================ -->
       <!-- Test Dependencies -->
-      <!-- ================================================================================ -->
+      <!--
+      ================================================================================ -->
       <dependency>
         <groupId>org.junit</groupId>
         <artifactId>junit-bom</artifactId>
@@ -355,16 +378,6 @@
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-surefire-plugin</artifactId>
           <version>${maven-surefire-plugin.version}</version>
-          <configuration>
-            <argLine>-Xmx512m</argLine>
-            <includes>
-              <include>**/*Test.java</include>
-            </includes>
-            <excludes>
-              <!-- exclude Clover generated inner class -->
-              <exclude>**/*$__CLR*</exclude>
-            </excludes>
-          </configuration>
         </plugin>
         <plugin>
           <groupId>org.apache.rat</groupId>
@@ -510,7 +523,8 @@
         <configuration>
           <pubScmUrl>${pubScmUrl}</pubScmUrl>
           <checkoutDirectory>${scmPubCheckoutDirectory}</checkoutDirectory>
-          <checkinComment>Publishing Site Docs for Reflow Maven Skin ${project.version}</checkinComment>
+          <checkinComment>Publishing Site Docs for Reflow Maven Skin
+            ${project.version}</checkinComment>
           <tryUpdate>true</tryUpdate>
           <skipDeletedFiles>false</skipDeletedFiles>
           <scmBranch>gh-pages</scmBranch>
@@ -550,8 +564,10 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-project-info-reports-plugin</artifactId>
         <configuration>
-          <anonymousConnection>scm:git:git@github.com:devacfr/reflow-maven-skin.git</anonymousConnection>
-          <developerConnection>scm:git:git@github.com:devacfr/reflow-maven-skin.git</developerConnection>
+          <anonymousConnection>
+            scm:git:git@github.com:devacfr/reflow-maven-skin.git</anonymousConnection>
+          <developerConnection>
+            scm:git:git@github.com:devacfr/reflow-maven-skin.git</developerConnection>
           <showAvatarImages>true</showAvatarImages>
         </configuration>
       </plugin>
@@ -569,9 +585,29 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
         <configuration>
+          <argLine>-Xmx512m</argLine>
           <includes>
             <include>**/*Test.java</include>
           </includes>
+          <excludes>
+            <!-- exclude Clover generated inner class -->
+            <exclude>**/*$__CLR*</exclude>
+          </excludes>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>com.diffplug.spotless</groupId>
+        <artifactId>spotless-maven-plugin</artifactId>
+        <version>${spotless.version}</version>
+        <configuration>
+          <!-- define a language-specific format -->
+          <java>
+            <eclipse>
+              <file>${main.basedir}/eclipse/java-code-style-formatter.xml</file> <!--
+              optional -->
+            </eclipse>
+            <formatAnnotations />
+          </java>
         </configuration>
       </plugin>
       <plugin>
@@ -779,9 +815,11 @@
   </reporting>
 
   <profiles>
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <!-- disable maven toolchains -->
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <profile>
       <id>toolchains</id>
       <activation>
@@ -813,9 +851,11 @@
         </plugins>
       </build>
     </profile>
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <!-- skip tests phase, -PskipTests -->
-    <!-- ================================================================================ -->
+    <!--
+    ================================================================================ -->
     <profile>
       <id>skipTests</id>
       <properties>