Update README.md

custom-pmd/README.md

@@ -0,0 +1,7 @@
+## Custom PMD Rules
+
+This module contains articles about PMD
+
+### Relevant Articles:
+
+- [Introduction To PMD](https://www.baeldung.com/pmd)

custom-pmd/pom.xml

@@ -0,0 +1,52 @@
+<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.baeldung.pmd</groupId>
+    <artifactId>custom-pmd</artifactId>
+    <version>0.0.1</version>
+    <name>custom-pmd</name>
+    <packaging>jar</packaging>
+    <url>http://maven.apache.org</url>
+    
+    <parent>
+        <artifactId>parent-modules</artifactId>
+        <groupId>com.baeldung</groupId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>net.sourceforge.pmd</groupId>
+            <artifactId>pmd-core</artifactId>
+            <version>${pmdVersion}</version>
+        </dependency>
+        <dependency>
+            <groupId>net.sourceforge.pmd</groupId>
+            <artifactId>pmd-java</artifactId>
+            <version>${pmdVersion}</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>${maven-compiler-plugin.version}</version>
+                <configuration>
+                    <source>${maven.compiler.source}</source>
+                    <target>${maven.compiler.target}</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven-compiler-plugin.version>3.7.0</maven-compiler-plugin.version>
+        <pmdVersion>6.0.1</pmdVersion>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
+    </properties>
+
+</project>

custom-pmd/src/main/java/org/baeldung/pmd/UnitTestNamingConventionRule.java

@@ -0,0 +1,36 @@
+package org.baeldung.pmd;
+
+import net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceDeclaration;
+import net.sourceforge.pmd.lang.java.rule.AbstractJavaRule;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+
+public class UnitTestNamingConventionRule extends AbstractJavaRule {
+
+    private static List<String> allowedEndings = Arrays.asList(
+      "IntegrationTest",
+      "IntTest",
+      "ManualTest",
+      "JdbcTest",
+      "LiveTest",
+      "UnitTest",
+      "jmhTest");
+
+    public Object visit(ASTClassOrInterfaceDeclaration node, Object data) {
+        String className = node.getImage();
+        Objects.requireNonNull(className);
+
+        if (className.endsWith("SpringContextTest")) {
+            return data;
+        }
+        
+        if (className.endsWith("Tests")
+                || (className.endsWith("Test") && allowedEndings.stream().noneMatch(className::endsWith))) {
+            addViolation(data, node);
+        }
+
+        return data;
+    }
+}

custom-pmd/src/main/resources/logback.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
+            </pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT" />
+    </root>
+</configuration>