Fix false positive in multiline_parameters rule

when parameter is a closure has default value. Fixes #1912.
realm · Oct 18, 2017 · 3ba3fd0 · 3ba3fd0
1 parent 234f987
commit 3ba3fd0
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,7 +26,10 @@
 
 ##### Bug Fixes
 
-* None.
+* Fix false positive in `multiline_parameters` rule when parameter is a closure
+  with default value.  
+  [Ornithologist Coder](https://github.com/ornithocoder)
+  [#1912](https://github.com/realm/SwiftLint/issues/1912)
 
 ## 0.23.1: Rewash: Forgotten Load Edition
 

diff --git a/Rules.md b/Rules.md
@@ -7014,6 +7014,38 @@ class Foo {
 }
 ```
 
+```swift
+class Foo {
+   class func foo(param1: Int,
+                  param2: Bool,
+                  param3: @escaping (Int, Int) -> Void = { _, _ in }) { }
+}
+```
+
+```swift
+class Foo {
+   class func foo(param1: Int,
+                  param2: Bool,
+                  param3: @escaping (Int) -> Void = { _ in }) { }
+}
+```
+
+```swift
+class Foo {
+   class func foo(param1: Int,
+                  param2: Bool,
+                  param3: @escaping ((Int) -> Void)? = nil) { }
+}
+```
+
+```swift
+class Foo {
+   class func foo(param1: Int,
+                  param2: Bool,
+                  param3: @escaping ((Int) -> Void)? = { _ in }) { }
+}
+```
+
 </details>
 <details>
 <summary>Triggering Examples</summary>

diff --git a/Source/SwiftLintFramework/Rules/MultilineParametersRule.swift b/Source/SwiftLintFramework/Rules/MultilineParametersRule.swift
@@ -40,6 +40,7 @@ public struct MultilineParametersRule: ASTRule, OptInRule, ConfigurationProvider
         for structure in dictionary.substructure {
             guard
                 let structureOffset = structure.offset,
+                structure.typeName != nil,
                 let structureKind = structure.kind, SwiftDeclarationKind(rawValue: structureKind) == .varParameter,
                 let (line, _) = file.contents.bridge().lineAndCharacter(forByteOffset: structureOffset),
                 offset..<(offset + length) ~= structureOffset

diff --git a/Source/SwiftLintFramework/Rules/MultilineParametersRuleExamples.swift b/Source/SwiftLintFramework/Rules/MultilineParametersRuleExamples.swift
@@ -92,6 +92,26 @@ internal struct MultilineParametersRuleExamples {
         "   class func foo(param1: Int,\n" +
         "                  param2: Bool,\n" +
         "                  param3: [String]) { }\n" +
+        "}",
+        "class Foo {\n" +
+        "   class func foo(param1: Int,\n" +
+        "                  param2: Bool,\n" +
+        "                  param3: @escaping (Int, Int) -> Void = { _, _ in }) { }\n" +
+        "}",
+        "class Foo {\n" +
+        "   class func foo(param1: Int,\n" +
+        "                  param2: Bool,\n" +
+        "                  param3: @escaping (Int) -> Void = { _ in }) { }\n" +
+        "}",
+        "class Foo {\n" +
+        "   class func foo(param1: Int,\n" +
+        "                  param2: Bool,\n" +
+        "                  param3: @escaping ((Int) -> Void)? = nil) { }\n" +
+        "}",
+        "class Foo {\n" +
+        "   class func foo(param1: Int,\n" +
+        "                  param2: Bool,\n" +
+        "                  param3: @escaping ((Int) -> Void)? = { _ in }) { }\n" +
         "}"
     ]