/
UnreachableCode.kt
59 lines (55 loc) · 1.84 KB
/
UnreachableCode.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
package io.gitlab.arturbosch.detekt.rules.bugs
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.api.internal.RequiresTypeResolution
import org.jetbrains.kotlin.diagnostics.Errors
import org.jetbrains.kotlin.psi.KtExpression
import org.jetbrains.kotlin.resolve.BindingContext
/**
* Reports unreachable code.
* Code can be unreachable because it is behind return, throw, continue or break expressions.
* This unreachable code should be removed as it serves no purpose.
*
* <noncompliant>
* for (i in 1..2) {
* break
* println() // unreachable
* }
*
* throw IllegalArgumentException()
* println() // unreachable
*
* fun f() {
* return
* println() // unreachable
* }
* </noncompliant>
*/
@RequiresTypeResolution
@ActiveByDefault(since = "1.0.0")
class UnreachableCode(config: Config = Config.empty) : Rule(config) {
override val issue = Issue(
"UnreachableCode",
Severity.Warning,
"Unreachable code detected. This code should be removed.",
Debt.TEN_MINS
)
override fun visitExpression(expression: KtExpression) {
super.visitExpression(expression)
if (bindingContext.diagnostics.forElement(expression).any { it.factory == Errors.UNREACHABLE_CODE }) {
report(
CodeSmell(
issue,
Entity.from(expression),
"This expression is unreachable code which should either be used or removed."
)
)
}
}
}