/
detekt.yml
291 lines (283 loc) · 6.7 KB
/
detekt.yml
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
comments:
CommentOverPrivateProperty:
active: true
UndocumentedPublicClass:
active: true
excludes: ['**/*.kt']
includes: ['**/detekt-api/src/main/**/api/*.kt']
UndocumentedPublicFunction:
active: true
excludes: ['**/*.kt']
includes: ['**/detekt-api/src/main/**/api/*.kt']
complexity:
StringLiteralDuplication:
active: true
excludes: ['**/test/**', '**/*Test.kt', '**/*Spec.kt']
threshold: 5
ignoreAnnotation: true
excludeStringsWithLessThan5Characters: true
ignoreStringsRegex: '$^'
ComplexInterface:
active: true
threshold: 10
includeStaticDeclarations: false
includePrivateDeclarations: false
ComplexMethod:
active: true
ignoreSingleWhenExpression: true
LargeClass:
active: true
excludes: ['**/test/**', '**/*.Test.kt', '**/*.Spec.kt']
MethodOverloading:
active: true
TooManyFunctions:
excludes: ['**/test/**', '**/functionalTest/**']
coroutines:
active: true
GlobalCoroutineUsage:
active: true
RedundantSuspendModifier:
active: true
SleepInsteadOfDelay:
active: true
SuspendFunWithFlowReturnType:
active: true
exceptions:
InstanceOfCheckForException:
active: true
NotImplementedDeclaration:
active: true
ObjectExtendsThrowable:
active: true
RethrowCaughtException:
active: true
ReturnFromFinally:
active: true
ThrowingExceptionFromFinally:
active: true
ThrowingExceptionInMain:
active: true
ThrowingExceptionsWithoutMessageOrCause:
active: true
ThrowingNewInstanceOfSameException:
active: true
formatting:
active: true
android: false
autoCorrect: true
AnnotationSpacing:
active: true
EnumEntryNameCase:
active: true
Filename:
active: false
FunctionReturnTypeSpacing:
active: true
FunctionStartOfBodySpacing:
active: true
MaximumLineLength:
active: false
MultiLineIfElse:
active: true
NoEmptyFirstLineInMethodBlock:
active: true
NullableTypeSpacing:
active: true
PackageName:
active: true
ParameterListSpacing:
active: true
SpacingAroundAngleBrackets:
active: true
SpacingBetweenFunctionNameAndOpeningParenthesis:
active: true
SpacingAroundDoubleColon:
active: true
SpacingAroundUnaryOperator:
active: true
SpacingBetweenDeclarationsWithAnnotations:
active: true
SpacingBetweenDeclarationsWithComments:
active: true
TypeParameterListSpacing:
active: true
naming:
ClassNaming:
excludes: ['**/*Spec.kt']
FunctionNaming:
active: true
excludes:
- '**/test/**'
- '**/androidTest/**'
- '**/commonTest/**'
- '**/functionalTest/**'
- '**/jvmTest/**'
- '**/jsTest/**'
- '**/iosTest/**'
TopLevelPropertyNaming:
constantPattern: '[a-z][_A-Za-z0-9]*|[A-Z][_A-Z0-9]*'
InvalidPackageDeclaration:
active: true
excludes: ['**/build-logic/**/*.kt', '**/*.kts']
NoNameShadowing:
active: true
NonBooleanPropertyPrefixedWithIs:
active: true
VariableMaxLength:
active: true
VariableMinLength:
active: true
performance:
SpreadOperator:
excludes: ['**/test/**', '**/functionalTest/**']
potential-bugs:
AvoidReferentialEquality:
active: true
DontDowncastCollectionTypes:
active: true
DoubleMutabilityForCollection:
active: false
ElseCaseInsteadOfExhaustiveWhen:
active: true
ExitOutsideMain:
active: false
HasPlatformType:
active: true
IgnoredReturnValue:
active: true
ImplicitUnitReturnType:
active: true
MapGetWithNotNullAssertionOperator:
active: true
UnconditionalJumpStatementInLoop:
active: true
UnreachableCatchBlock:
active: true
UnsafeCast:
active: true
excludes: ['**/test/**', '**/*.Test.kt', '**/*.Spec.kt']
UselessPostfixExpression:
active: true
style:
CanBeNonNullable:
active: true
CascadingCallWrapping:
active: true
ClassOrdering:
active: true
CollapsibleIfStatements:
active: true
DestructuringDeclarationWithTooManyEntries:
active: true
EqualsOnSignatureLine:
active: true
ExplicitCollectionElementAccessMethod:
active: true
ExplicitItLambdaParameter:
active: true
ForbiddenComment:
active: true
values:
- 'TODO:'
- 'FIXME:'
- 'STOPSHIP:'
- '@author'
- '@requiresTypeResolution'
excludes: ['**/detekt-rules-style/**/ForbiddenComment.kt']
ForbiddenImport:
active: true
imports:
- value: 'org.assertj.core.api.Assertions'
reason: 'Import Assertions.assertThat instead.'
- value: 'org.junit.jupiter.api.Assertions*'
reason: 'Use AssertJ assertions instead.'
ForbiddenMethodCall:
active: true
methods:
- 'kotlin.io.print'
- 'kotlin.io.println'
- 'java.net.URL.openStream'
- 'java.lang.Class.getResourceAsStream'
- 'java.lang.ClassLoader.getResourceAsStream'
- 'org.jetbrains.kotlin.diagnostics.DiagnosticUtils.getLineAndColumnInPsiFile'
ForbiddenVoid:
active: true
LibraryCodeMustSpecifyReturnType:
active: true
excludes: ['**/*.kt']
includes: ['**/detekt-api/src/main/**/api/*.kt']
MagicNumber:
excludes: ['**/test/**', '**/*Test.kt', '**/*Spec.kt']
ignorePropertyDeclaration: true
ignoreAnnotation: true
ignoreEnums: true
ignoreNumbers:
- '-1'
- '0'
- '1'
- '2'
- '100'
- '1000'
MandatoryBracesLoops:
active: true
MaxLineLength:
active: true
excludes: ['**/test/**', '**/*Test.kt', '**/*Spec.kt']
excludeCommentStatements: true
NestedClassesVisibility:
active: true
ObjectLiteralToLambda:
active: true
PreferToOverPairSyntax:
active: true
RedundantExplicitType:
active: true
RedundantHigherOrderMapUsage:
active: true
RedundantVisibilityModifierRule:
active: true
ReturnCount:
active: true
excludeGuardClauses: true
SpacingBetweenPackageAndImports:
active: true
UnderscoresInNumericLiterals:
active: true
UnnecessaryAnnotationUseSiteTarget:
active: true
UnnecessaryFilter:
active: true
UnnecessaryLet:
active: true
UnnecessaryInnerClass:
active: true
ignoreAnnotated: ['Nested']
UntilInsteadOfRangeTo:
active: true
UnusedImports:
active: false # formatting already have this rule enabled
UnusedPrivateMember:
active: true
allowedNames: '(_|ignored|expected)'
UseAnyOrNoneInsteadOfFind:
active: true
UseCheckOrError:
active: true
UseEmptyCounterpart:
active: true
UseIfEmptyOrIfBlank:
active: true
UseIsNullOrEmpty:
active: true
UseOrEmpty:
active: true
UseRequire:
active: true
UseRequireNotNull:
active: true
VarCouldBeVal:
active: true
ignoreAnnotated: ['Parameter']
WildcardImport:
active: true
excludeImports: []