[VarCouldBeVal] fix overrides and lateinit false positives

detekt · Apr 1, 2022 · f8b505c · f8b505c
1 parent e052dbe
commit f8b505c
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/VarCouldBeVal.kt b/detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/VarCouldBeVal.kt
@@ -10,6 +10,8 @@ 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 io.gitlab.arturbosch.detekt.rules.isLateinit
+import io.gitlab.arturbosch.detekt.rules.isOverride
 import org.jetbrains.kotlin.descriptors.DeclarationDescriptor
 import org.jetbrains.kotlin.lexer.KtTokens
 import org.jetbrains.kotlin.psi.KtBinaryExpression
@@ -196,7 +198,7 @@ class VarCouldBeVal(config: Config = Config.empty) : Rule(config) {
 
         private fun KtProperty.isDeclarationCandidate(): Boolean {
             return when {
-                !isVar -> false
+                !isVar || isLateinit() || isOverride() -> false
                 isLocal || isPrivate() -> true
                 else -> {
                     // Check for whether property belongs to an anonymous object

diff --git a/...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/VarCouldBeValSpec.kt b/...-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/VarCouldBeValSpec.kt
@@ -99,6 +99,15 @@ class VarCouldBeValSpec : Spek({
             """.trimIndent()
             assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
         }
+
+        it("does not report lateinit variables") {
+            val code = """
+                class A {
+                    private lateinit var a = 1
+                }
+            """.trimIndent()
+            assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
+        }
     }
 
     describe("local declarations in functions") {
@@ -283,6 +292,20 @@ class VarCouldBeValSpec : Spek({
             assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
         }
 
+        it("should not report when a property overrides a var") {
+            val code = """
+                    interface I {
+                        var optionEnabled: Boolean
+                    }
+                    class Test {
+                        val test = object : I {
+                            override var optionEnabled: Boolean = false
+                        }
+                    }
+                """
+            assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
+        }
+
         context("anonymous objects that escape") {
             it("does not report when an object initializes a variable directly") {
                 val code = """