Merge pull request #2716 from fredpi/feature/#2670-fix-superfluous-di…

…sable Fix "superfluous_disable_command" / "disable all" interference
realm · Apr 12, 2019 · c80ffd3 · c80ffd3
2 parents bc8f9d6 + 43e1845
commit c80ffd3
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -80,6 +80,10 @@
   declaring extensions that add protocol conformances with Swift 5.  
   [Marcelo Fabri](https://github.com/marcelofabri)
   [#2705](https://github.com/realm/SwiftLint/issues/2705)
+
+* Let `disable all` command override `superfluous_disable_command` rule.  
+  [Frederick Pietschmann](https://github.com/fredpi)
+  [#2670](https://github.com/realm/SwiftLint/issues/2670)
 
 ## 0.31.0: Busy Laundromat
 

diff --git a/Source/SwiftLintFramework/Models/Linter.swift b/Source/SwiftLintFramework/Models/Linter.swift
@@ -18,13 +18,16 @@ private extension Rule {
         let regionsDisablingCurrentRule = regions.filter { region in
             return region.isRuleDisabled(self.init())
         }
-        let regionsDisablingSuperflousDisableRule = regions.filter { region in
+        let regionsDisablingSuperfluousDisableRule = regions.filter { region in
             return region.isRuleDisabled(superfluousDisableCommandRule)
         }
 
         return regionsDisablingCurrentRule.compactMap { region -> StyleViolation? in
-            let isSuperflousRuleDisabled = regionsDisablingSuperflousDisableRule.contains { $0.contains(region.start) }
-            guard !isSuperflousRuleDisabled else {
+            let isSuperfluousRuleDisabled = regionsDisablingSuperfluousDisableRule.contains {
+                $0.contains(region.start)
+            }
+
+            guard !isSuperfluousRuleDisabled else {
                 return nil
             }
 
@@ -74,7 +77,8 @@ private extension Rule {
         }
 
         let ruleIDs = Self.description.allIdentifiers +
-            (superfluousDisableCommandRule.map({ type(of: $0) })?.description.allIdentifiers ?? [])
+            (superfluousDisableCommandRule.map({ type(of: $0) })?.description.allIdentifiers ?? []) +
+            [RuleIdentifier.all.stringRepresentation]
         let ruleIdentifiers = Set(ruleIDs.map { RuleIdentifier($0) })
 
         let superfluousDisableCommandViolations = Self.superfluousDisableCommandViolations(

diff --git a/Source/SwiftLintFramework/Models/MasterRuleList.swift b/Source/SwiftLintFramework/Models/MasterRuleList.swift
@@ -1,4 +1,4 @@
-// Generated using Sourcery 0.15.0 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 0.16.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 public let masterRuleList = RuleList(rules: [

diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
@@ -1,4 +1,4 @@
-// Generated using Sourcery 0.15.0 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 0.16.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 @testable import SwiftLintFrameworkTests
@@ -109,6 +109,7 @@ extension CommandTests {
         ("testExpandThisCommand", testExpandThisCommand),
         ("testExpandNextCommand", testExpandNextCommand),
         ("testSuperfluousDisableCommands", testSuperfluousDisableCommands),
+        ("testDisableAllOverridesSuperfluousDisableCommand", testDisableAllOverridesSuperfluousDisableCommand),
         ("testInvalidDisableCommands", testInvalidDisableCommands),
         ("testSuperfluousDisableCommandsDisabled", testSuperfluousDisableCommandsDisabled),
         ("testSuperfluousDisableCommandsDisabledOnConfiguration", testSuperfluousDisableCommandsDisabledOnConfiguration)
@@ -184,7 +185,9 @@ extension ConfigurationTests {
 
 extension ContainsOverFirstNotNilRuleTests {
     static var allTests: [(String, (ContainsOverFirstNotNilRuleTests) -> () throws -> Void)] = [
-        ("testWithDefaultConfiguration", testWithDefaultConfiguration)
+        ("testWithDefaultConfiguration", testWithDefaultConfiguration),
+        ("testFirstReason", testFirstReason),
+        ("testFirstIndexReason", testFirstIndexReason)
     ]
 }
 

diff --git a/Tests/SwiftLintFrameworkTests/AutomaticRuleTests.generated.swift b/Tests/SwiftLintFrameworkTests/AutomaticRuleTests.generated.swift
@@ -1,4 +1,4 @@
-// Generated using Sourcery 0.15.0 — https://github.com/krzysztofzablocki/Sourcery
+// Generated using Sourcery 0.16.0 — https://github.com/krzysztofzablocki/Sourcery
 // DO NOT EDIT
 
 import SwiftLintFramework

diff --git a/Tests/SwiftLintFrameworkTests/CommandTests.swift b/Tests/SwiftLintFrameworkTests/CommandTests.swift
@@ -3,6 +3,8 @@ import SourceKittenFramework
 @testable import SwiftLintFramework
 import XCTest
 
+// swiftlint:disable type_body_length
+
 private extension Command {
     init?(string: String) {
         let nsString = string.bridge()
@@ -223,6 +225,29 @@ class CommandTests: XCTestCase {
         )
     }
 
+    func testDisableAllOverridesSuperfluousDisableCommand() {
+        XCTAssert(
+            violations(
+                "//swiftlint:disable all\n// swiftlint:disable nesting\nprint(123)\n"
+            ).isEmpty
+        )
+        XCTAssert(
+            violations(
+                "//swiftlint:disable all\n// swiftlint:disable:next nesting\nprint(123)\n"
+            ).isEmpty
+        )
+        XCTAssert(
+            violations(
+                "//swiftlint:disable all\n// swiftlint:disable:this nesting\nprint(123)\n"
+            ).isEmpty
+        )
+        XCTAssert(
+            violations(
+                "//swiftlint:disable all\n// swiftlint:disable:previous nesting\nprint(123)\n"
+            ).isEmpty
+        )
+    }
+
     func testInvalidDisableCommands() {
         XCTAssertEqual(
             violations("// swiftlint:disable nesting_foo\nprint(123)\n")[0].ruleDescription.identifier,