Add validation hook to configuration parsing

realm · Oct 13, 2024 · 72f1ed5 · 72f1ed5
1 parent 9ebd6ae
commit 72f1ed5
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/Source/SwiftLintCore/Models/Issue.swift b/Source/SwiftLintCore/Models/Issue.swift
@@ -20,6 +20,10 @@ public enum Issue: LocalizedError, Equatable {
     /// Some configuration keys are invalid.
     case invalidConfigurationKeys(ruleID: String, keys: Set<String>)
 
+    /// The configuration is inconsistent, that is options are mutually exclusive or one drives other values
+    /// irrelevant.
+    case inconsistentConfiguration(ruleID: String, message: String)
+
     /// Used rule IDs are invalid.
     case invalidRuleIDs(Set<String>)
 
@@ -154,6 +158,8 @@ public enum Issue: LocalizedError, Equatable {
             return "'\(old)' has been renamed to '\(new)' and will be completely removed in a future release."
         case let .invalidConfigurationKeys(id, keys):
             return "Configuration for '\(id)' rule contains the invalid key(s) \(keys.formatted)."
+        case let .inconsistentConfiguration(id, message):
+            return "Inconsistent configuration for '\(id)' rule: \(message)"
         case let .invalidRuleIDs(ruleIDs):
             return "The key(s) \(ruleIDs.formatted) used as rule identifier(s) is/are invalid."
         case let .ruleNotPresentInOnlyRules(id):

diff --git a/Source/SwiftLintCore/Protocols/RuleConfiguration.swift b/Source/SwiftLintCore/Protocols/RuleConfiguration.swift
@@ -13,6 +13,10 @@ public protocol RuleConfiguration: Equatable {
     ///
     /// - throws: Throws if the configuration is not in the expected format.
     mutating func apply(configuration: Any) throws
+
+    /// Run a sanity check on the configuration, perform optional postprocessing steps and/or warn about potential
+    /// issues.
+    mutating func validate() throws
 }
 
 /// A configuration for a rule that allows to configure at least the severity.
@@ -30,6 +34,10 @@ public extension SeverityBasedRuleConfiguration {
 
 public extension RuleConfiguration {
     var parameterDescription: RuleConfigurationDescription? { nil }
+
+    func validate() throws {
+        // Do nothing by default.
+    }
 }
 
 public extension RuleConfiguration {

diff --git a/Source/SwiftLintCoreMacros/RuleConfigurationMacros.swift b/Source/SwiftLintCoreMacros/RuleConfigurationMacros.swift
@@ -85,6 +85,9 @@ enum AutoConfigParser: MemberMacro {
                     Issue.invalidConfigurationKeys(ruleID: Parent.identifier, keys: unknownKeys).print()
                 }
                 """
+                """
+                try validate()
+                """
             }),
         ]
     }

diff --git a/Tests/MacroTests/AutoConfigParserTests.swift b/Tests/MacroTests/AutoConfigParserTests.swift
@@ -44,6 +44,7 @@ final class AutoConfigParserTests: XCTestCase {
                         let unknownKeys = Set(configuration.keys).subtracting(supportedKeys)
                         Issue.invalidConfigurationKeys(ruleID: Parent.identifier, keys: unknownKeys).print()
                     }
+                    try validate()
                 }
             }
             """,
@@ -90,6 +91,7 @@ final class AutoConfigParserTests: XCTestCase {
                         let unknownKeys = Set(configuration.keys).subtracting(supportedKeys)
                         Issue.invalidConfigurationKeys(ruleID: Parent.identifier, keys: unknownKeys).print()
                     }
+                    try validate()
                 }
             }
             """,
@@ -145,6 +147,7 @@ final class AutoConfigParserTests: XCTestCase {
                         let unknownKeys = Set(configuration.keys).subtracting(supportedKeys)
                         Issue.invalidConfigurationKeys(ruleID: Parent.identifier, keys: unknownKeys).print()
                     }
+                    try validate()
                 }
             }
             """,
@@ -171,6 +174,7 @@ final class AutoConfigParserTests: XCTestCase {
                         let unknownKeys = Set(configuration.keys).subtracting(supportedKeys)
                         Issue.invalidConfigurationKeys(ruleID: Parent.identifier, keys: unknownKeys).print()
                     }
+                    try validate()
                 }
             }
             """,
@@ -228,6 +232,7 @@ final class AutoConfigParserTests: XCTestCase {
                         let unknownKeys = Set(configuration.keys).subtracting(supportedKeys)
                         Issue.invalidConfigurationKeys(ruleID: Parent.identifier, keys: unknownKeys).print()
                     }
+                    try validate()
                 }
             }
             """,