spectre.console/docs/input/exceptions.md
Phil Scott c2da268129
Docs redesign (#728)
* Adding a dark mode
* Adding reference for types to summary pages
* Adding API Reference
* Adding modifiers to methods/fields/etc
* Minimizing files input
* Caching a lot of the output pages
* Cache only for each execution
* Adding API references to existing docs
2022-02-14 18:44:25 +01:00

2.0 KiB

Title: Exceptions Order: 40 Description: "Exceptions aren't always readable when viewed in the terminal. You can make exception a bit more readable by using the WriteException method." Highlights: - Color coded output. - Shorten long identifiers and paths. Reference: - M:Spectre.Console.AnsiConsole.WriteException(System.Exception,Spectre.Console.ExceptionFormats) - M:Spectre.Console.AnsiConsole.WriteException(System.Exception,Spectre.Console.ExceptionSettings)


Exceptions aren't always readable when viewed in the terminal.
You can make exception a bit more readable by using the WriteException method.

AnsiConsole.WriteException(ex);

Shortening parts

You can also shorten specific parts of the exception to make it even more readable, and make paths clickable hyperlinks. Whether or not the hyperlinks are clickable is up to the terminal.

AnsiConsole.WriteException(ex, 
    ExceptionFormats.ShortenPaths | ExceptionFormats.ShortenTypes |
    ExceptionFormats.ShortenMethods | ExceptionFormats.ShowLinks);

Customizing exception output

In addition to shorten specific part of the exception, you can also override the default styling.

AnsiConsole.WriteException(ex, new ExceptionSettings
{
    Format = ExceptionFormats.ShortenEverything | ExceptionFormats.ShowLinks,
    Style = new ExceptionStyle
    {
        Exception = new Style().Foreground(Color.Grey),
        Message = new Style().Foreground(Color.White),
        NonEmphasized = new Style().Foreground(Color.Cornsilk1),
        Parenthesis = new Style().Foreground(Color.Cornsilk1),
        Method = new Style().Foreground(Color.Red),
        ParameterName = new Style().Foreground(Color.Cornsilk1),
        ParameterType = new Style().Foreground(Color.Red),
        Path = new Style().Foreground(Color.Red),
        LineNumber = new Style().Foreground(Color.Cornsilk1),
    }
});