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
|
package at.hannibal2.skyhanni.detektrules.grammar
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 org.jetbrains.kotlin.psi.KtStringTemplateExpression
/**
* This rule reports all usages of the british spelling over the american spelling in the codebase,
* this will ignore any type annotations, i.e., `@ConfigEditorColour` will not be reported.
*/
class AvoidBritishSpelling(config: Config) : Rule(config) {
override val issue = Issue(
"AvoidBritishSpelling",
Severity.Style,
"Avoid using the word british spelling over american spelling.",
Debt.FIVE_MINS,
)
private val scannedWords = mapOf(
"colour" to "color",
"armour" to "armor",
)
override fun visitStringTemplateExpression(expression: KtStringTemplateExpression) {
val text =
expression.text // Be aware .getText() returns the entire span of this template, including variable names contained within. This should be rare enough of a problem for us to not care about it.
for (word in scannedWords) {
if (text.contains(word.key, ignoreCase = true)) {
report(
CodeSmell(
issue,
Entity.from(expression),
"Avoid using the word '${word.key}' in code, '${word.value}' is preferred instead.",
),
)
}
}
super.visitStringTemplateExpression(expression)
}
}
|
