pmd_rules.xml

<?xml version="1.0"?>

<ruleset name="Kode Konveyor WAR"
	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>WAR project PMD rules of Kode Konveyor</description>

	<rule ref="category/java/bestpractices.xml">
		<exclude name="JUnitAssertionsShouldIncludeMessage" />
		<exclude name="JUnitTestsShouldIncludeAssert" />
		<exclude name="UseAssertTrueInsteadOfAssertEquals" />
		<exclude name="UseAssertNullInsteadOfAssertTrue" />
	</rule>
	<rule ref="category/java/codestyle.xml">
		<exclude name="AvoidFinalLocalVariable" />
		<exclude name="LongVariable" />
		<exclude name="ControlStatementBraces" />
		<exclude name="MethodNamingConventions" />
		<exclude name="AtLeastOneConstructor" />
		<exclude name="LocalVariableCouldBeFinal" />
		<exclude name="GenericsNaming" />
		<exclude name="OnlyOneReturn" />
	</rule>
	<rule ref="category/java/codestyle.xml/MethodNamingConventions">
		<properties>
			<property name="junit4TestPattern"
				value="[a-z][a-zA-Z0-9_]*" />
		</properties>
	</rule>
	<rule ref="category/java/design.xml">
		<exclude name="LawOfDemeter" />
		<exclude name="CyclomaticComplexity" />
		<exclude name="LoosePackageCoupling" />
		<exclude name="UseUtilityClass" />
		<exclude name="DataClass" />
	</rule>
	<rule ref="category/java/design.xml/CyclomaticComplexity">
		<properties>
			<property name="classReportLevel" value="15" />
			<property name="methodReportLevel" value="5" />
		</properties>
	</rule>

	<rule ref="category/java/documentation.xml/CommentRequired">
		<properties>
			<property name="serialVersionUIDCommentRequired"
				value="Unwanted" />
			<property name="serialVersionUIDCommentRequired"
				value="Unwanted" />
			<property name="enumCommentRequirement" value="Unwanted" />
			<property name="protectedMethodCommentRequirement"
				value="Unwanted" />
			<property name="publicMethodCommentRequirement"
				value="Unwanted" />
			<property name="fieldCommentRequirement" value="Unwanted" />
			<property name="headerCommentRequirement" value="Unwanted" />
			<property name="methodWithOverrideCommentRequirement"
				value="Unwanted" />
			<property name="accessorCommentRequirement" value="Unwanted" />
		</properties>
	</rule>
	<rule ref="category/java/errorprone.xml">
		<exclude name="BeanMembersShouldSerialize" />
		<exclude name="DataflowAnomalyAnalysis" />
	</rule>
	<rule ref="category/java/multithreading.xml" />
	<rule ref="category/java/performance.xml" />
	<rule ref="category/java/security.xml" />

	<rule name="GenericsNamesShouldBeDescriptive" language="java"
		message="Generics names should match '[A-Z][a-z0-9]*Type'"
		class="net.sourceforge.pmd.lang.rule.XPathRule">
		<description>
Rule Description
         </description>
		<priority>3</priority>
		<properties>
			<property name="xpath">
				<value><![CDATA[
//TypeDeclaration/ClassOrInterfaceDeclaration/TypeParameters/TypeParameter[
  not(matches(@Image,'[A-Z][a-z0-9]*Type'))
]
]]></value>
			</property>
		</properties>
		<example>
 <![CDATA[
public interface Matrix<KeyType extends Serializable, ValueType extends Serializable> {
    // This is ok...
}
]]>
        </example>
	</rule>
	<rule
		ref="category/java/design.xml/SignatureDeclareThrowsException">
		<properties>
			<property name="IgnoreJUnitCompletely" value="true" />
			<property name="violationSuppressRegex"
				value="/src/integration-test/*" />
		</properties>
	</rule>
	<rule ref="category/java/codestyle.xml/LinguisticNaming">
		<properties>
			<property name="ignoredAnnotations" value="org.junit.Test" />
		</properties>
	</rule>
	<rule ref="category/java/bestpractices.xml/UnusedImports">
		<properties>
			<property name="violationSuppressRegex"
				value="^import static.*\*$" />
		</properties>
	</rule>
	<rule name="JUnitTestsShouldIncludeAssert" language="java"
		message="Junit tests should have checks"
		class="net.sourceforge.pmd.lang.rule.XPathRule">
		<!-- externalInfoUrl="TODO" -->
		<description>

    </description>
		<priority>3</priority>
		<properties>
			<property name="xpath">
				<value>
<![CDATA[
//MethodDeclaration[
  ./preceding-sibling::Annotation[.//@Image='Test'] and
  not(
    .//Name[matches(@Image,'assert')] or
    .//Name[matches(@Image,'verify')] or
    .//PrimarySuffix[matches(@Image,'andExpect')]
  )
]

]]>
            </value>
			</property>
		</properties>
		<!--<example><![CDATA[]]></example> -->
	</rule>

</ruleset>