Make GenericError conform to Catching + improve error messages for caught

Author: Jeehut

README.md

@@ -383,7 +383,7 @@ enum AppError: Throwable, Catching {
         case .invalidConfiguration:
             return String(localized: "The app configuration is invalid.")
         case .caught(let error):
-            return error.localizedDescription
+            return ErrorKit.userFriendlyMessage(for: error)
         }
     }
 }

Sources/ErrorKit/BuiltInErrors/DatabaseError.swift

@@ -157,7 +157,7 @@ public enum DatabaseError: Throwable, Catching {
       case .generic(let userFriendlyMessage):
          return userFriendlyMessage
       case .caught(let error):
-         return error.localizedDescription
+         return ErrorKit.userFriendlyMessage(for: error)
       }
    }
 }

Sources/ErrorKit/BuiltInErrors/FileError.swift

@@ -148,7 +148,7 @@ public enum FileError: Throwable, Catching {
       case .generic(let userFriendlyMessage):
          return userFriendlyMessage
       case .caught(let error):
-         return error.localizedDescription
+         return ErrorKit.userFriendlyMessage(for: error)
       }
    }
 }

Sources/ErrorKit/BuiltInErrors/GenericError.swift

@@ -15,7 +15,11 @@ import Foundation
 ///                 userFriendlyMessage: String(localized: "The business data doesn't meet required criteria")
 ///             )
 ///         }
-///         // Continue with business logic
+///
+///         // Automatically wrap any other errors if needed
+///         try GenericError.catch {
+///             try validateAdditionalRules(data)
+///         }
 ///     }
 /// }
 /// ```
@@ -33,7 +37,7 @@ import Foundation
 ///     }
 /// }
 /// ```
-public struct GenericError: Throwable {
+public struct GenericError: Throwable, Catching {
    /// A user-friendly message describing the error.
    public let userFriendlyMessage: String
 
@@ -56,4 +60,30 @@ public struct GenericError: Throwable {
    public init(userFriendlyMessage: String) {
       self.userFriendlyMessage = userFriendlyMessage
    }
+
+   /// Creates a new generic error that wraps another error.
+   /// Used internally by the ``catch(_:)`` function to automatically wrap any thrown errors.
+   ///
+   /// # Example
+   /// ```swift
+   /// struct FileProcessor {
+   ///     func processUserData() throws(GenericError) {
+   ///         // Explicit throwing for validation
+   ///         guard isValidPath(userDataPath) else {
+   ///             throw GenericError(userFriendlyMessage: "Invalid file path selected")
+   ///         }
+   ///
+   ///         // Automatically wrap any file system or JSON errors
+   ///         let userData = try GenericError.catch {
+   ///             let data = try Data(contentsOf: userDataPath)
+   ///             return try JSONDecoder().decode(UserData.self, from: data)
+   ///         }
+   ///     }
+   /// }
+   /// ```
+   ///
+   /// - Parameter error: The error to be wrapped.
+   public static func caught(_ error: Error) -> Self {
+      GenericError(userFriendlyMessage: ErrorKit.userFriendlyMessage(for: error))
+   }
 }

Sources/ErrorKit/BuiltInErrors/NetworkError.swift

@@ -215,7 +215,7 @@ public enum NetworkError: Throwable, Catching {
       case .generic(let userFriendlyMessage):
          return userFriendlyMessage
       case .caught(let error):
-         return error.localizedDescription
+         return ErrorKit.userFriendlyMessage(for: error)
       }
    }
 }

Sources/ErrorKit/BuiltInErrors/OperationError.swift

@@ -122,7 +122,7 @@ public enum OperationError: Throwable, Catching {
       case .generic(let userFriendlyMessage):
          return userFriendlyMessage
       case .caught(let error):
-         return error.localizedDescription
+         return ErrorKit.userFriendlyMessage(for: error)
       }
    }
 }

Sources/ErrorKit/BuiltInErrors/ParsingError.swift

@@ -122,7 +122,7 @@ public enum ParsingError: Throwable, Catching {
       case .generic(let userFriendlyMessage):
          return userFriendlyMessage
       case .caught(let error):
-         return error.localizedDescription
+         return ErrorKit.userFriendlyMessage(for: error)
       }
    }
 }

Sources/ErrorKit/BuiltInErrors/PermissionError.swift

@@ -149,7 +149,7 @@ public enum PermissionError: Throwable, Catching {
       case .generic(let userFriendlyMessage):
          return userFriendlyMessage
       case .caught(let error):
-         return error.localizedDescription
+         return ErrorKit.userFriendlyMessage(for: error)
       }
    }
 }

Sources/ErrorKit/BuiltInErrors/StateError.swift

@@ -142,7 +142,7 @@ public enum StateError: Throwable, Catching {
       case .generic(let userFriendlyMessage):
          return userFriendlyMessage
       case .caught(let error):
-         return error.localizedDescription
+         return ErrorKit.userFriendlyMessage(for: error)
       }
    }
 }

Sources/ErrorKit/BuiltInErrors/ValidationError.swift

@@ -156,7 +156,7 @@ public enum ValidationError: Throwable, Catching {
       case .generic(let userFriendlyMessage):
          return userFriendlyMessage
       case .caught(let error):
-         return error.localizedDescription
+         return ErrorKit.userFriendlyMessage(for: error)
       }
    }
 }