Improve error messages

iamgio · Jul 29, 2024 · 6f7b6e9 · 6f7b6e9
1 parent cd732fe
commit 6f7b6e9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 10 deletions.
diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/ast/quarkdown/Box.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/ast/quarkdown/Box.kt
@@ -30,15 +30,18 @@ data class Box(
         /**
          * A custom box that shows an error message.
          * @param message error message to display
+         * @param title additional error title
          * @return a custom box containing the error message
          */
-        fun error(message: String) =
-            Box(
-                title = listOf(Text("Error")),
-                padding = null,
-                backgroundColor = Color(224, 67, 64),
-                foregroundColor = Color(255, 255, 255),
-                children = listOf(CodeSpan(message)),
-            )
+        fun error(
+            message: String,
+            title: String? = null,
+        ) = Box(
+            title = listOf(Text("Error" + if (title != null) ": $title" else "")),
+            padding = null,
+            backgroundColor = Color(224, 67, 64),
+            foregroundColor = Color(255, 255, 255),
+            children = listOf(CodeSpan(message)),
+        )
     }
 }
diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/function/call/FunctionCallNodeExpander.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/function/call/FunctionCallNodeExpander.kt
@@ -50,7 +50,7 @@ class FunctionCallNodeExpander(
         } catch (e: PipelineException) {
             // If the function call is invalid.
             errorHandler.handle(e) { message ->
-                appendOutput(node, Box.error(message)) // Shows an error message box in the final document.
+                appendOutput(node, Box.error(message, title = call.name)) // Shows an error message box in the final document.
             }
         }
     }

diff --git a/core/src/main/kotlin/eu/iamgio/quarkdown/function/error/FunctionRuntimeException.kt b/core/src/main/kotlin/eu/iamgio/quarkdown/function/error/FunctionRuntimeException.kt
@@ -7,7 +7,7 @@ import eu.iamgio.quarkdown.pipeline.error.PipelineException
  * An exception thrown when an error occurs inside a called function.
  * @param message error message
  */
-class FunctionRuntimeException(message: String) : PipelineException("A runtime error occurred: $message", RUNTIME_ERROR_EXIT_CODE) {
+class FunctionRuntimeException(message: String) : PipelineException(message, RUNTIME_ERROR_EXIT_CODE) {
     /**
      * @param throwable the error cause
      */