mirror of
https://github.com/spectreconsole/spectre.console.git
synced 2025-10-25 15:19:23 +00:00
c2da268129
* 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
61 lines
2.0 KiB
Markdown
61 lines
2.0 KiB
Markdown
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.
|
|
|
|
```csharp
|
|
AnsiConsole.WriteException(ex);
|
|
```
|
|
|
|
<?# AsciiCast cast="default-exception" /?>
|
|
|
|
## 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.
|
|
|
|
```csharp
|
|
AnsiConsole.WriteException(ex,
|
|
ExceptionFormats.ShortenPaths | ExceptionFormats.ShortenTypes |
|
|
ExceptionFormats.ShortenMethods | ExceptionFormats.ShowLinks);
|
|
```
|
|
|
|
<?# AsciiCast cast="shortened-exception" /?>
|
|
|
|
## Customizing exception output
|
|
|
|
In addition to shorten specific part of the exception, you can
|
|
also override the default styling.
|
|
|
|
```csharp
|
|
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),
|
|
}
|
|
});
|
|
```
|
|
|
|
<?# AsciiCast cast="custom-colors-exception" /?>
|