wip

Author: stephencelis

Sources/IssueReporting/Documentation.docc/Extensions/withErrorReporting.md

@@ -1,7 +1,7 @@
-# ``IssueReporting/withErrorReporting(_:fileID:filePath:line:column:catching:)-3k8o``
+# ``IssueReporting/withErrorReporting(_:to:fileID:filePath:line:column:catching:)-89omf``
 
 ## Topics
 
 ### Overloads
 
-- ``withErrorReporting(_:fileID:filePath:line:column:catching:)-r4f1``
+- ``withErrorReporting(_:to:fileID:filePath:line:column:catching:)-3dh1h``

Sources/IssueReporting/Documentation.docc/IssueReporting.md

@@ -53,7 +53,7 @@ that ship in the same target as the library itself.
 
 - ``reportIssue(_:fileID:filePath:line:column:)``
 - ``withExpectedIssue(_:isIntermittent:fileID:filePath:line:column:_:)-9pinm``
-- ``withErrorReporting(_:fileID:filePath:line:column:catching:)-3k8o``
+- ``withErrorReporting(_:to:fileID:filePath:line:column:catching:)-89omf``
 
 ### Issue reporters
 

Sources/IssueReporting/ErrorReporting.swift

@@ -1,6 +1,7 @@
 /// Evaluates a throwing closure and automatically catches and reports any error thrown.
 ///
 /// - Parameters:
+///   - message: A message describing the expectation.
 ///   - reporters: Issue reporters to notify during the operation.
 ///   - fileID: The source `#fileID` associated with the error reporting.
 ///   - filePath: The source `#filePath` associated with the error reporting.
@@ -10,7 +11,8 @@
 /// - Returns: The optional result of the operation, or `nil` if an error was thrown.
 @_transparent
 public func withErrorReporting<R>(
-  _ reporters: [any IssueReporter]? = nil,
+  _ message: @autoclosure () -> String? = nil,
+  to reporters: [any IssueReporter]? = nil,
   fileID: StaticString = #fileID,
   filePath: StaticString = #filePath,
   line: UInt = #line,
@@ -22,15 +24,29 @@ public func withErrorReporting<R>(
       do {
         return try body()
       } catch {
-        reportIssue(error, fileID: fileID, filePath: filePath, line: line, column: column)
+        reportIssue(
+          error,
+          message(),
+          fileID: fileID,
+          filePath: filePath,
+          line: line,
+          column: column
+        )
         return nil
       }
     }
   } else {
     do {
       return try body()
     } catch {
-      reportIssue(error, fileID: fileID, filePath: filePath, line: line, column: column)
+      reportIssue(
+        error,
+        message(),
+        fileID: fileID,
+        filePath: filePath,
+        line: line,
+        column: column
+      )
       return nil
     }
   }
@@ -39,6 +55,7 @@ public func withErrorReporting<R>(
 /// Evaluates a throwing closure and automatically catches and reports any error thrown.
 ///
 /// - Parameters:
+///   - message: A message describing the expectation.
 ///   - reporters: Issue reporters to notify during the operation.
 ///   - fileID: The source `#fileID` associated with the error reporting.
 ///   - filePath: The source `#filePath` associated with the error reporting.
@@ -48,7 +65,8 @@ public func withErrorReporting<R>(
 /// - Returns: The optional result of the operation, or `nil` if an error was thrown.
 @_transparent
 public func withErrorReporting<R>(
-  _ reporters: [any IssueReporter]? = nil,
+  _ message: @autoclosure () -> String? = nil,
+  to reporters: [any IssueReporter]? = nil,
   fileID: StaticString = #fileID,
   filePath: StaticString = #filePath,
   line: UInt = #line,

Tests/IssueReportingTests/WithErrorReportingTests.swift

@@ -12,6 +12,14 @@
       } matching: { issue in
         issue.description == "Caught error: SomeError()"
       }
+
+      withKnownIssue {
+        withErrorReporting("Failed") {
+          throw SomeError()
+        }
+      } matching: { issue in
+        issue.description == "Caught error: SomeError(): Failed"
+      }
     }
   }