|
| 1 | +<?xml version="1.0" encoding="UTF-8"?> |
| 2 | +<ruleset name="Default" |
| 3 | + xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" |
| 4 | + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| 5 | + xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd"> |
| 6 | + |
| 7 | + <description> |
| 8 | + This ruleset checks the code for discouraged programming constructs. |
| 9 | + </description> |
| 10 | + |
| 11 | + <!-- Only rules that don't overlap with CheckStyle! --> |
| 12 | + |
| 13 | + <rule ref="category/java/bestpractices.xml/AvoidUsingHardCodedIP"/> |
| 14 | + <rule ref="category/java/bestpractices.xml/PreserveStackTrace"/> |
| 15 | + <rule ref="category/java/bestpractices.xml/UseCollectionIsEmpty"/> |
| 16 | + <rule ref="category/java/bestpractices.xml/UseStandardCharsets"/> |
| 17 | + |
| 18 | + <!-- Native code is platform dependent; Loading external native libs might pose a security threat --> |
| 19 | + <rule ref="category/java/codestyle.xml/AvoidUsingNativeCode"/> |
| 20 | + <rule ref="category/java/codestyle.xml/IdenticalCatchBranches"/> |
| 21 | + <rule ref="category/java/codestyle.xml/NoPackage"/> |
| 22 | + <rule ref="category/java/codestyle.xml/PrematureDeclaration"/> |
| 23 | + |
| 24 | + <rule ref="category/java/design.xml"> |
| 25 | + <!-- Sometimes abstract classes have just fields --> |
| 26 | + <exclude name="AbstractClassWithoutAnyMethod"/> |
| 27 | + |
| 28 | + <!-- Using RuntimeExceptions is ok --> |
| 29 | + <exclude name="AvoidCatchingGenericException"/> |
| 30 | + <exclude name="AvoidThrowingRawExceptionTypes"/> |
| 31 | + |
| 32 | + <!-- Limit too low --> |
| 33 | + <exclude name="AvoidDeeplyNestedIfStmts"/> |
| 34 | + |
| 35 | + <!-- Limit too low --> |
| 36 | + <exclude name="CouplingBetweenObjects"/> |
| 37 | + |
| 38 | + <!-- Limit too low --> |
| 39 | + <exclude name="CyclomaticComplexity"/> |
| 40 | + |
| 41 | + <!-- Makes entity classes impossible --> |
| 42 | + <exclude name="DataClass"/> |
| 43 | + |
| 44 | + <!-- Used commonly particular in bigger methods with upstream throws --> |
| 45 | + <exclude name="ExceptionAsFlowControl"/> |
| 46 | + |
| 47 | + <!-- Limit too low --> |
| 48 | + <exclude name="ExcessiveImports"/> |
| 49 | + |
| 50 | + <!-- Handled by TooManyFields/TooManyMethods --> |
| 51 | + <exclude name="ExcessivePublicCount"/> |
| 52 | + |
| 53 | + <!-- Prohibits accessing members using multiple depths --> |
| 54 | + <exclude name="LawOfDemeter"/> |
| 55 | + |
| 56 | + <!-- No effect --> |
| 57 | + <exclude name="LoosePackageCoupling"/> |
| 58 | + |
| 59 | + <!-- Prohibits singleton pattern --> |
| 60 | + <exclude name="MutableStaticState"/> |
| 61 | + |
| 62 | + <!-- Some override methods or Junit require this --> |
| 63 | + <exclude name="SignatureDeclareThrowsException"/> |
| 64 | + |
| 65 | + <!-- Reports FP for equals methods --> |
| 66 | + <exclude name="SimplifyBooleanReturns"/> |
| 67 | + |
| 68 | + <!-- Limit too low --> |
| 69 | + <exclude name="TooManyFields"/> |
| 70 | + |
| 71 | + <!-- Limit too low --> |
| 72 | + <exclude name="TooManyMethods"/> |
| 73 | + |
| 74 | + <!-- Limit too low --> |
| 75 | + <exclude name="UseObjectForClearerAPI"/> |
| 76 | + |
| 77 | + <!-- Handled by checkstyle --> |
| 78 | + <exclude name="UseUtilityClass"/> |
| 79 | + </rule> |
| 80 | + |
| 81 | + <rule ref="category/java/design.xml/AvoidDeeplyNestedIfStmts"> |
| 82 | + <properties> |
| 83 | + <property name="problemDepth" value="4"/> |
| 84 | + </properties> |
| 85 | + </rule> |
| 86 | + <rule ref="category/java/design.xml/CouplingBetweenObjects"> |
| 87 | + <properties> |
| 88 | + <property name="threshold" value="100"/> |
| 89 | + </properties> |
| 90 | + </rule> |
| 91 | + <rule ref="category/java/design.xml/CyclomaticComplexity"> |
| 92 | + <properties> |
| 93 | + <property name="classReportLevel" value="150"/> |
| 94 | + <property name="methodReportLevel" value="25"/> |
| 95 | + <property name="cycloOptions" value=""/> |
| 96 | + </properties> |
| 97 | + </rule> |
| 98 | + <rule ref="category/java/design.xml/ExcessiveImports"> |
| 99 | + <properties> |
| 100 | + <property name="minimum" value="200"/> |
| 101 | + </properties> |
| 102 | + </rule> |
| 103 | + <rule ref="category/java/design.xml/TooManyFields"> |
| 104 | + <properties> |
| 105 | + <property name="maxfields" value="50"/> |
| 106 | + </properties> |
| 107 | + </rule> |
| 108 | + <rule ref="category/java/design.xml/TooManyMethods"> |
| 109 | + <properties> |
| 110 | + <property name="maxmethods" value="100"/> |
| 111 | + </properties> |
| 112 | + </rule> |
| 113 | + |
| 114 | + <rule ref="category/java/errorprone.xml/AvoidUsingOctalValues"/> |
| 115 | + <rule ref="category/java/errorprone.xml/BrokenNullCheck"/> |
| 116 | + <rule ref="category/java/errorprone.xml/ComparisonWithNaN"/> |
| 117 | + <rule ref="category/java/errorprone.xml/DoNotCallGarbageCollectionExplicitly"/> |
| 118 | + <rule ref="category/java/errorprone.xml/DontImportSun"/> |
| 119 | + <rule ref="category/java/errorprone.xml/MisplacedNullCheck"/> |
| 120 | + <rule ref="category/java/errorprone.xml/UnnecessaryCaseChange"/> |
| 121 | + |
| 122 | + |
| 123 | + <rule ref="category/java/multithreading.xml"> |
| 124 | + <!-- Just bloats code --> |
| 125 | + <exclude name="AvoidSynchronizedAtMethodLevel"/> |
| 126 | + |
| 127 | + <!-- NOPE --> |
| 128 | + <exclude name="DoNotUseThreads"/> |
| 129 | + |
| 130 | + <!-- Doesn't detect nested thread safe singleton pattern --> |
| 131 | + <exclude name="NonThreadSafeSingleton"/> |
| 132 | + |
| 133 | + <!-- Should relevant for fields that use multithreading which is rare --> |
| 134 | + <exclude name="UseConcurrentHashMap"/> |
| 135 | + </rule> |
| 136 | + |
| 137 | + <rule ref="category/java/performance.xml"> |
| 138 | + <!-- This was fixed in Java 10 --> |
| 139 | + <exclude name="AvoidFileStream"/> |
| 140 | + |
| 141 | + <!-- Used everywhere and has neglectable performance impact --> |
| 142 | + <exclude name="AvoidInstantiatingObjectsInLoops"/> |
| 143 | + |
| 144 | + <!-- Handled by checkstyle --> |
| 145 | + <exclude name="RedundantFieldInitializer"/> |
| 146 | + |
| 147 | + <!-- Nowadays optimized by compiler; No code bloating needed --> |
| 148 | + <exclude name="UseStringBufferForStringAppends"/> |
| 149 | + </rule> |
| 150 | + |
| 151 | + <rule ref="category/java/security.xml"/> |
| 152 | +</ruleset> |
0 commit comments