Fix false positive with UnusedPrivateMember on parameter of a protect…

…ed function
detekt · Aug 6, 2021 · 1f9011a · 1f9011a
1 parent 23ffe7c
commit 1f9011a
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/detekt-psi-utils/api/detekt-psi-utils.api b/detekt-psi-utils/api/detekt-psi-utils.api
@@ -105,6 +105,7 @@ public final class io/gitlab/arturbosch/detekt/rules/KtModifierListKt {
 	public static final fun isOpen (Lorg/jetbrains/kotlin/psi/KtModifierListOwner;)Z
 	public static final fun isOperator (Lorg/jetbrains/kotlin/psi/KtModifierListOwner;)Z
 	public static final fun isOverride (Lorg/jetbrains/kotlin/psi/KtModifierListOwner;)Z
+	public static final fun isProtected (Lorg/jetbrains/kotlin/psi/KtModifierListOwner;)Z
 	public static final fun isPublicNotOverridden (Lorg/jetbrains/kotlin/psi/KtModifierListOwner;)Z
 }
 

diff --git a/detekt-psi-utils/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/KtModifierList.kt b/detekt-psi-utils/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/KtModifierList.kt
@@ -30,3 +30,5 @@ fun KtModifierListOwner.isInline() = hasModifier(KtTokens.INLINE_KEYWORD)
 fun KtModifierListOwner.isExpect() = hasModifier(KtTokens.EXPECT_KEYWORD)
 
 fun KtModifierListOwner.isActual() = hasModifier(KtTokens.ACTUAL_KEYWORD)
+
+fun KtModifierListOwner.isProtected() = hasModifier(KtTokens.PROTECTED_KEYWORD)
diff --git a/...ules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMember.kt b/...ules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMember.kt
@@ -42,6 +42,7 @@ import org.jetbrains.kotlin.psi.KtSecondaryConstructor
 import org.jetbrains.kotlin.psi.psiUtil.containingClassOrObject
 import org.jetbrains.kotlin.psi.psiUtil.getStrictParentOfType
 import org.jetbrains.kotlin.psi.psiUtil.isPrivate
+import org.jetbrains.kotlin.psi.psiUtil.isProtected
 import org.jetbrains.kotlin.resolve.BindingContext
 import org.jetbrains.kotlin.resolve.calls.callUtil.getResolvedCall
 import org.jetbrains.kotlin.types.expressions.OperatorConventions
@@ -256,7 +257,7 @@ private class UnusedParameterVisitor(allowedNames: Regex) : UnusedMemberVisitor(
 
     private fun KtNamedFunction.isAllowedToHaveUnusedParameters() =
         isAbstract() || isOpen() || isOverride() || isOperator() || isMainFunction() || isExternal() ||
-            isExpect() || isActual()
+            isExpect() || isActual() || isProtected()
 }
 
 private class UnusedPropertyVisitor(allowedNames: Regex) : UnusedMemberVisitor(allowedNames) {

diff --git a/...-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt b/...-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt
@@ -128,6 +128,18 @@ class UnusedPrivateMemberSpec : Spek({
         }
     }
 
+    describe("protected functions") {
+
+        it("should not report parameters in protected functions") {
+            val code = """
+                open class Foo {
+                    protected fun fee(bar: String) {}
+                }
+            """.trimIndent()
+            assertThat(subject.lint(code)).isEmpty()
+        }
+    }
+
     describe("overridden functions") {
 
         it("should not report parameters in not private functions") {