forked from detekt/detekt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LibraryEntitiesShouldNotBePublic.kt
72 lines (65 loc) · 2.08 KB
/
LibraryEntitiesShouldNotBePublic.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
package io.gitlab.arturbosch.detekt.libraries
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 org.jetbrains.kotlin.psi.KtClass
import org.jetbrains.kotlin.psi.KtNamedFunction
import org.jetbrains.kotlin.psi.KtTypeAlias
import org.jetbrains.kotlin.psi.psiUtil.isPublic
/**
* Library typealias and classes should be internal or private.
*
* <noncompliant>
* // code from a library
* class A
* </noncompliant>
*
* <compliant>
* // code from a library
* internal class A
* </compliant>
*/
@ActiveByDefault(since = "1.16.0")
class LibraryEntitiesShouldNotBePublic(ruleSetConfig: Config = Config.empty) : Rule(ruleSetConfig) {
override val issue: Issue = Issue(
javaClass.simpleName,
Severity.Style,
"Library classes should not be public.",
Debt.FIVE_MINS
)
override fun visitClass(klass: KtClass) {
if (klass.isInner()) {
return
}
if (klass.isPublic) {
report(CodeSmell(issue, Entity.from(klass), "Class ${klass.nameAsSafeName} should not be public"))
}
}
override fun visitTypeAlias(typeAlias: KtTypeAlias) {
if (typeAlias.isPublic) {
report(
CodeSmell(
issue,
Entity.from(typeAlias),
"TypeAlias ${typeAlias.nameAsSafeName} should not be public"
)
)
}
}
override fun visitNamedFunction(function: KtNamedFunction) {
if (function.isTopLevel && function.isPublic) {
report(
CodeSmell(
issue,
Entity.from(function),
"Top level function ${function.nameAsSafeName} should not be public"
)
)
}
}
}