forked from checkstyle/checkstyle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
StarterRuleSet-AllRulesByCategory.groovy.txt
459 lines (406 loc) · 11.7 KB
/
StarterRuleSet-AllRulesByCategory.groovy.txt
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
ruleset {
description '''
A Sample Groovy RuleSet containing all CodeNarc Rules, grouped by category.
You can use this as a template for your own custom RuleSet.
Just delete the rules that you don't want to include.
'''
// rulesets/basic.xml
AssertWithinFinallyBlock
AssignmentInConditional
BigDecimalInstantiation
BitwiseOperatorInConditional
BooleanGetBoolean
BrokenNullCheck
BrokenOddnessCheck
ClassForName
ComparisonOfTwoConstants
ComparisonWithSelf
ConstantAssertExpression
ConstantIfExpression
ConstantTernaryExpression
DeadCode
DoubleNegative
DuplicateCaseStatement
DuplicateMapKey
DuplicateSetValue
EmptyCatchBlock
EmptyClass
EmptyElseBlock
EmptyFinallyBlock
EmptyForStatement
EmptyIfStatement
EmptyInstanceInitializer
EmptyMethod
EmptyStaticInitializer
EmptySwitchStatement
EmptySynchronizedStatement
EmptyTryBlock
EmptyWhileStatement
EqualsAndHashCode
EqualsOverloaded
ExplicitGarbageCollection
ForLoopShouldBeWhileLoop
HardCodedWindowsFileSeparator
HardCodedWindowsRootDirectory
IntegerGetInteger
MultipleUnaryOperators
RandomDoubleCoercedToZero
RemoveAllOnSelf
ReturnFromFinallyBlock
ThrowExceptionFromFinallyBlock
// rulesets/braces.xml
ElseBlockBraces
ForStatementBraces
IfStatementBraces
WhileStatementBraces
// rulesets/concurrency.xml
BusyWait
DoubleCheckedLocking
InconsistentPropertyLocking
InconsistentPropertySynchronization
NestedSynchronization
StaticCalendarField
StaticConnection
StaticDateFormatField
StaticMatcherField
StaticSimpleDateFormatField
SynchronizedMethod
SynchronizedOnBoxedPrimitive
SynchronizedOnGetClass
SynchronizedOnReentrantLock
SynchronizedOnString
SynchronizedOnThis
SynchronizedReadObjectMethod
SystemRunFinalizersOnExit
ThisReferenceEscapesConstructor
ThreadGroup
ThreadLocalNotStaticFinal
ThreadYield
UseOfNotifyMethod
VolatileArrayField
VolatileLongOrDoubleField
WaitOutsideOfWhileLoop
// rulesets/convention.xml
ConfusingTernary
// Disabled as the Elvis operator is a very weird language structure. It may lead to potential
// bugs and introduce mess in the code. It is better to use traditional if-else block.
// CouldBeElvis
HashtableIsObsolete
IfStatementCouldBeTernary
InvertedIfElse
LongLiteralWithLowerCaseL
// def is commonly used in Groovy, as it provides greater flexibility and readability.
// The keyword removes boilerplate explicit type declaration.
// NoDef
NoTabCharacter
ParameterReassignment
TernaryCouldBeElvis
TrailingComma
VectorIsObsolete
// rulesets/design.xml
AbstractClassWithPublicConstructor
AbstractClassWithoutAbstractMethod
AssignmentToStaticFieldFromInstanceMethod
BooleanMethodReturnsNull
BuilderMethodWithSideEffects
CloneableWithoutClone
CloseWithoutCloseable
CompareToWithoutComparable
ConstantsOnlyInterface
EmptyMethodInAbstractClass
FinalClassWithProtectedMember
ImplementationAsType
// Using instanceof in equals method is alright
Instanceof {
ignoreTypeNames = 'CheckerFrameworkError'
}
LocaleSetDefault
NestedForLoop
PrivateFieldCouldBeFinal
PublicInstanceField
ReturnsNullInsteadOfEmptyArray
ReturnsNullInsteadOfEmptyCollection
SimpleDateFormatMissingLocale
StatelessSingleton
ToStringReturnsNull
// rulesets/dry.xml
DuplicateListLiteral
DuplicateMapLiteral
// it is ok to use duplication, every number cannot be represented by the same logic
//DuplicateNumberLiteral
// it is ok to use simple duplication in scripts
//DuplicateStringLiteral
// rulesets/enhanced.xml
CloneWithoutCloneable
JUnitAssertEqualsConstantActualValue
UnsafeImplementationAsMap
// rulesets/exceptions.xml
CatchArrayIndexOutOfBoundsException
CatchError
CatchException
CatchIllegalMonitorStateException
CatchIndexOutOfBoundsException
CatchNullPointerException
CatchRuntimeException
CatchThrowable
ConfusingClassNamedException
ExceptionExtendsError
ExceptionExtendsThrowable
ExceptionNotThrown
MissingNewInThrowStatement
ReturnNullFromCatchBlock
SwallowThreadDeath
ThrowError
ThrowException
ThrowNullPointerException
ThrowRuntimeException
ThrowThrowable
// rulesets/formatting.xml
BlankLineBeforePackage
BracesForClass
BracesForForLoop
BracesForIfElse
BracesForMethod
BracesForTryCatchFinally
ClassJavadoc
ClosureStatementOnOpeningLineOfMultipleLineClosure
ConsecutiveBlankLines
FileEndsWithoutNewline
LineLength
MissingBlankLineAfterImports
MissingBlankLineAfterPackage
SpaceAfterCatch
SpaceAfterClosingBrace
SpaceAfterComma
SpaceAfterFor
SpaceAfterIf
SpaceAfterOpeningBrace
SpaceAfterSemicolon
SpaceAfterSwitch
SpaceAfterWhile
SpaceAroundClosureArrow
// The rule makes the Groovy map initializers hard to read.
// SpaceAroundMapEntryColon
SpaceAroundOperator
SpaceBeforeClosingBrace
SpaceBeforeOpeningBrace
TrailingWhitespace
// rulesets/generic.xml
IllegalClassMember
IllegalClassReference
IllegalPackageReference
IllegalRegex
IllegalString
IllegalSubclass
RequiredRegex
RequiredString
StatelessClass
// rulesets/grails.xml
GrailsDomainHasEquals
GrailsDomainHasToString
GrailsDomainReservedSqlKeywordName
GrailsDomainWithServiceReference
GrailsDuplicateConstraint
GrailsDuplicateMapping
GrailsMassAssignment
GrailsPublicControllerMethod
GrailsServletContextReference
GrailsStatelessService
// rulesets/groovyism.xml
AssignCollectionSort
AssignCollectionUnique
ClosureAsLastMethodParameter
CollectAllIsDeprecated
ConfusingMultipleReturns
ExplicitArrayListInstantiation
ExplicitCallToAndMethod
ExplicitCallToCompareToMethod
ExplicitCallToDivMethod
// Groovy's `==` operator which is equivalent to 'equals' method from Java makes code weird to
// Java contributors. It is better to use direct call of 'equals' method to compare objects.
// ExplicitCallToEqualsMethod
ExplicitCallToGetAtMethod
ExplicitCallToLeftShiftMethod
ExplicitCallToMinusMethod
ExplicitCallToModMethod
ExplicitCallToMultiplyMethod
ExplicitCallToOrMethod
ExplicitCallToPlusMethod
ExplicitCallToPowerMethod
ExplicitCallToRightShiftMethod
ExplicitCallToXorMethod
// Suppressed as these rules make the code hard to understand.
// Disabling them helps to have the code more similar to Java.
// ExplicitHashMapInstantiation
// ExplicitHashSetInstantiation
// ExplicitLinkedHashMapInstantiation
// ExplicitLinkedListInstantiation
// ExplicitStackInstantiation
// ExplicitTreeSetInstantiation
GStringAsMapKey
GStringExpressionWithinString
GetterMethodCouldBeProperty
GroovyLangImmutable
UseCollectMany
UseCollectNested
// rulesets/imports.xml
DuplicateImport
ImportFromSamePackage
ImportFromSunPackages
MisorderedStaticImports
// it is ok to keep scripts as small as possible in header
//NoWildcardImports
UnnecessaryGroovyImport {
doNotApplyToFileNames = 'codenarc.groovy'
}
UnusedImport {
doNotApplyToFileNames = 'codenarc.groovy'
}
// rulesets/jdbc.xml
DirectConnectionManagement
JdbcConnectionReference
JdbcResultSetReference
JdbcStatementReference
// rulesets/junit.xml
ChainedTest
CoupledTestCase
JUnitAssertAlwaysFails
JUnitAssertAlwaysSucceeds
JUnitFailWithoutMessage
JUnitLostTest
JUnitPublicField
JUnitPublicNonTestMethod
JUnitPublicProperty
JUnitSetUpCallsSuper
JUnitStyleAssertions
JUnitTearDownCallsSuper
JUnitTestMethodWithoutAssert
JUnitUnnecessarySetUp
JUnitUnnecessaryTearDown
JUnitUnnecessaryThrowsException
SpockIgnoreRestUsed
UnnecessaryFail
UseAssertEqualsInsteadOfAssertTrue
UseAssertFalseInsteadOfNegation
UseAssertNullInsteadOfAssertEquals
UseAssertSameInsteadOfAssertTrue
UseAssertTrueInsteadOfAssertEquals
UseAssertTrueInsteadOfNegation
// rulesets/logging.xml
LoggerForDifferentClass
LoggerWithWrongModifiers
LoggingSwallowsStacktrace
MultipleLoggers
PrintStackTrace
// We use groovy as scripted java, usage of std output is required by design
//Println
SystemErrPrint
SystemOutPrint
// rulesets/naming.xml
AbstractClassName
ClassName
ClassNameSameAsFilename
ClassNameSameAsSuperclass
ConfusingMethodName
FactoryMethodName
FieldName
InterfaceName
InterfaceNameSameAsSuperInterface
MethodName
ObjectOverrideMisspelledMethodName
PackageName
PackageNameMatchesFilePath
ParameterName
PropertyName
VariableName {
finalRegex = null
ignoreVariableNames = 'SEPARATOR,PROFILES,USAGE_STRING'
}
// rulesets/security.xml
FileCreateTempFile
InsecureRandom
// we do not care about EJB container rules
//JavaIoPackageAccess
NonFinalPublicField
NonFinalSubclassOfSensitiveInterface
ObjectFinalize
PublicFinalizeMethod
UnsafeArrayDeclaration
// rulesets/serialization.xml
EnumCustomSerializationIgnored
SerialPersistentFields
SerialVersionUID
SerializableClassMustDefineSerialVersionUID
// rulesets/size.xml
// Requires the GMetrics jar
AbcMetric
ClassSize
// Requires the GMetrics jar and a Cobertura coverage file
CrapMetric
// Requires the GMetrics jar
CyclomaticComplexity
MethodCount
MethodSize
NestedBlockDepth
ParameterCount
// rulesets/unnecessary.xml
AddEmptyString
ConsecutiveLiteralAppends
ConsecutiveStringConcatenation
UnnecessaryBigDecimalInstantiation
UnnecessaryBigIntegerInstantiation
UnnecessaryBooleanExpression
UnnecessaryBooleanInstantiation
UnnecessaryCallForLastElement
UnnecessaryCallToSubstring
UnnecessaryCast
UnnecessaryCatchBlock
UnnecessaryCollectCall
UnnecessaryCollectionCall
UnnecessaryConstructor
UnnecessaryDefInFieldDeclaration
UnnecessaryDefInMethodDeclaration
UnnecessaryDefInVariableDeclaration
UnnecessaryDotClass
UnnecessaryDoubleInstantiation
UnnecessaryElseStatement
UnnecessaryFinalOnPrivateMethod
UnnecessaryFloatInstantiation
// just to be the same as in java, as our primary language
//UnnecessaryGString
// we are ok with code to looks like Java
//UnnecessaryGetter
UnnecessaryIfStatement
UnnecessaryInstanceOfCheck
UnnecessaryInstantiationToGetClass
UnnecessaryIntegerInstantiation
UnnecessaryLongInstantiation
UnnecessaryModOne
UnnecessaryNullCheck
UnnecessaryNullCheckBeforeInstanceOf
UnnecessaryObjectReferences
UnnecessaryOverridingMethod
UnnecessaryPackageReference
UnnecessaryParenthesesForMethodCallWithClosure
UnnecessaryPublicModifier
// Disabled as it makes the code unclear. It becomes hard to understand what value
// is returned by a method.
// UnnecessaryReturnKeyword
UnnecessarySafeNavigationOperator
UnnecessarySelfAssignment
UnnecessarySemicolon
UnnecessaryStringInstantiation
// Suppressed to avoid weird code and make the code more similar to Java.
// UnnecessarySubstring
UnnecessaryTernaryExpression
UnnecessaryToString
UnnecessaryTransientModifier
// rulesets/unused.xml
UnusedArray
UnusedMethodParameter
UnusedObject
UnusedPrivateField
UnusedPrivateMethod
UnusedPrivateMethodParameter
UnusedVariable
}