Fix another issue with annotations incorrectly being forced to be mul…

…ti-line Similar to pinterest#1688, an array of annotations would be forced to be multi-line if any of the entries had a parameter.
shashachu · Jan 4, 2023 · e03fd6d · e03fd6d
1 parent 480dd87
commit e03fd6d
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,8 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Fixed
 
+* Issue with the `annotation` rule which would sometimes incorrectly force an array of annotations to be multi-line
+
 ### Changed
 
 ## [0.48.1] - 2023-01-03

diff --git a/...-ruleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/AnnotationRule.kt b/...-ruleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/AnnotationRule.kt
@@ -61,26 +61,27 @@ public class AnnotationRule : Rule("annotation") {
     ) {
         require(node.elementType == ANNOTATION_ENTRY)
 
-        if (node.isAnnotationEntryWithValueArgumentList() &&
-            node.treeParent.treeParent.elementType != VALUE_PARAMETER && // fun fn(@Ann("blah") a: String)
-            node.treeParent.treeParent.elementType != VALUE_ARGUMENT && // fn(@Ann("blah") "42")
-            !node.isPartOf(TYPE_ARGUMENT_LIST) && // val property: Map<@Ann("blah") String, Int>
-            node.isNotReceiverTargetAnnotation()
-        ) {
-            checkForAnnotationWithParameterToBePlacedOnSeparateLine(node, emit, autoCorrect)
-        }
+        if (node.treeParent.elementType != ANNOTATION) {
+            if (node.isAnnotationEntryWithValueArgumentList() &&
+                node.treeParent.treeParent.elementType != VALUE_PARAMETER && // fun fn(@Ann("blah") a: String)
+                node.treeParent.treeParent.elementType != VALUE_ARGUMENT && // fn(@Ann("blah") "42")
+                !node.isPartOf(TYPE_ARGUMENT_LIST) && // val property: Map<@Ann("blah") String, Int>
+                node.isNotReceiverTargetAnnotation()
+            ) {
+                checkForAnnotationWithParameterToBePlacedOnSeparateLine(node, emit, autoCorrect)
+            }
 
-        if ((node.isFollowedByOtherAnnotationEntry() && node.isOnSameLineAsNextAnnotationEntry()) ||
-            (node.isPrecededByOtherAnnotationEntry() && node.isOnSameLineAsAnnotatedConstruct())
-        ) {
-            checkForAnnotationToBePlacedOnSeparateLine(node, emit, autoCorrect)
-        }
+            if ((node.isFollowedByOtherAnnotationEntry() && node.isOnSameLineAsNextAnnotationEntry()) ||
+                (node.isPrecededByOtherAnnotationEntry() && node.isOnSameLineAsAnnotatedConstruct())
+            ) {
+                checkForAnnotationToBePlacedOnSeparateLine(node, emit, autoCorrect)
+            }
 
-        if (node.treeParent.elementType != ANNOTATION &&
-            node.isPrecededByOtherAnnotationEntry() &&
-            node.isOnSameLineAsAnnotatedConstruct()
-        ) {
-            checkForMultipleAnnotationsOnSameLineAsAnnotatedConstruct(node, emit, autoCorrect)
+            if (node.isPrecededByOtherAnnotationEntry() &&
+                node.isOnSameLineAsAnnotatedConstruct()
+            ) {
+                checkForMultipleAnnotationsOnSameLineAsAnnotatedConstruct(node, emit, autoCorrect)
+            }
         }
     }
 

diff --git a/...eset-standard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/AnnotationRuleTest.kt b/...eset-standard/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/AnnotationRuleTest.kt
@@ -548,4 +548,14 @@ class AnnotationRuleTest {
             """.trimIndent()
         annotationRuleAssertThat(code).hasNoLintViolations()
     }
+
+    @Test
+    fun `Given an annotation with multiple annotation entries including with parameters then do not force wrapping of the entries`() {
+        val code =
+            """
+            @[JvmStatic Provides Foo("bar")]
+            fun foo() = 42
+            """.trimIndent()
+        annotationRuleAssertThat(code).hasNoLintViolations()
+    }
 }