ort-server/.detekt.yml at main · eclipse-apoapsis/ort-server · GitHub

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
# Copyright (C) 2022 The ORT Server Authors (See <https://github.com/eclipse-apoapsis/ort-server/blob/main/NOTICE>)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# License-Filename: LICENSE

# Configuration of detekt rule sets, see https://detekt.dev/docs/intro.
# This file only lists the differences to the default configuration at
# https://github.com/detekt/detekt/blob/main/detekt-core/src/main/resources/default-detekt-config.yml.

comments:
  AbsentOrWrongFileLicense:
    active: true
    excludes: ['**/build/generated/**']
    licenseTemplate: |
      ^\/\*
       \* (C)opyright \(C\) 20[0-9][0-9] The ORT Server Authors \(See \<https:\/\/github\.com\/eclipse-apoapsis\/ort-server\/blob\/main\/NOTICE\>\)
       \*
       \* Licensed under the Apache License, Version 2\.0 \(the "License"\);
       \* you may not use this file except in compliance with the License\.
       \* You may obtain a copy of the License at
       \*
       \*     https:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0
       \*
       \* Unless required by applicable law or agreed to in writing, software
       \* distributed under the License is distributed on an "AS IS" BASIS,
       \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.
       \* See the License for the specific language governing permissions and
       \* limitations under the License\.
       \*
       \* SPDX-License-Identifier(:) Apache-2\.0
       \* License-Filename: LICENSE
       \*\/$
    licenseTemplateIsRegex: true

complexity:
  CyclomaticComplexMethod:
    allowedComplexity: 33
  LongMethod:
    allowedLines: 158
  LongParameterList:
    allowedConstructorParameters: 11
    allowedFunctionParameters: 11
  NestedBlockDepth:
    allowedDepth: 10
  TooManyFunctions:
    allowedFunctionsPerClass: 19
    allowedFunctionsPerObject: 14

coroutines:
  InjectDispatcher:
    active: false

# Formatting rules are implemented via the ktlint plugin. As ktlint does not allow exceptions, we need to disable
# respective rules completely.
ktlint:
  AnnotationOnSeparateLine:
    active: false
  ArgumentListWrapping:
    active: false
  ChainMethodContinuation:
    active: false
  ChainWrapping:
    active: false
  ClassSignature:
    active: false
  CommentWrapping:
    active: false
  FinalNewline:
    active: false
  FunctionSignature:
    active: false
  ImportOrdering:
    active: false
  Indentation:
    active: false
  MaximumLineLength:
    active: false
  NoBlankLineInList:
    active: false
  NoWildcardImports:
    active: false
  ParameterListWrapping:
    active: false
  SpacingBetweenDeclarationsWithAnnotations:
    active: false
  StringTemplateIndent:
    active: false
  TrailingCommaOnCallSite:
    active: true
    useTrailingCommaOnCallSite: false
  TrailingCommaOnDeclarationSite:
    active: true
    useTrailingCommaOnDeclarationSite: false

naming:
  InvalidPackageDeclaration:
    active: false

performance:
  SpreadOperator:
    active: false

style:
  ForbiddenComment:
    active: false
  ForbiddenMethodCall:
    active: true
    # Use org.eclipse.apoapsis.ortserver.utils.logging.runBlocking to make sure the MDC context is preserved.
    # An exception to that is code where the MDC context is not relevant, e.g., in tests.
    methods: ['kotlinx.coroutines.runBlocking']
    excludes: ['**/cli/**'] # The CLI does not have accees to the utils package, therefore, exclude it for this rule.
  LoopWithTooManyJumpStatements:
    active: false
  MagicNumber:
    active: false
  ReturnCount:
    active: false
  SpacingAfterPackageAndImports:
    active: true
  ThrowsCount:
    max: 5
  WildcardImport:
    excludeImports:
      - org.eclipse.apoapsis.ortserver.core.plugins.*

ORT:
  OrtImportOrder:
    active: true
  OrtPackageNaming:
    # TODO: Implement package naming check for ort-server.
    active: false