forked from detekt/detekt
/
FunctionParameterNaming.kt
76 lines (65 loc) · 2.96 KB
/
FunctionParameterNaming.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
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
package io.gitlab.arturbosch.detekt.rules.naming
import io.gitlab.arturbosch.detekt.api.CodeSmell
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.api.Debt
import io.gitlab.arturbosch.detekt.api.Entity
import io.gitlab.arturbosch.detekt.api.Issue
import io.gitlab.arturbosch.detekt.api.Rule
import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.api.UnstableApi
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.configWithFallback
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.rules.identifierName
import io.gitlab.arturbosch.detekt.rules.isOverride
import io.gitlab.arturbosch.detekt.rules.naming.util.isContainingExcludedClass
import org.jetbrains.kotlin.psi.KtNamedFunction
import org.jetbrains.kotlin.psi.KtParameter
/**
* Reports function parameter names that do not follow the specified naming convention.
*/
@ActiveByDefault(since = "1.0.0")
class FunctionParameterNaming(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
javaClass.simpleName,
Severity.Style,
"Function parameter names should follow the naming convention set in the projects configuration.",
debt = Debt.FIVE_MINS
)
@Configuration("naming pattern")
private val parameterPattern: Regex by config("[a-z][A-Za-z0-9]*", String::toRegex)
@Configuration("ignores variables in classes which match this regex")
private val excludeClassPattern: Regex by config("$^", String::toRegex)
@Configuration("ignores overridden functions with parameters not matching the pattern")
@Deprecated("Use `ignoreOverridden` instead")
private val ignoreOverriddenFunctions: Boolean by config(true)
@Suppress("DEPRECATION")
@OptIn(UnstableApi::class)
@Configuration("ignores overridden functions with parameters not matching the pattern")
private val ignoreOverridden: Boolean by configWithFallback(::ignoreOverriddenFunctions, true)
override fun visitParameter(parameter: KtParameter) {
if (parameter.isParameterInFunction()) {
return
}
if (ignoreOverridden && parameter.ownerFunction?.isOverride() == true) {
return
}
val identifier = parameter.identifierName()
if (!identifier.matches(parameterPattern)) {
report(
CodeSmell(
issue,
Entity.from(parameter),
message = "Function parameter names should match the pattern: $parameterPattern"
)
)
}
}
private fun KtParameter.isParameterInFunction(): Boolean {
return this.nameAsSafeName.isSpecial ||
(this.nameIdentifier?.parent?.javaClass == null) ||
(this.ownerFunction !is KtNamedFunction) ||
this.isContainingExcludedClass(excludeClassPattern)
}
}