-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
detekt.yml
94 lines (70 loc) · 2.68 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
config:
# If a property in the configuration is deprecated, that'll fail Detekt execution.
warningsAsErrors: true
processors:
# Blanket disable processors as they are not used.
# Stats would show up in HTML report, but since that's not mergeable it has little value per module.
active: false
console-reports:
exclude:
# Disabled because I don't want to see what kind of reports are generate every time I run detekt.
- 'NotificationReport'
# Disabled because it's very verbose.
- 'FindingsReport'
# Disabled because it's very verbose, even more so than FindingsReport.
- 'FileBasedFindingsReport'
# Enabled, because this gives enough context to see the problems.
#- 'LiteFindingsReport'
comments:
CommentOverPrivateFunction:
# Disabled as I don't agree with it, if a function needs docs, it needs docs. Visibility doesn't change that.
active: false
CommentOverPrivateProperty:
# Disabled as I don't agree with it, if a function needs docs, it needs docs. Visibility doesn't change that.
active: false
UndocumentedPublicClass:
# Disabled as this is not a public library. For now it's not even all in Kotlin.
active: false
# Enforce for production and test code. This negates the excludes in default config.
excludes: [ ]
UndocumentedPublicFunction:
# Disabled as this is not a public library. For now it's not even all in Kotlin.
active: false
# Enforce for production and test code. This negates the excludes in default config.
excludes: [ ]
UndocumentedPublicProperty:
# Disabled as this is not a public library. For now it's not even all in Kotlin.
active: false
# Enforce for production and test code. This negates the excludes in default config.
excludes: [ ]
complexity:
LabeledExpression:
# I don't see a problem with using labels sometimes.
active: false
naming:
BooleanPropertyNaming:
allowedPattern: '^(is|has|are|was)'
style:
ForbiddenComment:
values:
- 'FIXME'
- 'STOPSHIP'
#- 'TODO'
NoTabs:
# I'm a tab guy, I don't pay for space in advance.
active: false
OptionalWhenBraces:
# TODEL https://github.com/detekt/detekt/issues/5133
active: false
MaxLineLength:
# It's unavoidable to have some long lines when stacktraces or links are added as comments.
excludeCommentStatements: true
MultilineRawStringIndentation:
indentSize: 1
ReturnCount:
# Default 2 is not enough, usually a single guard and a condition simply violates this.
max: 3
UnnecessaryParentheses:
active: true
# Match IntelliJ IDEA Kotlin Plugin's UnclearPrecedenceOfBinaryExpression setup.
allowForUnclearPrecedence: true