forked from detekt/detekt
/
ClassNaming.kt
53 lines (46 loc) · 1.92 KB
/
ClassNaming.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
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.config
import io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.rules.identifierName
import org.jetbrains.kotlin.psi.KtClassOrObject
import org.jetbrains.kotlin.psi.KtConstructor
/**
* Reports class or object names that do not follow the specified naming convention.
*/
@ActiveByDefault(since = "1.0.0")
class ClassNaming(config: Config = Config.empty) : Rule(config) {
override val defaultRuleIdAliases: Set<String> = setOf("ClassName")
override val issue = Issue(
javaClass.simpleName,
Severity.Style,
"A class or object name should fit the naming pattern defined in the projects configuration.",
debt = Debt.FIVE_MINS
)
@Configuration("naming pattern")
private val classPattern: Regex by config("[A-Z][a-zA-Z0-9]*") { it.toRegex() }
override fun visitClassOrObject(classOrObject: KtClassOrObject) {
if (classOrObject.nameAsSafeName.isSpecial || classOrObject.nameIdentifier?.parent?.javaClass == null) {
return
}
if (!classOrObject.identifierName().removeSurrounding("`").matches(classPattern)) {
report(
CodeSmell(
issue,
Entity.atName(classOrObject),
message = "Class and Object names should match the pattern: $classPattern"
)
)
}
}
companion object {
const val CLASS_PATTERN = "classPattern"
}
}