Fix for realm#4788 - when disabled, superfluous_disable_command sho…

…uld not fire, even for invalid rule identifiers
mildm8nnered · Mar 4, 2023 · e8c7630 · e8c7630
1 parent 4f9a608
commit e8c7630
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -162,6 +162,11 @@
   with keypath arguments.  
   [JP Simard](https://github.com/jpsim)
 
+* Fix for `superfluous_disable_command` not being completely disabled
+  by `disable` commands.  
+  [Martin Redington](https://github.com/mildm8nnered)
+  [#4788](https://github.com/realm/SwiftLint/issues/4788)
+
 ## 0.50.3: Bundle of Towels
 
 #### Breaking

diff --git a/Source/SwiftLintFramework/Models/Linter.swift b/Source/SwiftLintFramework/Models/Linter.swift
@@ -332,9 +332,14 @@ public struct CollectedLinter {
             .configuration.customRuleConfigurations.map { RuleIdentifier($0.identifier) } ?? []
         let allRuleIdentifiers = primaryRuleList.allValidIdentifiers().map { RuleIdentifier($0) }
         let allValidIdentifiers = Set(allCustomIdentifiers + allRuleIdentifiers + [.all])
+        let superfluousRuleIdentifier = RuleIdentifier(SuperfluousDisableCommandRule.description.identifier)
 
         return regions.flatMap { region in
-            region.disabledRuleIdentifiers.filter({ !allValidIdentifiers.contains($0) }).map { id in
+            region.disabledRuleIdentifiers.filter({
+                !allValidIdentifiers.contains($0) &&
+                !region.disabledRuleIdentifiers.contains(.all) &&
+                !region.disabledRuleIdentifiers.contains(superfluousRuleIdentifier)
+            }).map { id in
                 return StyleViolation(
                     ruleDescription: type(of: superfluousDisableCommandRule).description,
                     severity: superfluousDisableCommandRule.configuration.severity,

diff --git a/Source/SwiftLintFramework/Rules/Lint/SuperfluousDisableCommandRule.swift b/Source/SwiftLintFramework/Rules/Lint/SuperfluousDisableCommandRule.swift
@@ -11,7 +11,17 @@ public struct SuperfluousDisableCommandRule: ConfigurationProviderRule, SourceKi
             SwiftLint 'disable' commands are superfluous when the disabled rule would not have triggered a violation \
             in the disabled region. Use " - " if you wish to document a command.
             """,
-        kind: .lint
+        kind: .lint,
+        nonTriggeringExamples: [
+            Example("""
+            // swiftlint:disable all
+            // swiftlint:disable non_existent_rule_name
+            """),
+            Example("""
+            // swiftlint:disable superfluous_disable_command
+            // swiftlint:disable non_existent_rule_name
+            """)
+        ]
     )
 
     public func validate(file: SwiftLintFile) -> [StyleViolation] {