From 2691a1734e41cfb5b69404d84d56ddaa558958a4 Mon Sep 17 00:00:00 2001
From: "Gary D. Gregory" <garydgregory@gmail.com>
Date: Fri, 27 Dec 2024 11:04:28 -0500
Subject: [PATCH] Refactor maven-checkstyle-plugin configuration

---
 pom.xml                                       | 33 +++++++++++--------
 .../checkstyle-suppressions.xml               |  1 -
 src/conf/{ => checkstyle}/checkstyle.xml      |  2 +-
 3 files changed, 21 insertions(+), 15 deletions(-)
 rename src/conf/{ => checkstyle}/checkstyle-suppressions.xml (99%)
 rename src/conf/{ => checkstyle}/checkstyle.xml (98%)

diff --git a/pom.xml b/pom.xml
index d32f4b2638..501d73911e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -71,6 +71,11 @@
     <commons.jacoco.branchRatio>0.59</commons.jacoco.branchRatio>
     <commons.jacoco.lineRatio>0.68</commons.jacoco.lineRatio>
     <commons.jacoco.complexityRatio>0.58</commons.jacoco.complexityRatio>
+    <!-- Checkstyle -->
+    <checkstyle.header.file>${basedir}/src/conf/checkstyle/checkstyle-header.txt</checkstyle.header.file>
+    <checkstyle.config.file>${basedir}/src/conf/checkstyle/checkstyle.xml</checkstyle.config.file>
+    <checkstyle.suppress.file>${basedir}/src/conf/checkstyle/checkstyle-suppressions.xml</checkstyle.suppress.file>
+    <checkstyle.resourceExcludes>LICENSE.txt, NOTICE.txt, **/maven-archiver/pom.properties</checkstyle.resourceExcludes>
   </properties>
   <distributionManagement>
     <site>
@@ -94,6 +99,21 @@
   </scm>
   <build>
     <defaultGoal>clean verify apache-rat:check japicmp:cmp checkstyle:check pmd:check spotbugs:check javadoc:javadoc</defaultGoal>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-checkstyle-plugin</artifactId>
+          <version>${commons.checkstyle-plugin.version}</version>
+          <configuration>
+            <configLocation>${checkstyle.config.file}</configLocation>
+            <enableRulesSummary>false</enableRulesSummary>
+            <suppressionsLocation>${checkstyle.suppress.file}</suppressionsLocation>
+            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+          </configuration>
+        </plugin>
+      </plugins>
+    </pluginManagement>
     <plugins>
       <plugin>
         <groupId>org.apache.felix</groupId>
@@ -198,13 +218,6 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
-        <configuration>
-          <configLocation>${basedir}/src/conf/checkstyle.xml</configLocation>
-          <!-- Needed to define config_loc -->
-          <propertyExpansion>config_loc=${basedir}</propertyExpansion>
-          <enableRulesSummary>false</enableRulesSummary>
-          <includeTestSourceDirectory>true</includeTestSourceDirectory>
-        </configuration>
       </plugin>
       <plugin>
         <groupId>com.github.siom79.japicmp</groupId>
@@ -259,12 +272,6 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
-        <configuration>
-          <configLocation>${basedir}/src/conf/checkstyle.xml</configLocation>
-          <!-- Needed to define config_loc -->
-          <propertyExpansion>config_loc=${basedir}</propertyExpansion>
-          <enableRulesSummary>false</enableRulesSummary>
-        </configuration>
         <!-- We need to specify reportSets because 2.9.1 creates two reports -->
         <reportSets>
           <reportSet>
diff --git a/src/conf/checkstyle-suppressions.xml b/src/conf/checkstyle/checkstyle-suppressions.xml
similarity index 99%
rename from src/conf/checkstyle-suppressions.xml
rename to src/conf/checkstyle/checkstyle-suppressions.xml
index 643d511e5d..11b5552c96 100644
--- a/src/conf/checkstyle-suppressions.xml
+++ b/src/conf/checkstyle/checkstyle-suppressions.xml
@@ -15,7 +15,6 @@ 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.
 -->
-
 <!DOCTYPE suppressions PUBLIC
     "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
     "https://checkstyle.org/dtds/suppressions_1_2.dtd">
diff --git a/src/conf/checkstyle.xml b/src/conf/checkstyle/checkstyle.xml
similarity index 98%
rename from src/conf/checkstyle.xml
rename to src/conf/checkstyle/checkstyle.xml
index 581c1dee71..4afde2501f 100644
--- a/src/conf/checkstyle.xml
+++ b/src/conf/checkstyle/checkstyle.xml
@@ -185,7 +185,7 @@ limitations under the License.
 
   <module name="SuppressionFilter">
     <!-- config_loc is used by Eclipse plugin -->
-    <property name="file" value="${config_loc}/src/conf/checkstyle-suppressions.xml"/>
+    <property name="file" value="src/conf/checkstyle/checkstyle-suppressions.xml"/>
   </module>
   <module name="RegexpSingleline">
     <!-- \s matches whitespace character, $ matches end of line. -->