/
UseArrayLiteralsInAnnotations.kt
77 lines (70 loc) · 2.65 KB
/
UseArrayLiteralsInAnnotations.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
77
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 io.gitlab.arturbosch.detekt.api.internal.ActiveByDefault
import io.gitlab.arturbosch.detekt.rules.safeAs
import org.jetbrains.kotlin.psi.KtAnnotationEntry
import org.jetbrains.kotlin.psi.KtCallExpression
import org.jetbrains.kotlin.psi.KtExpression
import org.jetbrains.kotlin.psi.KtPrimaryConstructor
import org.jetbrains.kotlin.psi.psiUtil.containingClass
/**
* This rule detects annotations which use the arrayOf(...) syntax instead of the array literal [...] syntax.
* The latter should be preferred as it is more readable.
*
* <noncompliant>
* @@PositiveCase(arrayOf("..."))
* </noncompliant>
*
* <compliant>
* @@NegativeCase(["..."])
* </compliant>
*/
@ActiveByDefault(since = "1.21.0")
class UseArrayLiteralsInAnnotations(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
javaClass.simpleName,
Severity.Style,
"Array literals [...] should be preferred as they are more readable than `arrayOf(...)` expressions.",
Debt.FIVE_MINS
)
override fun visitAnnotationEntry(annotationEntry: KtAnnotationEntry) {
for (argument in annotationEntry.valueArguments) {
if (argument.getArgumentExpression().isArrayOfFunctionCall()) {
report(CodeSmell(issue, Entity.from(argument.asElement()), issue.description))
}
}
}
override fun visitPrimaryConstructor(constructor: KtPrimaryConstructor) {
if (constructor.containingClass()?.isAnnotation() != true) return
for (parameter in constructor.valueParameters) {
val defaultValue = parameter.defaultValue ?: continue
if (defaultValue.isArrayOfFunctionCall()) {
report(CodeSmell(issue, Entity.from(defaultValue), issue.description))
}
}
}
private fun KtExpression?.isArrayOfFunctionCall(): Boolean =
this?.safeAs<KtCallExpression>()?.calleeExpression?.text in arrayOfFunctions
companion object {
private val arrayOfFunctions = listOf(
"boolean",
"char",
"byte",
"short",
"int",
"long",
"float",
"double",
"ubyte",
"ushort",
"uint",
"ulong",
).map { "${it}ArrayOf" }.toSet() + "arrayOf"
}
}