Update from template

.config/pmd/ruleset.xml

@@ -0,0 +1,152 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="Default"
+		 xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+		 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		 xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+	<description>
+		This ruleset checks the code for discouraged programming constructs.
+	</description>
+
+	<!-- Only rules that don't overlap with CheckStyle! -->
+
+	<rule ref="category/java/bestpractices.xml/AvoidUsingHardCodedIP"/>
+	<rule ref="category/java/bestpractices.xml/PreserveStackTrace"/>
+	<rule ref="category/java/bestpractices.xml/UseCollectionIsEmpty"/>
+	<rule ref="category/java/bestpractices.xml/UseStandardCharsets"/>
+
+	<!-- Native code is platform dependent; Loading external native libs might pose a security threat -->
+	<rule ref="category/java/codestyle.xml/AvoidUsingNativeCode"/>
+	<rule ref="category/java/codestyle.xml/IdenticalCatchBranches"/>
+	<rule ref="category/java/codestyle.xml/NoPackage"/>
+	<rule ref="category/java/codestyle.xml/PrematureDeclaration"/>
+
+	<rule ref="category/java/design.xml">
+		<!-- Sometimes abstract classes have just fields -->
+		<exclude name="AbstractClassWithoutAnyMethod"/>
+
+		<!-- Using RuntimeExceptions is ok -->
+		<exclude name="AvoidCatchingGenericException"/>
+		<exclude name="AvoidThrowingRawExceptionTypes"/>
+
+		<!-- Limit too low -->
+		<exclude name="AvoidDeeplyNestedIfStmts"/>
+
+		<!-- Limit too low -->
+		<exclude name="CouplingBetweenObjects"/>
+
+		<!-- Limit too low -->
+		<exclude name="CyclomaticComplexity"/>
+
+		<!-- Makes entity classes impossible -->
+		<exclude name="DataClass"/>
+
+		<!-- Used commonly particular in bigger methods with upstream throws -->
+		<exclude name="ExceptionAsFlowControl"/>
+
+		<!-- Limit too low -->
+		<exclude name="ExcessiveImports"/>
+
+		<!-- Handled by TooManyFields/TooManyMethods -->
+		<exclude name="ExcessivePublicCount"/>
+
+		<!-- Prohibits accessing members using multiple depths -->
+		<exclude name="LawOfDemeter"/>
+
+		<!-- No effect -->
+		<exclude name="LoosePackageCoupling"/>
+
+		<!-- Prohibits singleton pattern -->
+		<exclude name="MutableStaticState"/>
+
+		<!-- Some override methods or Junit require this -->
+		<exclude name="SignatureDeclareThrowsException"/>
+
+		<!-- Reports FP for equals methods -->
+		<exclude name="SimplifyBooleanReturns"/>
+
+		<!-- Limit too low -->
+		<exclude name="TooManyFields"/>
+
+		<!-- Limit too low -->
+		<exclude name="TooManyMethods"/>
+
+		<!-- Limit too low -->
+		<exclude name="UseObjectForClearerAPI"/>
+
+		<!-- Handled by checkstyle -->
+		<exclude name="UseUtilityClass"/>
+	</rule>
+
+	<rule ref="category/java/design.xml/AvoidDeeplyNestedIfStmts">
+		<properties>
+			<property name="problemDepth" value="4"/>
+		</properties>
+	</rule>
+	<rule ref="category/java/design.xml/CouplingBetweenObjects">
+		<properties>
+			<property name="threshold" value="100"/>
+		</properties>
+	</rule>
+	<rule ref="category/java/design.xml/CyclomaticComplexity">
+		<properties>
+			<property name="classReportLevel" value="150"/>
+			<property name="methodReportLevel" value="25"/>
+			<property name="cycloOptions" value=""/>
+		</properties>
+	</rule>
+	<rule ref="category/java/design.xml/ExcessiveImports">
+		<properties>
+			<property name="minimum" value="200"/>
+		</properties>
+	</rule>
+	<rule ref="category/java/design.xml/TooManyFields">
+		<properties>
+			<property name="maxfields" value="50"/>
+		</properties>
+	</rule>
+	<rule ref="category/java/design.xml/TooManyMethods">
+		<properties>
+			<property name="maxmethods" value="100"/>
+		</properties>
+	</rule>
+
+	<rule ref="category/java/errorprone.xml/AvoidUsingOctalValues"/>
+	<rule ref="category/java/errorprone.xml/BrokenNullCheck"/>
+	<rule ref="category/java/errorprone.xml/ComparisonWithNaN"/>
+	<rule ref="category/java/errorprone.xml/DoNotCallGarbageCollectionExplicitly"/>
+	<rule ref="category/java/errorprone.xml/DontImportSun"/>
+	<rule ref="category/java/errorprone.xml/MisplacedNullCheck"/>
+	<rule ref="category/java/errorprone.xml/UnnecessaryCaseChange"/>
+
+
+	<rule ref="category/java/multithreading.xml">
+		<!-- Just bloats code -->
+		<exclude name="AvoidSynchronizedAtMethodLevel"/>
+
+		<!-- NOPE -->
+		<exclude name="DoNotUseThreads"/>
+
+		<!-- Doesn't detect nested thread safe singleton pattern -->
+		<exclude name="NonThreadSafeSingleton"/>
+
+		<!-- Should relevant for fields that use multithreading which is rare -->
+		<exclude name="UseConcurrentHashMap"/>
+	</rule>
+
+	<rule ref="category/java/performance.xml">
+		<!-- This was fixed in Java 10 -->
+		<exclude name="AvoidFileStream"/>
+
+		<!-- Used everywhere and has neglectable performance impact -->
+		<exclude name="AvoidInstantiatingObjectsInLoops"/>
+
+		<!-- Handled by checkstyle -->
+		<exclude name="RedundantFieldInitializer"/>
+
+		<!-- Nowadays optimized by compiler; No code bloating needed -->
+		<exclude name="UseStringBufferForStringAppends"/>
+	</rule>
+
+	<rule ref="category/java/security.xml"/>
+</ruleset>

.github/workflows/check-build.yml

@@ -70,7 +70,7 @@ jobs:
         path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
         if-no-files-found: error
 
-  code-style:
+  checkstyle:
     runs-on: ubuntu-latest
     if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}
 
@@ -91,3 +91,40 @@ jobs:
 
     - name: Run Checkstyle
       run: ./mvnw -B checkstyle:check -P checkstyle -T2C
+
+  pmd:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}
+
+    strategy:
+      matrix:
+        java: [17]
+        distribution: [temurin]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up JDK
+      uses: actions/setup-java@v4
+      with:
+        distribution: ${{ matrix.distribution }}
+        java-version: ${{ matrix.java }}
+        cache: 'maven'
+
+    - name: Run PMD
+      run: ./mvnw -B test pmd:aggregate-pmd-no-fork pmd:check -P pmd -DskipTests -T2C
+
+    - name: Run CPD (Copy Paste Detector)
+      run: ./mvnw -B pmd:aggregate-cpd pmd:cpd-check -P pmd -DskipTests -T2C
+
+    - name: Upload report
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: pmd-report
+        if-no-files-found: ignore
+        path: |
+          target/site/*.html
+          target/site/css/**
+          target/site/images/logos/maven-feather.png
+          target/site/images/external.png

.gitignore

@@ -39,11 +39,6 @@ buildNumber.properties
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 
-
-# bin / compiled stuff
-target/
-
-
 # JRebel
 **/resources/rebel.xml
 **/resources/rebel-remote.xml

.mvn/wrapper/maven-wrapper.properties

@@ -14,4 +14,4 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.7/apache-maven-3.9.7-bin.zip
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.8/apache-maven-3.9.8-bin.zip

pom.xml

@@ -19,6 +19,11 @@
 		<module>template-placeholder-demo</module>
 	</modules>
 
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+	</properties>
+
 	<licenses>
 		<license>
 			<name>Apache License, Version 2.0</name>
@@ -29,20 +34,75 @@
 
 	<profiles>
 		<profile>
-			<!-- Disable checkstyle in root module as there is nothing to check -->
 			<id>checkstyle</id>
 			<build>
 				<plugins>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-checkstyle-plugin</artifactId>
 						<version>3.4.0</version>
+						<dependencies>
+							<dependency>
+								<groupId>com.puppycrawl.tools</groupId>
+								<artifactId>checkstyle</artifactId>
+								<version>10.17.0</version>
+							</dependency>
+						</dependencies>
+						<configuration>
+							<configLocation>.config/checkstyle/checkstyle.xml</configLocation>
+							<includeTestSourceDirectory>true</includeTestSourceDirectory>
+						</configuration>
+						<executions>
+							<execution>
+								<goals>
+									<goal>check</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+		<profile>
+			<id>pmd</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-pmd-plugin</artifactId>
+						<version>3.23.0</version>
 						<configuration>
-							<skip>true</skip>
+							<includeTests>true</includeTests>
+							<printFailingErrors>true</printFailingErrors>
+							<rulesets>
+								<ruleset>.config/pmd/ruleset.xml</ruleset>
+							</rulesets>
 						</configuration>
+						<dependencies>
+							<dependency>
+								<groupId>net.sourceforge.pmd</groupId>
+								<artifactId>pmd-core</artifactId>
+								<version>7.2.0</version>
+							</dependency>
+							<dependency>
+								<groupId>net.sourceforge.pmd</groupId>
+								<artifactId>pmd-java</artifactId>
+								<version>7.2.0</version>
+							</dependency>
+						</dependencies>
 					</plugin>
 				</plugins>
 			</build>
+			<reporting>
+				<plugins>
+					<!-- Required for reporting -->
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-jxr-plugin</artifactId>
+						<version>3.4.0</version>
+					</plugin>
+				</plugins>
+			</reporting>
 		</profile>
 	</profiles>
 </project>

template-placeholder-demo/pom.xml

@@ -4,7 +4,12 @@
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
-	<groupId>software.xdev</groupId>
+	<parent>
+		<groupId>software.xdev</groupId>
+		<artifactId>template-placeholder-root</artifactId>
+		<version>1.0.0-SNAPSHOT</version>
+	</parent>
+
 	<artifactId>template-placeholder-demo</artifactId>
 	<version>1.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
@@ -77,36 +82,4 @@
 			</plugin>
 		</plugins>
 	</build>
-	<profiles>
-		<profile>
-			<id>checkstyle</id>
-			<build>
-				<plugins>
-					<plugin>
-						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-checkstyle-plugin</artifactId>
-						<version>3.4.0</version>
-						<dependencies>
-							<dependency>
-								<groupId>com.puppycrawl.tools</groupId>
-								<artifactId>checkstyle</artifactId>
-								<version>10.17.0</version>
-							</dependency>
-						</dependencies>
-						<configuration>
-							<configLocation>../.config/checkstyle/checkstyle.xml</configLocation>
-							<includeTestSourceDirectory>true</includeTestSourceDirectory>
-						</configuration>
-						<executions>
-							<execution>
-								<goals>
-									<goal>check</goal>
-								</goals>
-							</execution>
-						</executions>
-					</plugin>
-				</plugins>
-			</build>
-		</profile>
-	</profiles>
 </project>