Support annotation array when ignoring function-naming rule (#2276)

Follow-up on #2259
pinterest · Sep 25, 2023 · a679dd4 · a679dd4
1 parent 0b85b54
commit a679dd4
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 8 deletions.
diff --git a/...tandard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/FunctionNamingRule.kt b/...tandard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/FunctionNamingRule.kt
@@ -1,6 +1,7 @@
 package com.pinterest.ktlint.ruleset.standard.rules
 
 import com.pinterest.ktlint.rule.engine.core.api.ElementType
+import com.pinterest.ktlint.rule.engine.core.api.ElementType.ANNOTATION
 import com.pinterest.ktlint.rule.engine.core.api.ElementType.ANNOTATION_ENTRY
 import com.pinterest.ktlint.rule.engine.core.api.ElementType.FUN
 import com.pinterest.ktlint.rule.engine.core.api.ElementType.FUN_KEYWORD
@@ -118,17 +119,32 @@ public class FunctionNamingRule :
             .any { it.elementType == OVERRIDE_KEYWORD }
 
     private fun ASTNode.isAnnotatedWithAnyOf(excludeWhenAnnotatedWith: Set<String>) =
-        findChildByType(MODIFIER_LIST)
+        findChildByType(MODIFIER_LIST).containsAnnotationEntryWithIdentifierIn(excludeWhenAnnotatedWith)
+
+    private fun ASTNode?.containsAnnotationEntryWithIdentifierIn(excludeWhenAnnotatedWith: Set<String>): Boolean =
+        this
             ?.children()
-            ?.filter { it.elementType == ANNOTATION_ENTRY }
-            ?.mapNotNull { it.findChildByType(ElementType.CONSTRUCTOR_CALLEE) }
-            ?.mapNotNull { it.findChildByType(ElementType.TYPE_REFERENCE) }
-            ?.mapNotNull { it.findChildByType(ElementType.USER_TYPE) }
-            ?.mapNotNull { it.findChildByType(ElementType.REFERENCE_EXPRESSION) }
-            ?.mapNotNull { it.findChildByType(IDENTIFIER) }
-            ?.any { it.text in excludeWhenAnnotatedWith }
+            ?.any {
+                when (it.elementType) {
+                    ANNOTATION -> {
+                        it.containsAnnotationEntryWithIdentifierIn(excludeWhenAnnotatedWith)
+                    }
+                    ANNOTATION_ENTRY -> {
+                        it.annotationEntryName() in excludeWhenAnnotatedWith
+                    }
+                    else -> false
+                }
+            }
             ?: false
 
+    private fun ASTNode.annotationEntryName() =
+        findChildByType(ElementType.CONSTRUCTOR_CALLEE)
+            ?.findChildByType(ElementType.TYPE_REFERENCE)
+            ?.findChildByType(ElementType.USER_TYPE)
+            ?.findChildByType(ElementType.REFERENCE_EXPRESSION)
+            ?.findChildByType(IDENTIFIER)
+            ?.text
+
     public companion object {
         public val IGNORE_WHEN_ANNOTATED_WITH_PROPERTY: EditorConfigProperty<Set<String>> =
             EditorConfigProperty(

diff --git a/...ard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/FunctionNamingRuleTest.kt b/...ard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/FunctionNamingRuleTest.kt
@@ -218,4 +218,22 @@ class FunctionNamingRuleTest {
             .withEditorConfigOverride(IGNORE_WHEN_ANNOTATED_WITH_PROPERTY to "Composable, Foo")
             .hasNoLintViolations()
     }
+
+    @Test
+    fun `Issue 2259 - Given a fun which is to be ignored because it is annotated with a blacklisted annotation using annotation array`() {
+        val code =
+            """
+            @[Bar Foo]
+            fun SomeFooBar()
+
+            @[Composable Foo]
+            fun SomeComposableFoo()
+
+            @[Bar Composable]
+            fun SomeComposableBar()
+            """.trimIndent()
+        functionNamingRuleAssertThat(code)
+            .withEditorConfigOverride(IGNORE_WHEN_ANNOTATED_WITH_PROPERTY to "Composable, Foo")
+            .hasNoLintViolations()
+    }
 }