-
Notifications
You must be signed in to change notification settings - Fork 0
/
custom-apex-rules.xml
206 lines (199 loc) · 9.17 KB
/
custom-apex-rules.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<?xml version="1.0" encoding="UTF-8"?>
<ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Custom Apex Rules" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
<description>Custom Ruleset to use with Apex PMD</description>
<exclude-pattern>.*/.history/.*</exclude-pattern>
<!-- Best Practices -->
<rule ref="category/apex/bestpractices.xml/ApexAssertionsShouldIncludeMessage" message="Apex assertions should include a message">
<priority>3</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/ApexUnitTestClassShouldHaveAsserts" message="Apex unit test classes should have at least one System.assert() or assertEquals() or AssertNotEquals() call">
<priority>2</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/ApexUnitTestClassShouldHaveRunAs">
<priority>2</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/ApexUnitTestMethodShouldHaveIsTestAnnotation" message="Apex test methods should have @isTest annotation">
<priority>2</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/ApexUnitTestShouldNotUseSeeAllDataTrue" message="@isTest(seeAllData=true) should not be used in Apex unit tests because it opens up the existing database data for unexpected modification by tests">
<priority>3</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/AvoidGlobalModifier" message="Avoid using global modifier">
<priority>3</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/AvoidLogicInTrigger" message="Avoid logic in triggers">
<priority>3</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/DebugsShouldUseLoggingLevel" message="Debug statements should include a LoggingLevel">
<priority>3</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/UnusedLocalVariable" message="Detects when a local variable is declared and/or assigned but not used.">
<priority>2</priority>
</rule>
<!-- Code Style -->
<rule ref="category/apex/codestyle.xml/ClassNamingConventions" message="Class names should begin with an uppercase character">
<priority>2</priority>
</rule>
<rule ref="category/apex/codestyle.xml/ForLoopsMustUseBraces" message="Avoid using 'for' statements without curly braces">
<priority>3</priority>
</rule>
<rule ref="category/apex/codestyle.xml/IfElseStmtsMustUseBraces" message="Avoid using 'if...else' statements without curly braces">
<priority>3</priority>
</rule>
<rule ref="category/apex/codestyle.xml/IfStmtsMustUseBraces" message="Avoid using if statements without curly braces">
<priority>3</priority>
</rule>
<rule ref="category/apex/codestyle.xml/LocalVariableNamingConventions" message="Variable declarations should use camelCase">
<priority>3</priority>
</rule>
<rule ref="category/apex/codestyle.xml/MethodNamingConventions" message="Method name does not begin with a lower case character">
<priority>2</priority>
</rule>
<rule ref="category/apex/codestyle.xml/OneDeclarationPerLine">
<priority>2</priority>
</rule>
<rule ref="category/apex/codestyle.xml/PropertyNamingConventions" message="Property declarations should use camelCase">
<priority>3</priority>
</rule>
<rule ref="category/apex/codestyle.xml/WhileLoopsMustUseBraces" message="Avoid using 'while' statements without curly braces">
<priority>3</priority>
</rule>
<!-- Design -->
<rule ref="category/apex/design.xml/AvoidDeeplyNestedIfStmts" message="Deeply nested if..else statements are hard to read">
<priority>3</priority>
<properties>
<property name="problemDepth" value="4" />
</properties>
</rule>
<rule ref="category/apex/design.xml/CyclomaticComplexity">
<priority>3</priority>
<properties>
<property name="classReportLevel" value="40" />
<property name="methodReportLevel" value="10" />
</properties>
</rule>
<rule ref="category/apex/design.xml/ExcessiveClassLength" message="Avoid really long classes (lines of code)">
<priority>3</priority>
<properties>
<property name="minimum" value="1000" />
</properties>
</rule>
<rule ref="category/apex/design.xml/ExcessiveParameterList" message="Avoid long parameter lists">
<priority>3</priority>
<properties>
<property name="minimum" value="10" />
</properties>
</rule>
<rule ref="category/apex/design.xml/ExcessivePublicCount" message="This class has too many public methods and attributes">
<priority>3</priority>
<properties>
<property name="minimum" value="25" />
</properties>
</rule>
<rule ref="category/apex/design.xml/NcssConstructorCount" message="The constructor has an NCSS line count of {0}">
<priority>3</priority>
<properties>
<property name="minimum" value="20" />
</properties>
</rule>
<rule ref="category/apex/design.xml/NcssMethodCount" message="The method {0}() has an NCSS line count of {1}">
<priority>3</priority>
<properties>
<property name="minimum" value="60" />
</properties>
</rule>
<rule ref="category/apex/design.xml/NcssTypeCount" message="The type has an NCSS line count of {0}">
<priority>3</priority>
<properties>
<property name="minimum" value="700" />
</properties>
</rule>
<rule ref="category/apex/design.xml/StdCyclomaticComplexity" message="The {0} ''{1}'' has a Standard Cyclomatic Complexity of {2}">
<priority>3</priority>
<properties>
<property name="reportLevel" value="10" />
</properties>
</rule>
<rule ref="category/apex/design.xml/TooManyFields" message="Too many fields">
<priority>3</priority>
<properties>
<property name="maxfields" value="20" />
</properties>
</rule>
<!-- Documentation -->
<rule ref="category/apex/documentation.xml/ApexDoc" message="ApexDoc comments should be present and valid for classes, methods, and properties that are public or global">
<priority>3</priority>
</rule>
<!-- Error Prone -->
<rule ref="category/apex/errorprone.xml/ApexCSRF" message="Avoid making DML operations in Apex class constructor/init method">
<priority>1</priority>
</rule>
<rule ref="category/apex/errorprone.xml/AvoidDirectAccessTriggerMap" message="Avoid directly accessing Trigger.old and Trigger.new">
<priority>3</priority>
</rule>
<rule ref="category/apex/errorprone.xml/AvoidHardcodingId" message="Avoid hardcoding ID's">
<priority>1</priority>
</rule>
<rule ref="category/apex/errorprone.xml/AvoidNonExistentAnnotations">
<priority>2</priority>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyCatchBlock" message="Avoid empty catch blocks">
<priority>3</priority>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyIfStmt" message="Avoid empty 'if' statements">
<priority>3</priority>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyStatementBlock" message="Avoid empty block statements">
<priority>3</priority>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyTryOrFinallyBlock" message="Avoid empty try or finally blocks">
<priority>3</priority>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyWhileStmt" message="Avoid empty 'while' statements">
<priority>3</priority>
</rule>
<rule ref="category/apex/errorprone.xml/MethodWithSameNameAsEnclosingClass" message="Classes should not have non-constructor methods with the same name as the class">
<priority>2</priority>
</rule>
<!-- Performance -->
<rule ref="category/apex/performance.xml/AvoidDmlStatementsInLoops" message="Avoid DML Statements inside loops">
<priority>1</priority>
</rule>
<rule ref="category/apex/performance.xml/AvoidSoqlInLoops" message="Avoid Soql queries inside loops">
<priority>1</priority>
</rule>
<rule ref="category/apex/performance.xml/AvoidSoslInLoops" message="Avoid Sosl queries inside loops">
<priority>1</priority>
</rule>
<!-- Security -->
<rule ref="category/apex/security.xml/ApexBadCrypto" message="Apex Crypto should use random IV/key">
<priority>1</priority>
</rule>
<rule ref="category/apex/security.xml/ApexCRUDViolation" message="Validate CRUD permission before SOQL/DML operation">
<priority>4</priority>
</rule>
<rule ref="category/apex/security.xml/ApexDangerousMethods" message="Calling potentially dangerous method">
<priority>1</priority>
</rule>
<rule ref="category/apex/security.xml/ApexInsecureEndpoint" message="Apex callouts should use encrypted communication channels">
<priority>1</priority>
</rule>
<rule ref="category/apex/security.xml/ApexOpenRedirect" message="Apex classes should safely redirect to a known location">
<priority>2</priority>
</rule>
<rule ref="category/apex/security.xml/ApexSharingViolations" message="Apex classes should declare a sharing model if DML or SOQL is used">
<priority>1</priority>
</rule>
<rule ref="category/apex/security.xml/ApexSOQLInjection" message="Apex classes should escape variables merged in DML query">
<priority>1</priority>
</rule>
<rule ref="category/apex/security.xml/ApexSuggestUsingNamedCred" message="Consider using named credentials for authenticated callouts">
<priority>3</priority>
</rule>
<rule ref="category/apex/security.xml/ApexXSSFromURLParam" message="Apex classes should escape Strings obtained from URL parameters">
<priority>1</priority>
</rule>
<rule ref="category/apex/security.xml/ApexXSSFromEscapeFalse" message="Apex classes should escape addError strings">
<priority>1</priority>
</rule>
</ruleset>