forked from sevntu-checkstyle/sevntu.checkstyle
/
sevntu-checks.xml
235 lines (224 loc) · 14.1 KB
/
sevntu-checks.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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
<!-- Filters -->
<module name="SuppressionFilter">
<property name="file" value="sevntu-suppressions.xml"/>
</module>
<module name="TreeWalker">
<property name="tabWidth" value="4"/>
<!-- Filters -->
<module name="SuppressionCommentFilter"/>
<module name="SuppressWithNearbyCommentFilter">
<property name="commentFormat" value="-@cs\[(\w{8,})\] \w[\(\)\-\.\'\`\,\:\;\w ]{10,}"/>
<property name="checkFormat" value="$1"/>
<property name="influenceFormat" value="3"/>
</module>
<!-- Annotation -->
<module name="com.github.sevntu.checkstyle.checks.annotation.ForbidAnnotationElementValueCheck">
<property name="annotationName" value="Test"/>
<property name="elementName" value="expected"/>
<property name="forbiddenElementValueRegexp" value=".*"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.annotation.ForbidAnnotationCheck">
<property name="annotationNames" value="Ignore, VisibleForTesting"/>
<property name="annotationTargets" value="METHOD_DEF"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.annotation.RequiredParameterForAnnotationCheck"/>
<module name="com.github.sevntu.checkstyle.checks.annotation.RequiredParameterForAnnotationCheck">
<property name="annotationName" value="Generated"/>
<property name="requiredParameters" value="value"/>
</module>
<!-- Coding -->
<module name="com.github.sevntu.checkstyle.checks.coding.ForbidCCommentsInMethodsCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.NoNullForCollectionReturnCheck">
<property name="collectionList"
value="AbstractCollection AbstractList AbstractQueue AbstractSequentialList AbstractSet ArrayBlockingQueue ArrayDeque ArrayList AttributeList BeanContextServicesSupport BeanContextSupport ConcurrentLinkedDeque ConcurrentLinkedQueue ConcurrentSkipListSet CopyOnWriteArrayList CopyOnWriteArraySet DelayQueue EnumSet HashSet JobStateReasons LinkedBlockingDeque LinkedBlockingQueue LinkedHashSet LinkedList LinkedTransferQueue PriorityBlockingQueue PriorityQueue RoleList RoleUnresolvedList Stack SynchronousQueue TreeSet Vector Collection List Map Set"/>
<property name="searchThroughMethodBody" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.CustomDeclarationOrderCheck">
<property name="customDeclarationOrder"
value="Field(public) ### Field(protected) ### Field(private) ### CTOR(.*) ### Method(.*)### InnerClass()"/>
<property name="caseSensitive" value="true"/>
<property name="fieldPrefix" value=""/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.ForbidReturnInFinallyBlockCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.MultipleStringLiteralsExtendedCheck">
<property name="allowedDuplicates" value="1"/>
<property name="ignoreOccurrenceContext" value="ANNOTATION"/>
<property name="ignoreStringsRegexp" value="^""$"/>
<property name="highlightAllDuplicates" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.AvoidDefaultSerializableInInnerClassesCheck">
<property name="allowPartialImplementation" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.ConfusingConditionCheck">
<property name="multiplyFactorForElseBlocks" value="4"/>
<property name="ignoreInnerIf" value="true"/>
<property name="ignoreSequentialIf" value="true"/>
<property name="ignoreNullCaseInIf" value="true"/>
<property name="ignoreThrowInElse" value="true"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.LogicConditionNeedOptimizationCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.ReturnBooleanFromTernaryCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.ReturnNullInsteadOfBooleanCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.ForbidCertainImportsCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.AvoidModifiersForTypesCheck">
<property name="forbiddenClassesRegexpFinal" value=""/>
<property name="forbiddenClassesRegexpStatic" value="ULC.+"/>
<property name="forbiddenClassesRegexpTransient" value=""/>
<property name="forbiddenClassesRegexpVolatile" value=""/>
<property name="forbiddenClassesRegexpAnnotation" value=""/>
<property name="forbiddenClassesRegexpPrivate" value=""/>
<property name="forbiddenClassesRegexpPackagePrivate" value=""/>
<property name="forbiddenClassesRegexpProtected" value=""/>
<property name="forbiddenClassesRegexpPublic" value=""/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.ForbidCertainMethodCheck">
<property name="methodName" value="assert(True|False)"/>
<property name="argumentCount" value="1"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.OverridableMethodInConstructorCheck">
<property name="checkCloneMethod" value="false"/>
<property name="checkReadObjectMethod" value="false"/>
<property name="matchMethodsByArgCount" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.AvoidNotShortCircuitOperatorsForBooleanCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.MultipleVariableDeclarationsExtendedCheck">
<property name="ignoreCycles" value="false"/>
<property name="ignoreMethods" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.EitherLogOrThrowCheck">
<property name="loggerFullyQualifiedClassName" value="org.slf4j.Logger"/>
<property name="loggingMethodNames" value="error, warn, info, debug"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.AvoidHidingCauseExceptionCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.IllegalCatchExtendedCheck">
<property name="allowThrow" value="true"/>
<property name="allowRethrow" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.ReturnCountExtendedCheck">
<property name="maxReturnCount" value="1"/>
<property name="ignoreMethodLinesCount" value="20"/>
<property name="minIgnoreReturnDepth" value="4"/>
<property name="ignoreEmptyReturns" value="true"/>
<property name="topLinesToIgnoreCount" value="5"/>
<property name="ignoreMethodsNames" value="equals"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.SimpleAccessorNameNotationCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.UnnecessaryParenthesesExtendedCheck">
<property name="ignoreCalculationOfBooleanVariables" value="false"/>
<property name="ignoreCalculationOfBooleanVariablesWithReturn" value="false"/>
<property name="ignoreCalculationOfBooleanVariablesWithAssert" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.ForbidInstantiationCheck">
<property name="forbiddenClasses" value="java.lang.NullPointerExceptionCheck"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.AvoidConstantAsFirstOperandInConditionCheck">
<property name="targetConstantTypes"
value="LITERAL_NULL,LITERAL_TRUE,LITERAL_FALSE,NUM_INT,NUM_DOUBLE,NUM_LONG,NUM_FLOAT"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.FinalizeImplementationCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.ForbidThrowAnonymousExceptionsCheck">
<property name="exceptionClassNameRegex" value="^.*Exception"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.MapIterationInForEachLoopCheck">
<property name="proposeValuesUsage" value="true"/>
<property name="proposeKeySetUsage" value="false"/>
<property name="proposeEntrySetUsage" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.TernaryPerExpressionCountCheck">
<property name="maxTernaryPerExpressionCount" value="1"/>
<property name="ignoreTernaryOperatorsInBraces" value="true"/>
<property name="ignoreIsolatedTernaryOnLine" value="true"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.RedundantReturnCheck">
<property name="allowReturnInEmptyMethodsAndConstructors" value="false"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.SingleBreakOrContinueCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.NumericLiteralNeedsUnderscoreCheck">
<property name="minDecimalSymbolLength" value="7"/>
<property name="maxDecimalSymbolsUntilUnderscore" value="3"/>
<property name="minHexSymbolLength" value="5"/>
<property name="maxHexSymbolsUntilUnderscore" value="4"/>
<property name="minBinarySymbolLength" value="9"/>
<property name="maxBinarySymbolsUntilUnderscore" value="8"/>
<property name="ignoreFieldNamePattern" value="serialVersionUID"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.coding.EmptyPublicCtorInClassCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.DiamondOperatorForVariableDefinitionCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.NameConventionForJunit4TestClassesCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.UselessSuperCtorCallCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.UselessSingleCatchCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.WhitespaceBeforeArrayInitializerCheck"/>
<module name="com.github.sevntu.checkstyle.checks.coding.MoveVariableInsideIfCheck" />
<module name="com.github.sevntu.checkstyle.checks.coding.RequireFailForTryCatchInJunitCheck" />
<module name="com.github.sevntu.checkstyle.checks.coding.Jsr305AnnotationsCheck">
<!-- we ignore this Check only because we are not ready to follow it and refactor whole project for now-->
<property name="severity" value="ignore"/>
<property name="packages" value="com.github.sevntu.checkstyle.checks.naming,com.github.sevntu.checkstyle.checks.coding"/>
<property name="excludePackages" value="com.github.sevntu.checkstyle.checks.sizes,com.github.sevntu.checkstyle.checks.design"/>
<property name="allowOverridingReturnValue" value="false"/>
<property name="allowOverridingParameter" value="false"/>
</module>
<!-- Design -->
<module name="com.github.sevntu.checkstyle.checks.design.ChildBlockLengthCheck">
<property name="blockTypes"
value="LITERAL_IF,LITERAL_ELSE,LITERAL_WHILE,LITERAL_DO,LITERAL_FOR,LITERAL_SWITCH,LITERAL_TRY,LITERAL_CATCH"/>
<property name="maxChildBlockPercentage" value="90"/>
<property name="ignoreBlockLinesCount" value="50"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.design.ForbidWildcardAsReturnTypeCheck">
<property name="checkPublicMethods" value="true"/>
<property name="checkPackageMethods" value="true"/>
<property name="checkProtectedMethods" value="true"/>
<property name="checkPrivateMethods" value="false"/>
<property name="checkOverrideMethods" value="false"/>
<property name="checkDeprecatedMethods" value="false"/>
<property name="allowReturnWildcardWithSuper" value="false"/>
<property name="allowReturnWildcardWithExtends" value="false"/>
<property name="returnTypeClassNamesIgnoreRegex" value="^(Comparator|Comparable)$"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.design.NoMainMethodInAbstractClassCheck"/>
<module name="com.github.sevntu.checkstyle.checks.design.PublicReferenceToPrivateTypeCheck"/>
<module name="com.github.sevntu.checkstyle.checks.design.StaticMethodCandidateCheck">
<property name="skippedMethods" value="readObject, writeObject, readObjectNoData, readResolve, writeReplace"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.design.ConstructorWithoutParamsCheck">
<property name="classNameFormat" value=".*Exception$"/>
<property name="ignoredClassNameFormat" value="UnsupportedOperationException"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.design.InnerClassCheck"/>
<module name="com.github.sevntu.checkstyle.checks.design.HideUtilityClassConstructorCheck"/>
<module name="com.github.sevntu.checkstyle.checks.design.NestedSwitchCheck"/>
<module name="com.github.sevntu.checkstyle.checks.design.AvoidConditionInversionCheck"/>
<module name="com.github.sevntu.checkstyle.checks.design.CauseParameterInExceptionCheck"/>
<module name="com.github.sevntu.checkstyle.checks.design.CheckstyleTestMakeupCheck"/>
<!-- Naming -->
<module name="com.github.sevntu.checkstyle.checks.naming.InterfaceTypeParameterNameCheck">
<property name="format" value="^[A-Z]$"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.naming.EnumValueNameCheck">
<property name="format" value="^[A-Z][a-zA-Z0-9_]*$"/>
</module>
<module name="com.github.sevntu.checkstyle.checks.naming.UniformEnumConstantNameCheck">
<property name="formats" value="^[A-Z][a-zA-Z0-9]*$,^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
</module>
<!-- Sizes -->
<module name="com.github.sevntu.checkstyle.checks.sizes.LineLengthExtendedCheck">
<property name="ignorePattern" value="^$"/>
<property name="max" value="100"/>
<property name="tabWidth" value="4"/>
<property name="ignoreClass" value="false"/>
<property name="ignoreConstructor" value="false"/>
<property name="ignoreField" value="false"/>
<property name="ignoreMethod" value="false"/>
</module>
<!-- moved to checkstyle project since 1.21.0 -->
<!--
<module name="com.github.sevntu.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck">
<property name="validateCommentNodes" value="false"/>
</module>
-->
</module>
</module>