(* YOCaml a static blog generator.
   Copyright (C) 2024 The Funkyworkers and The YOCaml's developers

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>. *)

(** Tools for building error diagnostics. These are essentially pretty-printers
    for exceptions propagated by the {!module:Yocaml.Eff} module. *)

val exception_to_diagnostic :
     ?custom_error:(Format.formatter -> Data.Validation.custom_error -> unit)
  -> ?in_exception_handler:bool
  -> Format.formatter
  -> exn
  -> unit
(** A pretty printer that tries to return exceptions in the form of diagnostics
    (a string describing the error). *)

val runtime_error_to_diagnostic : Format.formatter -> string -> unit
(** Uses the same representation as an exception diagnostic to visually render
    an error message produced by the runtime. *)
