Skip correcting files with parser diagnostics

CHANGELOG.md

@@ -18,6 +18,11 @@
   performance in multithreaded operations.  
   [JP Simard](https://github.com/jpsim)
 
+* Skip correcting file if the swift parser reports a warning or an
+  error.  
+  [JP Simard](https://github.com/jpsim)
+  [#3343](https://github.com/realm/SwiftLint/issues/3343)
+
 #### Bug Fixes
 
 * None.

Source/SwiftLintFramework/Extensions/SwiftLintFile+Cache.swift

@@ -31,6 +31,9 @@ private var syntaxKindsByLinesCache = Cache({ file in file.syntaxKindsByLine() }
 private var syntaxTokensByLinesCache = Cache({ file in file.syntaxTokensByLine() })
 
 internal typealias AssertHandler = () -> Void
+// Re-enable once all parser diagnostics in tests have been addressed.
+// https://github.com/realm/SwiftLint/issues/3348
+internal var parserDiagnosticsDisabledForTests = false
 
 private var assertHandlers = [FileCacheKey: AssertHandler]()
 private var assertHandlerCache = Cache({ file in assertHandlers[file.cacheKey] })
@@ -125,6 +128,22 @@ extension SwiftLintFile {
         }
     }
 
+    internal var parserDiagnostics: [[String: SourceKitRepresentable]]? {
+        if parserDiagnosticsDisabledForTests {
+            return nil
+        }
+
+        guard let response = responseCache.get(self) else {
+            if let handler = assertHandler {
+                handler()
+                return nil
+            }
+            queuedFatalError("Never call this for file that sourcekitd fails.")
+        }
+
+        return response["key.diagnostics"] as? [[String: SourceKitRepresentable]]
+    }
+
     internal var structure: Structure {
         guard let structure = structureCache.get(self) else {
             if let handler = assertHandler {

Source/SwiftLintFramework/Models/Linter.swift

@@ -267,6 +267,14 @@ public struct CollectedLinter {
             return []
         }
 
+        if let parserDiagnostics = file.parserDiagnostics {
+            queuedPrintError(
+                "Skipping correcting file because it produced Swift parser diagnostics: \(file.path ?? "<nopath>")"
+            )
+            queuedPrintError(toJSON(["diagnostics": parserDiagnostics]))
+            return []
+        }
+
         var corrections = [Correction]()
         for rule in rules.compactMap({ $0 as? CorrectableRule }) {
             let newCorrections = rule.correct(file: file, using: storage, compilerArguments: compilerArguments)

Source/SwiftLintFramework/Models/MasterRuleList.swift

@@ -1,4 +1,4 @@
-// Generated using Sourcery 0.17.0 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 0.18.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 /// The rule list containing all available rules built into SwiftLint.

Source/SwiftLintFramework/Rules/Idiomatic/TrailingSemicolonRule.swift

@@ -11,20 +11,17 @@ public struct TrailingSemicolonRule: SubstitutionCorrectableRule, ConfigurationP
         name: "Trailing Semicolon",
         description: "Lines should not have trailing semicolons.",
         kind: .idiomatic,
-        nonTriggeringExamples: [ Example("let a = 0\n") ],
+        nonTriggeringExamples: [
+            Example("let a = 0\n"),
+            Example("let a = 0; let b = 0")
+        ],
         triggeringExamples: [
             Example("let a = 0↓;\n"),
-            Example("let a = 0↓;\nlet b = 1\n"),
-            Example("let a = 0↓;;\n"),
-            Example("let a = 0↓;    ;;\n"),
-            Example("let a = 0↓; ; ;\n")
+            Example("let a = 0↓;\nlet b = 1\n")
         ],
         corrections: [
             Example("let a = 0↓;\n"): Example("let a = 0\n"),
-            Example("let a = 0↓;\nlet b = 1\n"): Example("let a = 0\nlet b = 1\n"),
-            Example("let a = 0↓;;\n"): Example("let a = 0\n"),
-            Example("let a = 0↓;    ;;\n"): Example("let a = 0\n"),
-            Example("let a = 0↓; ; ;\n"): Example("let a = 0\n")
+            Example("let a = 0↓;\nlet b = 1\n"): Example("let a = 0\nlet b = 1\n")
         ]
     )
 

Source/SwiftLintFramework/Rules/Lint/AnyObjectProtocolRule.swift

@@ -29,8 +29,6 @@ public struct AnyObjectProtocolRule: SubstitutionCorrectableASTRule, OptInRule,
                 Example("protocol SomeClassOnlyProtocol: AnyObject {}\n"),
             Example("protocol SomeClassOnlyProtocol: ↓class, SomeInheritedProtocol {}\n"):
                 Example("protocol SomeClassOnlyProtocol: AnyObject, SomeInheritedProtocol {}\n"),
-            Example("protocol SomeClassOnlyProtocol: SomeInheritedProtocol, ↓class {}\n"):
-                Example("protocol SomeClassOnlyProtocol: SomeInheritedProtocol, AnyObject {}\n"),
             Example("@objc protocol SomeClassOnlyProtocol: ↓class, SomeInheritedProtocol {}\n"):
                 Example("@objc protocol SomeClassOnlyProtocol: AnyObject, SomeInheritedProtocol {}\n")
         ]

Source/SwiftLintFramework/Rules/Lint/UnusedClosureParameterRule.swift

@@ -75,12 +75,10 @@ public struct UnusedClosureParameterRule: SubstitutionCorrectableASTRule, Config
                 Example("[1, 2].map { _ in\n return numberWithSuffix\n}\n"),
             Example("[1, 2].map { ↓number in\n return 3 // number\n}\n"):
                 Example("[1, 2].map { _ in\n return 3 // number\n}\n"),
-            Example("[1, 2].map { ↓number in\n return 3 \"number\"\n}\n"):
-                Example("[1, 2].map { _ in\n return 3 \"number\"\n}\n"),
             Example("[1, 2].something { number, ↓idx in\n return number\n}\n"):
                 Example("[1, 2].something { number, _ in\n return number\n}\n"),
-            Example("genericsFunc(closure: { (↓int: Int) -> Void in // do something\n}\n"):
-                Example("genericsFunc(closure: { (_: Int) -> Void in // do something\n}\n"),
+            Example("genericsFunc(closure: { (↓int: Int) -> Void in // do something\n})\n"):
+                Example("genericsFunc(closure: { (_: Int) -> Void in // do something\n})\n"),
             Example("genericsFunc { (↓a, ↓b: Type) -> Void in\n}\n"):
                 Example("genericsFunc { (_, _: Type) -> Void in\n}\n"),
             Example("genericsFunc { (↓a: Type, ↓b: Type) -> Void in\n}\n"):
@@ -91,8 +89,20 @@ public struct UnusedClosureParameterRule: SubstitutionCorrectableASTRule, Config
                 Example("genericsFunc { (a: Type, _) -> Void in\nreturn a\n}\n"),
             Example("hoge(arg: num) { ↓num in\n}\n"):
                 Example("hoge(arg: num) { _ in\n}\n"),
-            Example("func foo () {\n bar { ↓number in\n return 3\n}\n"):
-                Example("func foo () {\n bar { _ in\n return 3\n}\n"),
+            Example("""
+            func foo () {
+              bar { ↓number in
+                return 3
+              }
+            }
+            """):
+                Example("""
+                func foo () {
+                  bar { _ in
+                    return 3
+                  }
+                }
+                """),
             Example("class C {\n #if true\n func f() {\n [1, 2].map { ↓number in\n return 3\n }\n }\n #endif\n}"):
                 Example("class C {\n #if true\n func f() {\n [1, 2].map { _ in\n return 3\n }\n }\n #endif\n}")
         ]

Source/SwiftLintFramework/Rules/Lint/YodaConditionRule.swift

@@ -44,9 +44,9 @@ public struct YodaConditionRule: ASTRule, OptInRule, ConfigurationProviderRule,
             Example("guard foo != \"str str\" else { return }"),
             Example("while foo < 10 { }\n"),
             Example("while foo > 1 { }\n"),
-            Example("while foo + 1 == 2"),
-            Example("if optionalValue?.property ?? 0 == 2"),
-            Example("if foo == nil")
+            Example("while foo + 1 == 2 {}"),
+            Example("if optionalValue?.property ?? 0 == 2 {}"),
+            Example("if foo == nil {}")
         ],
         triggeringExamples: [
             Example("↓if 42 == foo {}\n"),
@@ -55,7 +55,7 @@ public struct YodaConditionRule: ASTRule, OptInRule, ConfigurationProviderRule,
             Example("↓guard \"str str\" != foo else { return }"),
             Example("↓while 10 > foo { }"),
             Example("↓while 1 < foo { }"),
-            Example("↓if nil == foo")
+            Example("↓if nil == foo {}")
         ])
 
     public func validate(file: SwiftLintFile,

Source/SwiftLintFramework/Rules/Metrics/ClosureBodyLengthRuleExamples.swift

@@ -41,7 +41,7 @@ private func trailingClosure(_ violationSymbol: String = "",
                              line: UInt = #line) -> Example {
     return Example("""
         foo.bar \(violationSymbol){ toto in
-        \(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
+        \((0..<codeLinesCount).map { "\tlet a\($0) = 0\n" }.joined())\
         \(repeatElement("\t// toto\n", count: commentLinesCount).joined())\
         \(repeatElement("\t\n", count: emptyLinesCount).joined())\
         }
@@ -54,7 +54,7 @@ private func argumentClosure(_ violationSymbol: String = "",
                              line: UInt = #line) -> Example {
     return Example("""
         foo.bar(\(violationSymbol){ toto in
-        \(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
+        \((0..<codeLinesCount).map { "\tlet a\($0) = 0\n" }.joined())\
         })
         """, file: file, line: line)
 }
@@ -65,7 +65,7 @@ private func labeledArgumentClosure(_ violationSymbol: String = "",
                                     line: UInt = #line) -> Example {
     return Example("""
         foo.bar(label: \(violationSymbol){ toto in
-        \(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
+        \((0..<codeLinesCount).map { "\tlet a\($0) = 0\n" }.joined())\
         })
         """, file: file, line: line)
 }
@@ -76,9 +76,9 @@ private func multiLabeledArgumentClosures(_ violationSymbol: String = "",
                                           line: UInt = #line) -> Example {
     return Example("""
         foo.bar(label: \(violationSymbol){ toto in
-        \(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
+        \((0..<codeLinesCount).map { "\tlet a\($0) = 0\n" }.joined())\
         }, anotherLabel: \(violationSymbol){ toto in
-        \(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
+        \((0..<codeLinesCount).map { "\tlet a\($0) = 0\n" }.joined())\
         })
         """, file: file, line: line)
 }
@@ -89,9 +89,9 @@ private func labeledAndTrailingClosures(_ violationSymbol: String = "",
                                         line: UInt = #line) -> Example {
     return Example("""
         foo.bar(label: \(violationSymbol){ toto in
-        \(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
+        \((0..<codeLinesCount).map { "\tlet a\($0) = 0\n" }.joined())\
         }) \(violationSymbol){ toto in
-        \(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
+        \((0..<codeLinesCount).map { "\tlet a\($0) = 0\n" }.joined())\
         }
         """, file: file, line: line)
 }
@@ -103,7 +103,7 @@ private func lazyInitialization(_ violationSymbol: String = "",
     return Example("""
         let foo: Bar = \(violationSymbol){ toto in
         \tlet bar = Bar()
-        \(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
+        \((0..<codeLinesCount).map { "\tlet a\($0) = 0\n" }.joined())\
         \treturn bar
         }()
         """, file: file, line: line)

Source/SwiftLintFramework/Rules/Style/AttributesRuleExamples.swift

@@ -13,17 +13,17 @@ internal struct AttributesRuleExamples {
         Example("@IBAction func buttonPressed(button: UIButton)"),
         Example("@objc\n @IBAction func buttonPressed(button: UIButton)"),
         Example("@available(iOS 9.0, *)\n func animate(view: UIStackView)"),
-        Example("@available(iOS 9.0, *, message=\"A message\")\n func animate(view: UIStackView)"),
-        Example("@nonobjc\n final class X"),
-        Example("@available(iOS 9.0, *)\n class UIStackView"),
-        Example("@NSApplicationMain\n class AppDelegate: NSObject, NSApplicationDelegate"),
-        Example("@UIApplicationMain\n class AppDelegate: NSObject, UIApplicationDelegate"),
-        Example("@IBDesignable\n class MyCustomView: UIView"),
+        Example("@available(*, deprecated, message: \"A message\")\n func animate(view: UIStackView)"),
+        Example("@nonobjc\n final class X {}"),
+        Example("@available(iOS 9.0, *)\n class UIStackView {}"),
+        Example("@NSApplicationMain\n class AppDelegate: NSObject, NSApplicationDelegate {}"),
+        Example("@UIApplicationMain\n class AppDelegate: NSObject, UIApplicationDelegate {}"),
+        Example("@IBDesignable\n class MyCustomView: UIView {}"),
         Example("@testable import SourceKittenFramework"),
         Example("@objc(foo_x)\n var x: String"),
         Example("@available(iOS 9.0, *)\n@objc(abc_stackView)\n let stackView: UIStackView"),
         Example("@objc(abc_addSomeObject:)\n @NSManaged func addSomeObject(book: SomeObject)"),
-        Example("@objc(ABCThing)\n @available(iOS 9.0, *)\n class Thing"),
+        Example("@objc(ABCThing)\n @available(iOS 9.0, *)\n class Thing {}"),
         Example("class Foo: NSObject {\n override var description: String { return \"\" }\n}"),
         Example("class Foo: NSObject {\n\n override func setUp() {}\n}"),
         Example("@objc\nclass ⽺ {}\n"),
@@ -76,20 +76,20 @@ internal struct AttributesRuleExamples {
         Example("@IBAction\n ↓func buttonPressed(button: UIButton)"),
         Example("@IBAction\n @objc\n ↓func buttonPressed(button: UIButton)"),
         Example("@available(iOS 9.0, *) ↓func animate(view: UIStackView)"),
-        Example("@nonobjc final ↓class X"),
-        Example("@available(iOS 9.0, *) ↓class UIStackView"),
-        Example("@available(iOS 9.0, *)\n @objc ↓class UIStackView"),
-        Example("@available(iOS 9.0, *) @objc\n ↓class UIStackView"),
-        Example("@available(iOS 9.0, *)\n\n ↓class UIStackView"),
-        Example("@UIApplicationMain ↓class AppDelegate: NSObject, UIApplicationDelegate"),
-        Example("@IBDesignable ↓class MyCustomView: UIView"),
+        Example("@nonobjc final ↓class X {}"),
+        Example("@available(iOS 9.0, *) ↓class UIStackView {}"),
+        Example("@available(iOS 9.0, *)\n @objc ↓class UIStackView {}"),
+        Example("@available(iOS 9.0, *) @objc\n ↓class UIStackView {}"),
+        Example("@available(iOS 9.0, *)\n\n ↓class UIStackView {}"),
+        Example("@UIApplicationMain ↓class AppDelegate: NSObject, UIApplicationDelegate {}"),
+        Example("@IBDesignable ↓class MyCustomView: UIView {}"),
         Example("@testable\n↓import SourceKittenFramework"),
         Example("@testable\n\n\n↓import SourceKittenFramework"),
         Example("@objc(foo_x) ↓var x: String"),
         Example("@available(iOS 9.0, *) @objc(abc_stackView)\n ↓let stackView: UIStackView"),
         Example("@objc(abc_addSomeObject:) @NSManaged\n ↓func addSomeObject(book: SomeObject)"),
         Example("@objc(abc_addSomeObject:)\n @NSManaged\n ↓func addSomeObject(book: SomeObject)"),
-        Example("@available(iOS 9.0, *)\n @objc(ABCThing) ↓class Thing"),
+        Example("@available(iOS 9.0, *)\n @objc(ABCThing) ↓class Thing {}"),
         Example("@GKInspectable\n ↓var maxSpeed: Float"),
         Example("@discardableResult ↓func a() -> Int"),
         Example("@objc\n @discardableResult ↓func a() -> Int"),

Source/SwiftLintFramework/Rules/Style/ComputedAccessorsOrderRuleExamples.swift

@@ -58,6 +58,7 @@ struct ComputedAccessorsOrderRuleExamples {
             Example("""
             protocol Foo {
                 var foo: Int { get set }
+            }
             """),
             Example("""
             protocol Foo {

Source/SwiftLintFramework/Rules/Style/ImplicitGetterRuleExamples.swift

@@ -58,6 +58,7 @@ struct ImplicitGetterRuleExamples {
             Example("""
             protocol Foo {
                 var foo: Int { get set }
+            }
             """),
             Example("""
             class Foo {

Source/SwiftLintFramework/Rules/Style/VerticalWhitespaceClosingBracesRule.swift

@@ -13,8 +13,8 @@ public struct VerticalWhitespaceClosingBracesRule: ConfigurationProviderRule {
     public init() {}
 
     private static let nonTriggeringExamples: [Example] = [
-        Example("[1, 2].map { $0 }.filter {"),
-        Example("[1, 2].map { $0 }.filter { num in"),
+        Example("[1, 2].map { $0 }.filter { true }"),
+        Example("[1, 2].map { $0 }.filter { num in true }"),
         Example("""
         /*
             class X {
@@ -27,14 +27,81 @@ public struct VerticalWhitespaceClosingBracesRule: ConfigurationProviderRule {
     ]
 
     private static let violatingToValidExamples: [Example: Example] = [
-        Example("    print(\"x is 5\")\n↓\n}"): Example("    print(\"x is 5\")\n}"),
-        Example("    print(\"x is 5\")\n↓\n\n}"): Example("    print(\"x is 5\")\n}"),
-        Example("    print(\"x is 5\")\n↓    \n}"): Example("    print(\"x is 5\")\n}"),
-        Example("        )\n}\n↓\n    }\n}"): Example("        )\n}\n    }\n}"),
-        Example("[\n1,\n2,\n3\n↓\n]"): Example("[\n1,\n2,\n3\n]"),
-        Example("foo(\nx: 5,\ny:6\n↓\n)"): Example("foo(\nx: 5,\ny:6\n)"),
-        Example("class Name {\n    run(5) { x in print(x) }\n↓\n}"):
-            Example("class Name {\n    run(5) { x in print(x) }\n}")
+        Example("""
+        do {
+          print("x is 5")
+        ↓
+        }
+        """):
+            Example("""
+            do {
+              print("x is 5")
+            }
+            """),
+        Example("""
+        do {
+          print("x is 5")
+        ↓
+
+        }
+        """):
+            Example("""
+            do {
+              print("x is 5")
+            }
+            """),
+        Example("""
+        do {
+          print("x is 5")
+        ↓\n  \n}
+        """):
+            Example("""
+            do {
+              print("x is 5")
+            }
+            """),
+        Example("""
+        [
+        1,
+        2,
+        3
+        ↓
+        ]
+        """):
+            Example("""
+            [
+            1,
+            2,
+            3
+            ]
+            """),
+        Example("""
+        foo(
+            x: 5,
+            y:6
+        ↓
+        )
+        """):
+            Example("""
+            foo(
+                x: 5,
+                y:6
+            )
+            """),
+        Example("""
+        func foo() {
+          run(5) { x in
+            print(x)
+          }
+        ↓
+        }
+        """): Example("""
+            func foo() {
+              run(5) { x in
+                print(x)
+              }
+            }
+            """)
     ]
 
     private let pattern = "((?:\\n[ \\t]*)+)(\\n[ \\t]*[)}\\]])"