HRM

1
build:
2
  maxIssues: 0
3

4
comments:
5
  CommentOverPrivateProperty:
6
    active: true
7
  UndocumentedPublicClass:
8
    active: true
9
    excludes: [ '**/*.kt' ]
10
    includes: [ '**/detekt-api/src/main/**/api/*.kt' ]
11
  UndocumentedPublicFunction:
12
    active: true
13
    excludes: [ '**/*.kt' ]
14
    includes: [ '**/detekt-api/src/main/**/api/*.kt' ]
15

16
complexity:
17
  StringLiteralDuplication:
18
    active: true
19
    excludes: [ '**/test/**', '**/*Test.kt', '**/*Spec.kt' ]
20
    threshold: 5
21
    ignoreAnnotation: true
22
    excludeStringsWithLessThan5Characters: true
23
    ignoreStringsRegex: '$^'
24
  ComplexInterface:
25
    active: true
26
    threshold: 10
27
    includeStaticDeclarations: false
28
    includePrivateDeclarations: false
29
  ComplexMethod:
30
    active: true
31
    ignoreSingleWhenExpression: true
32
  LargeClass:
33
    active: true
34
    excludes: [ '**/test/**', '**/*.Test.kt', '**/*.Spec.kt' ]
35
  MethodOverloading:
36
    active: true
37

38
coroutines:
39
  active: true
40
  GlobalCoroutineUsage:
41
    active: true
42
  RedundantSuspendModifier:
43
    active: true
44
  SleepInsteadOfDelay:
45
    active: true
46
  SuspendFunWithFlowReturnType:
47
    active: true
48

49
exceptions:
50
  InstanceOfCheckForException:
51
    active: true
52
  NotImplementedDeclaration:
53
    active: true
54
  ObjectExtendsThrowable:
55
    active: true
56
  RethrowCaughtException:
57
    active: true
58
  ReturnFromFinally:
59
    active: true
60
  ThrowingExceptionFromFinally:
61
    active: true
62
  ThrowingExceptionInMain:
63
    active: true
64
  ThrowingExceptionsWithoutMessageOrCause:
65
    active: false
66
  ThrowingNewInstanceOfSameException:
67
    active: true
68
  SwallowedException:
69
    active: false
70
  TooGenericExceptionCaught:
71
    active: false
72

73
formatting:
74
  active: true
75
  android: false
76
  autoCorrect: true
77
  AnnotationSpacing:
78
    active: true
79
  EnumEntryNameCase:
80
    active: true
81
  MaximumLineLength:
82
    active: false
83
  MultiLineIfElse:
84
    active: true
85
  NoEmptyFirstLineInMethodBlock:
86
    active: true
87
  PackageName:
88
    active: true
89
  SpacingAroundAngleBrackets:
90
    active: true
91
  SpacingAroundDoubleColon:
92
    active: true
93
  SpacingAroundUnaryOperator:
94
    active: true
95
  SpacingBetweenDeclarationsWithAnnotations:
96
    active: true
97
  SpacingBetweenDeclarationsWithComments:
98
    active: true
99

100
naming:
101
  TopLevelPropertyNaming:
102
    constantPattern: '[a-z][_A-Za-z0-9]*|[A-Z][_A-Z0-9]*'
103
  InvalidPackageDeclaration:
104
    active: true
105
    excludes: [ '**/build-logic/**/*.kt', '**/*.kts' ]
106
  NoNameShadowing:
107
    active: true
108
  NonBooleanPropertyPrefixedWithIs:
109
    active: true
110
  VariableMaxLength:
111
    active: true
112
  VariableMinLength:
113
    active: true
114
  ConstructorParameterNaming:
115
    active: false
116

117
potential-bugs:
118
  AvoidReferentialEquality:
119
    active: true
120
  DontDowncastCollectionTypes:
121
    active: true
122
  DoubleMutabilityForCollection:
123
    active: false
124
  ExitOutsideMain:
125
    active: false
126
  HasPlatformType:
127
    active: true
128
  IgnoredReturnValue:
129
    active: true
130
  ImplicitUnitReturnType:
131
    active: true
132
  MapGetWithNotNullAssertionOperator:
133
    active: true
134
  UnconditionalJumpStatementInLoop:
135
    active: true
136
  UnreachableCatchBlock:
137
    active: true
138
  UnsafeCast:
139
    active: true
140
    excludes: [ '**/test/**', '**/*.Test.kt', '**/*.Spec.kt' ]
141
  UselessPostfixExpression:
142
    active: true
143

144
style:
145
  ClassOrdering:
146
    active: true
147
  CollapsibleIfStatements:
148
    active: true
149
  DestructuringDeclarationWithTooManyEntries:
150
    active: true
151
  EqualsOnSignatureLine:
152
    active: true
153
  ExplicitCollectionElementAccessMethod:
154
    active: true
155
  ExplicitItLambdaParameter:
156
    active: true
157
  ForbiddenComment:
158
    active: true
159
    values:
160
      - 'TODO:'
161
      - 'FIXME:'
162
      - 'STOPSHIP:'
163
      - '@author'
164
      - '@requiresTypeResolution'
165
    excludes: [ '**/detekt-rules-style/**/ForbiddenComment.kt' ]
166
  ForbiddenImport:
167
    active: true
168
    imports:
169
      - 'org.assertj.core.api.Assertions'
170
  ForbiddenMethodCall:
171
    active: true
172
    methods:
173
      - 'kotlin.io.print'
174
      - 'kotlin.io.println'
175
      - 'java.net.URL.openStream'
176
      - 'java.lang.Class.getResourceAsStream'
177
      - 'java.lang.ClassLoader.getResourceAsStream'
178
  ForbiddenVoid:
179
    active: true
180
  LibraryCodeMustSpecifyReturnType:
181
    active: true
182
    excludes: [ '**/*.kt' ]
183
    includes: [ '**/detekt-api/src/main/**/api/*.kt' ]
184
  MagicNumber:
185
    excludes: [ '**/test/**', '**/*Test.kt', '**/*Spec.kt' ]
186
    ignorePropertyDeclaration: true
187
    ignoreAnnotation: true
188
    ignoreEnums: true
189
    ignoreNumbers:
190
      - '-1'
191
      - '0'
192
      - '1'
193
      - '2'
194
      - '100'
195
      - '1000'
196
  MandatoryBracesLoops:
197
    active: true
198
  MaxLineLength:
199
    active: true
200
    excludes: [ '**/test/**', '**/*Test.kt', '**/*Spec.kt' ]
201
    excludeCommentStatements: true
202
    maxLineLength: 240
203
  NestedClassesVisibility:
204
    active: true
205
  ObjectLiteralToLambda:
206
    active: true
207
  PreferToOverPairSyntax:
208
    active: true
209
  RedundantExplicitType:
210
    active: true
211
  RedundantHigherOrderMapUsage:
212
    active: true
213
  RedundantVisibilityModifierRule:
214
    active: true
215
  ReturnCount:
216
    active: true
217
    excludeGuardClauses: true
218
  SpacingBetweenPackageAndImports:
219
    active: true
220
  UnderscoresInNumericLiterals:
221
    active: true
222
  UnnecessaryAnnotationUseSiteTarget:
223
    active: true
224
  UnnecessaryFilter:
225
    active: true
226
  UnnecessaryLet:
227
    active: true
228
  UntilInsteadOfRangeTo:
229
    active: true
230
  UnusedImports:
231
    active: true
232
  UnusedPrivateMember:
233
    active: true
234
    allowedNames: '(_|ignored|expected)'
235
  UseAnyOrNoneInsteadOfFind:
236
    active: true
237
  UseCheckOrError:
238
    active: true
239
  UseEmptyCounterpart:
240
    active: true
241
  UseIfEmptyOrIfBlank:
242
    active: true
243
  UseIsNullOrEmpty:
244
    active: true
245
  UseOrEmpty:
246
    active: true
247
  UseRequire:
248
    active: true
249
  UseRequireNotNull:
250
    active: true
251
  VarCouldBeVal:
252
    active: true
253
    ignoreAnnotated: [ 'Parameter' ]