-
Notifications
You must be signed in to change notification settings - Fork 89
/
apex_ruleset.xml
269 lines (259 loc) · 10 KB
/
apex_ruleset.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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<?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="Default ruleset used by the CodeClimate Engine for Salesforce.com Apex" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
<description>Default ruleset used by the Code Climate Engine for Salesforce.com Apex</description>
<exclude-pattern>.*/.sfdx/.*</exclude-pattern>
<!-- COMPLEXITY -->
<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="4" />
</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/TooManyFields" message="Too many fields">
<priority>3</priority>
<properties>
<property name="maxfields" value="20" />
</properties>
</rule>
<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/CognitiveComplexity">
<properties>
<property name="classReportLevel" value="50" />
<property name="methodReportLevel" value="15" />
</properties>
</rule>
<!-- PERFORMANCE -->
<rule ref="category/apex/performance.xml/OperationWithLimitsInLoop">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/AvoidDirectAccessTriggerMap" message="Avoid directly accessing Trigger.old and Trigger.new">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/bestpractices.xml/AvoidLogicInTrigger" message="Avoid logic in triggers">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/bestpractices.xml/AvoidGlobalModifier" message="Avoid using global modifier">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/AvoidNonExistentAnnotations">
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/AvoidHardcodingId" message="Avoid hardcoding ID's">
<priority>3</priority>
<properties>
</properties>
</rule>
<!-- NAMING -->
<rule ref="category/apex/codestyle.xml/ClassNamingConventions" message="Class names should begin with an uppercase character">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/codestyle.xml/MethodNamingConventions" message="Method name does not begin with a lower case character.">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/MethodWithSameNameAsEnclosingClass" message="Classes should not have non-constructor methods with the same name as the class">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/codestyle.xml/FieldNamingConventions">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/codestyle.xml/FormalParameterNamingConventions">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/codestyle.xml/LocalVariableNamingConventions">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/codestyle.xml/PropertyNamingConventions">
<priority>3</priority>
<properties>
</properties>
</rule>
<!-- TESTS -->
<rule ref="category/apex/bestpractices.xml/ApexAssertionsShouldIncludeMessage">
<priority>4</priority>
</rule>
<rule ref="category/apex/bestpractices.xml/ApexUnitTestMethodShouldHaveIsTestAnnotation" >
<priority>4</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>3</priority>
<properties>
</properties>
</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>
<properties>
</properties>
</rule>
<!-- SECURITY -->
<rule ref="category/apex/security.xml/ApexSharingViolations" message="Apex classes should declare a sharing model if DML or SOQL is used">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexInsecureEndpoint" message="Apex callouts should use encrypted communication channels">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/ApexCSRF">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexOpenRedirect" message="Apex classes should safely redirect to a known location">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexSOQLInjection" message="Apex classes should escape variables merged in DML query">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexXSSFromURLParam" message="Apex classes should escape Strings obtained from URL parameters">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexXSSFromEscapeFalse" message="Apex classes should escape addError strings">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexBadCrypto" message="Apex Crypto should use random IV/key">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexCRUDViolation" message="Validate CRUD permission before SOQL/DML operation">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexDangerousMethods" message="Calling potentially dangerous method">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/security.xml/ApexSuggestUsingNamedCred" message="Consider using named credentials for authenticated callouts">
<priority>3</priority>
<properties>
</properties>
</rule>
<!-- BRACES -->
<rule ref="category/apex/codestyle.xml/IfStmtsMustUseBraces" message="Avoid using if statements without curly braces">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/codestyle.xml/WhileLoopsMustUseBraces" message="Avoid using 'while' statements without curly braces">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/codestyle.xml/IfElseStmtsMustUseBraces" message="Avoid using 'if...else' statements without curly braces">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/codestyle.xml/ForLoopsMustUseBraces" message="Avoid using 'for' statements without curly braces">
<priority>3</priority>
<properties>
</properties>
</rule>
<!-- EMPTY -->
<rule ref="category/apex/errorprone.xml/EmptyCatchBlock" message="Avoid empty catch blocks">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyIfStmt" message="Avoid empty 'if' statements">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyWhileStmt" message="Avoid empty 'while' statements">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyTryOrFinallyBlock" message="Avoid empty try or finally blocks">
<priority>3</priority>
<properties>
</properties>
</rule>
<rule ref="category/apex/errorprone.xml/EmptyStatementBlock" message="Avoid empty block statements.">
<priority>3</priority>
<properties>
</properties>
</rule>
<!-- STYLE -->
<rule ref="category/apex/codestyle.xml/OneDeclarationPerLine">
<priority>3</priority>
<properties>
</properties>
</rule>
<!-- Visual Force -->
<rule ref="category/visualforce/security.xml/VfCsrf" >
<priority>3</priority>
</rule>
<rule ref="category/visualforce/security.xml/VfUnescapeEl" >
<priority>3</priority>
</rule>
</ruleset>