-
-
Notifications
You must be signed in to change notification settings - Fork 758
/
ConfigSpec.kt
38 lines (31 loc) · 951 Bytes
/
ConfigSpec.kt
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
package io.github.detekt.tooling.api.spec
import java.net.URL
import java.nio.file.Path
interface ConfigSpec {
/**
* If the configuration properties should be validated.
*
* Unknown properties to detekt will get reported as errors.
*/
val shouldValidateBeforeAnalysis: Boolean?
/**
* Property patterns which should be excluded from validation.
*
* Nested yaml properties are separated with a '>': e.g. '.*>.*>excludeThisProp', 'customPart>.*'
*/
val knownPatterns: Collection<String>
/**
* Rely on detekt to configure meaningful defaults.
*
* Additional configuration overwrite single properties of the default file.
*/
val useDefaultConfig: Boolean
/**
* Configuration resources on detekt's classpath.
*/
val resources: Collection<URL>
/**
* Paths to detekt yaml configuration files.
*/
val configPaths: Collection<Path>
}