/
FunctionSignature.kt
43 lines (35 loc) · 2.01 KB
/
FunctionSignature.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
39
40
41
42
43
package io.gitlab.arturbosch.detekt.formatting.wrappers
import com.pinterest.ktlint.core.api.DefaultEditorConfigProperties
import com.pinterest.ktlint.core.api.UsesEditorConfigProperties
import com.pinterest.ktlint.ruleset.experimental.FunctionSignatureRule
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.configWithAndroidVariants
import io.gitlab.arturbosch.detekt.api.internal.AutoCorrectable
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.formatting.FormattingRule
/**
* See [ktlint docs](https://pinterest.github.io/ktlint/rules/experimental/#function-signature) for
* documentation.
*/
@AutoCorrectable(since = "1.22.0")
class FunctionSignature(config: Config) : FormattingRule(config) {
override val wrapping = FunctionSignatureRule()
override val issue = issueFor("Format signature to be single when possible, multiple lines otherwise.")
@Configuration("parameter count means multiline threshold")
private val forceMultilineWhenParameterCountGreaterOrEqualThan by config(2_147_483_647)
@Configuration("indentation size")
private val functionBodyExpressionWrapping by config("default")
@Configuration("maximum line length")
private val maxLineLength by configWithAndroidVariants(120, 100)
@Configuration("indentation size")
private val indentSize by config(4)
override fun overrideEditorConfigProperties(): Map<UsesEditorConfigProperties.EditorConfigProperty<*>, String> =
mapOf(
FunctionSignatureRule.forceMultilineWhenParameterCountGreaterOrEqualThanProperty to
forceMultilineWhenParameterCountGreaterOrEqualThan.toString(),
FunctionSignatureRule.functionBodyExpressionWrappingProperty to functionBodyExpressionWrapping,
DefaultEditorConfigProperties.maxLineLengthProperty to maxLineLength.toString(),
DefaultEditorConfigProperties.indentSizeProperty to indentSize.toString(),
)
}