realm#2422 - Replace ruleDescription change with a StyleViolation rea…

…son field in CompilerProtocolInitRule
sjavora · Mar 9, 2019 · 042bfba · 042bfba
1 parent f6ba18a
commit 042bfba
Showing 1 changed file with 24 additions and 20 deletions.
diff --git a/Source/SwiftLintFramework/Rules/Lint/CompilerProtocolInitRule.swift b/Source/SwiftLintFramework/Rules/Lint/CompilerProtocolInitRule.swift
@@ -6,34 +6,38 @@ public struct CompilerProtocolInitRule: ASTRule, ConfigurationProviderRule {
 
     public init() {}
 
-    public static let description = specificDescription(for: "such as `ExpressibleByArrayLiteral`", isPlural: true)
-
-    private static func specificDescription(for violation: String, isPlural: Bool) -> RuleDescription {
-        return RuleDescription(
-            identifier: "compiler_protocol_init",
-            name: "Compiler Protocol Init",
-            description: "The initializers declared in compiler protocol\(isPlural ? "s" : "") \(violation) " +
-                         "shouldn't be called directly.",
-            kind: .lint,
-            nonTriggeringExamples: [
-                "let set: Set<Int> = [1, 2]\n",
-                "let set = Set(array)\n"
-            ],
-            triggeringExamples: [
-                "let set = ↓Set(arrayLiteral: 1, 2)\n",
-                "let set = ↓Set.init(arrayLiteral: 1, 2)\n"
-            ]
-        )
+    public static let description = RuleDescription(
+        identifier: "compiler_protocol_init",
+        name: "Compiler Protocol Init",
+        description: CompilerProtocolInitRule.violationReason(
+            protocolName: "such as `ExpressibleByArrayLiteral`",
+            isPlural: true
+        ),
+        kind: .lint,
+        nonTriggeringExamples: [
+            "let set: Set<Int> = [1, 2]\n",
+            "let set = Set(array)\n"
+        ],
+        triggeringExamples: [
+            "let set = ↓Set(arrayLiteral: 1, 2)\n",
+            "let set = ↓Set.init(arrayLiteral: 1, 2)\n"
+        ]
+    )
+
+    private static func violationReason(protocolName: String, isPlural: Bool) -> String {
+        return "The initializers declared in compiler protocol\(isPlural ? "s" : "") \(protocolName) " +
+                "shouldn't be called directly."
     }
 
     public func validate(file: File, kind: SwiftExpressionKind,
                          dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] {
         return violationRanges(in: file, kind: kind, dictionary: dictionary).map {
             let (violation, range) = $0
             return StyleViolation(
-                ruleDescription: type(of: self).specificDescription(for: violation.protocolName, isPlural: false),
+                ruleDescription: type(of: self).description,
                 severity: configuration.severity,
-                location: Location(file: file, characterOffset: range.location)
+                location: Location(file: file, characterOffset: range.location),
+                reason: type(of: self).violationReason(protocolName: violation.protocolName, isPlural: false)
             )
         }
     }