pmd-ruleset.xml

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Android Application Rules"
  xmlns="http://pmd.sf.net/ruleset/1.0.0"
  xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd"
  xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd">

  <!--Reference: https://pmd.github.io/pmd-5.8.0/pmd-java/rules/index.html-->
  <description>Custom rule set for Android application</description>

  <exclude-pattern>.*/R.java</exclude-pattern>
  <exclude-pattern>.*/gen/.*</exclude-pattern>

  <rule ref="category/java/bestpractices.xml">
    <!-- Include if you care more about performance and method counts than encapsulation. -->
    <exclude name="AccessorMethodGeneration"/>
  </rule>
  <rule ref="category/java/bestpractices.xml/JUnitTestContainsTooManyAsserts">
    <properties>
      <property name="maximumAsserts" value="3"/>
    </properties>
  </rule>
  <rule ref="category/java/codestyle.xml">
    <exclude name="AtLeastOneConstructor"/>
    <exclude name="AbstractNaming"/>
    <!-- Overkill -->
    <exclude name="AvoidFinalLocalVariable"/>
    <exclude name="CallSuperInConstructor"/>
    <exclude name="LongVariable"/>
    <exclude name="ShortMethodName"/>
    <exclude name="ShortVariable"/>
    <exclude name="ShortClassName"/>
    <exclude name="GenericsNaming"/>
    <exclude name="DefaultPackage"/>
    <exclude name="OnlyOneReturn"/>
    <!-- Exclude if underscore is allowed in variable names. -->
    <!--<exclude name="VariableNamingConventions" />-->
    <!-- Exclude if you use Espresso. -->
    <exclude name="TooManyStaticImports"/>
    <!-- Exclude if you use a lot of package private declarations. -->
    <!--<exclude name="CommentDefaultAccessModifier"/>-->
  </rule>
  <rule ref="category/java/codestyle.xml/ClassNamingConventions">
    <properties>
      <!-- Allow utility class to have normal names. -->
      <property name="utilityClassPattern" value="[A-Z][a-zA-Z]+"/>
    </properties>
  </rule>
  <rule ref="category/java/design.xml">
    <!-- Very common in activities. -->
    <exclude name="LawOfDemeter"/>
    <exclude name="LoosePackageCoupling"/>
  </rule>
  <rule ref="category/java/design.xml/NcssCount">
    <properties>
      <property name="methodReportLevel" value="20"/>
    </properties>
  </rule>
  <rule ref="category/java/documentation.xml">
    <!-- The copyright header is too large so just ignore this rule. -->
    <exclude name="CommentSize"/>
  </rule>
  <!--<rule ref="category/java/documentation.xml/CommentSize">-->
    <!--<properties>-->
      <!--<property name="maxLines" value="7"/>-->
      <!--<property name="maxLineLength" value="120"/>-->
    <!--</properties>-->
  <!--</rule>-->
  <rule ref="category/java/errorprone.xml">
    <!-- Only classes implements Serializable should care about this rule. -->
    <exclude name="BeanMembersShouldSerialize"/>
    <!-- This rule always reports error for for-each loop. -->
    <exclude name="DataflowAnomalyAnalysis"/>
    <!-- Usually intended -->
    <exclude name="NullAssignment"/>
    <!-- Exclude if causes problems with SQL Strings that usually require duplication -->
    <!--<exclude name="AvoidDuplicateLiterals"/>-->
  </rule>
  <!-- Allow field like isXXX has the same name as a method. -->
  <rule ref="category/java/errorprone.xml/AvoidFieldNameMatchingMethodName">
    <properties>
      <property name="violationSuppressRegex" value="Field is[A-Z][\w]* has the same name as a method"/>
    </properties>
  </rule>
  <!-- Add "1" to the list of default allowed magic numbers [-1,0]. -->
  <rule ref="category/java/errorprone.xml/AvoidLiteralsInIfCondition">
    <properties>
      <property name="ignoreMagicNumbers" value="-1,0,1"/>
    </properties>
  </rule>
  <rule ref="category/java/multithreading.xml"/>
  <rule ref="category/java/performance.xml"/>

</ruleset>