config/pmd/pmdrules.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   3 <!--
   4     Custom rule set
   5     for PMD [ https://pmd.github.io/ ] 6.13.0 or later
   6
   7     Copyright(c) 2019 olyutorskii
   8 -->
   9
  10 <ruleset
  11   xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
  12   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  13   xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0
  14   https://pmd.sourceforge.io/ruleset_2_0_0.xsd"
  15   name="Custom ruleset"
  16 >
  17
  18     <description>
  19         custom rulesets
  20     </description>
  21
  22     <rule ref="category/java/bestpractices.xml" />
  23
  24     <rule ref="category/java/codestyle.xml" >
  25         <exclude name="CommentDefaultAccessModifier" />
  26         <exclude name="DefaultPackage" />
  27         <exclude name="LocalVariableCouldBeFinal" />
  28         <exclude name="MethodArgumentCouldBeFinal" />
  29         <exclude name="OnlyOneReturn" />
  30         <exclude name="ShortVariable" />
  31         <exclude name="UnnecessaryLocalBeforeReturn" />
  32         <exclude name="UnnecessaryReturn" />
  33     </rule>
  34     <rule ref="category/java/codestyle.xml/ClassNamingConventions" >
  35         <properties>
  36             <property name="utilityClassPattern" value="[A-Z][a-zA-Z0-9]*"/>
  37         </properties>
  38     </rule>
  39     <rule ref="category/java/codestyle.xml/ControlStatementBraces" >
  40         <properties>
  41             <property name="checkIfElseStmt" value="false"/>
  42             <property name="checkSingleIfStmt" value="false"/>
  43         </properties>
  44     </rule>
  45     <rule ref="category/java/codestyle.xml/LongVariable" >
  46         <properties>
  47             <property name="minimum" value="25"/>
  48         </properties>
  49     </rule>
  50
  51     <rule ref="category/java/design.xml" >
  52         <exclude name="AvoidThrowingNullPointerException" />
  53         <exclude name="AvoidUncheckedExceptionsInSignatures" />
  54         <exclude name="LawOfDemeter" />
  55         <exclude name="LoosePackageCoupling" />
  56     </rule>
  57
  58     <rule ref="category/java/documentation.xml" />
  59     <rule ref="category/java/documentation.xml/CommentRequired" >
  60         <properties>
  61             <property name="fieldCommentRequirement" value="Ignored"/>
  62         </properties>
  63     </rule>
  64     <rule ref="category/java/documentation.xml/CommentSize" >
  65         <properties>
  66             <property name="maxLines" value="25"/>
  67         </properties>
  68     </rule>
  69
  70     <rule ref="category/java/errorprone.xml" >
  71         <exclude name="AvoidLiteralsInIfCondition" />
  72         <exclude name="BeanMembersShouldSerialize" />
  73         <exclude name="DataflowAnomalyAnalysis" />
  74     </rule>
  75
  76     <rule ref="category/java/multithreading.xml" />
  77
  78     <rule ref="category/java/performance.xml" >
  79         <exclude name="AvoidUsingShortType" />
  80         <exclude name="ConsecutiveAppendsShouldReuse" />
  81         <exclude name="RedundantFieldInitializer" />
  82     </rule>
  83
  84     <rule ref="category/java/security.xml" />
  85
  86     <!--rule ref="category/pom/errorprone.xml" /-->
  87
  88     <!--rule ref="category/xml/errorprone.xml" /-->
  89
  90 </ruleset>
  91
  92 <!-- EOF -->