Describe the rules

Sources/StringCatalogValidator/Model/ExtractionState.swift

@@ -1,4 +1,4 @@
-public enum ExtractionState: String {
+public enum ExtractionState: String, CaseIterable {
     case automatic
     case manual
     case extracted_with_value

Sources/StringCatalogValidator/Model/LocalizationState.swift

@@ -0,0 +1,5 @@
+enum LocalizationState: String, CaseIterable {
+    case translated
+    case needs_review
+    case stale
+}

Sources/StringCatalogValidator/Rule.swift

@@ -6,6 +6,7 @@ public protocol Rule {
     typealias Failure = Validator.Reason
 
     static var name: String { get }
+    static var description: String { get }
 
     var severity: Severity { get set }
     func validate(key: String, value: Entry) -> [Failure]

Sources/StringCatalogValidator/Rules/RequireExtractionState.swift

@@ -5,7 +5,9 @@ extension Rules {
     public struct RequireExtractionState: Rule {
         let states: [String]
         public var severity: Severity = .error
+
         public static let name = "require-extraction-state"
+        public static let description: String = "Requires that each key's extraction state matches one of the provided values. Known extractions states:  \(ExtractionState.allCases.map({"`\($0)`"}).joined(separator: ", "))"
 
         public init(in states: [String]) {
             self.states = states
@@ -38,6 +40,7 @@ extension Rules {
         let states: [String]
         public var severity: Severity = .error
         public static let name = "reject-extraction-state"
+        public static let description: String = "Rejects an entry if it's extraction state matchs any of the provided values. Known extractions states:  \(ExtractionState.allCases.map({"`\($0)`"}).joined(separator: ", "))"
 
         public init(state: String?) {
             self.states = [state ?? Self.defaultExtractionState]

Sources/StringCatalogValidator/Rules/RequireLocales.swift

@@ -3,6 +3,7 @@ extension Rules {
         let locales: [String]
         public var severity: Severity = .error
         public static let name = "require-locale"
+        public static let description: String = "Requires that each key contains localizations for the provided locale values." 
 
         public init(in locales: [String]) {
             self.locales = locales

Sources/StringCatalogValidator/Rules/RequireLocalizationState.swift

@@ -6,6 +6,7 @@ extension Rules {
         let states: [String]
         public var severity: Severity = .error
         public static let name = "require-localization-state"
+        public static let description: String = "Requires that each localization's state matches one of the provided values. Know localization states: " + LocalizationState.allCases.map({"`\($0)`"}).joined(separator: ", ")
 
         public init(in states: [String]) {
             self.states = states
@@ -55,6 +56,7 @@ extension Rules {
         let states: [String]
         public var severity: Severity = .error
         public static let name = "reject-localization-state"
+        public static let description: String = "Rejects a localization if it's state matches one of the provided values. Know localization states: " + LocalizationState.allCases.map({"`\($0)`"}).joined(separator: ", ")
 
         public init(in states: [String]) {
             self.states = states

Sources/XCStringsLint/XCStringsLint+Rules.swift

@@ -17,7 +17,7 @@ extension XCStringsLint {
                 let padding = alignment - $0.name.count
 
                 let namePad = String(repeating: " ", count: padding)
-                print($0.name + namePad + "Description") // TODO: Describe the rules
+                print($0.name + namePad + $0.description)
 
                 let configPad = String(repeating: " ", count: alignment)
                 print("\(configPad)`value`, `values`")