-
-
Notifications
You must be signed in to change notification settings - Fork 757
/
UnnecessaryBackticks.kt
62 lines (55 loc) · 2.12 KB
/
UnnecessaryBackticks.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
package io.gitlab.arturbosch.detekt.rules.style
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.com.intellij.psi.PsiElement
import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.psi.KtElement
import org.jetbrains.kotlin.psi.KtSimpleNameStringTemplateEntry
import org.jetbrains.kotlin.psi.psiUtil.allChildren
import org.jetbrains.kotlin.psi.psiUtil.canPlaceAfterSimpleNameEntry
import org.jetbrains.kotlin.psi.psiUtil.getStrictParentOfType
import org.jetbrains.kotlin.psi.psiUtil.isIdentifier
/**
* This rule reports unnecessary backticks.
*
* <noncompliant>
* class `HelloWorld`
* </noncompliant>
*
* <compliant>
* class HelloWorld
* </compliant>
*/
class UnnecessaryBackticks(config: Config = Config.empty) : Rule(config) {
override val issue: Issue = Issue(
javaClass.simpleName,
Severity.Style,
"Backticks are unnecessary.",
Debt.FIVE_MINS
)
override fun visitKtElement(element: KtElement) {
element.allChildren
.filter { it.node.elementType == KtTokens.IDENTIFIER && it.hasUnnecessaryBackticks() }
.forEach { report(CodeSmell(issue, Entity.from(it), "Backticks are unnecessary.")) }
super.visitKtElement(element)
}
private fun PsiElement.hasUnnecessaryBackticks(): Boolean {
val unquoted = text.drop(1).dropLast(1)
return when {
(!text.startsWith("`") || !text.endsWith("`")) -> false
(!unquoted.isIdentifier() || unquoted.isKeyword()) -> false
else -> canPlaceAfterSimpleNameEntry(
getStrictParentOfType<KtSimpleNameStringTemplateEntry>()?.nextSibling
)
}
}
private fun String.isKeyword() = this in KEYWORDS || this.all { it == '_' }
companion object {
private val KEYWORDS = KtTokens.KEYWORDS.types.map { it.toString() }
}
}