Keep trailing trivia in explicit_init rule correction (#5296)

realm · Oct 23, 2023 · cb3001b · cb3001b
1 parent 4c0f337
commit cb3001b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,10 @@
 
 #### Bug Fixes
 
+* Fix correction of `explicit_init` rule by keeping significant trivia.  
+  [BB9z](https://github.com/BB9z)
+  [#5289](https://github.com/realm/SwiftLint/issues/5289)
+
 * Fix invalid corrections for opaque and existential optionals in 
   `syntactic_sugar` rule.  
   [SimplyDanny](https://github.com/SimplyDanny)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ExplicitInitRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ExplicitInitRule.swift
@@ -162,6 +162,18 @@ struct ExplicitInitRule: OptInRule {
 
 
 
+                """),
+            Example("""
+            f { e in
+                // comment
+                A↓.init(e: e)
+            }
+            """):
+                Example("""
+                f { e in
+                    // comment
+                    A(e: e)
+                }
                 """),
             Example("_ = GleanMetrics.Tabs.GroupedTabExtra↓.init()"):
                 Example("_ = GleanMetrics.Tabs.GroupedTabExtra()"),
@@ -197,7 +209,7 @@ private extension ExplicitInitRule {
                 return super.visit(node)
             }
             correctionPositions.append(violationPosition)
-            let newNode = node.with(\.calledExpression, calledBase.trimmed)
+            let newNode = node.with(\.calledExpression, calledBase)
             return super.visit(newNode)
         }
     }

diff --git a/Tests/SwiftLintFrameworkTests/ExplicitInitRuleTests.swift b/Tests/SwiftLintFrameworkTests/ExplicitInitRuleTests.swift
@@ -16,7 +16,6 @@ class ExplicitInitRuleTests: SwiftLintTestCase {
         let description = ExplicitInitRule.description
             .with(nonTriggeringExamples: nonTriggeringExamples)
             .with(triggeringExamples: triggeringExamples)
-            .with(corrections: [:])
 
         verifyRule(description, ruleConfiguration: ["include_bare_init": true])
     }