StackCleaner

Download the latest version on NuGet (Releases will no longer be kept up to date) https://www.nuget.org/packages/DanielWillett.StackCleaner

Clears up stack traces to make them much more readable during debugging.

Supports highly customizable color formatting in the following formats:

• ConsoleColor
  • Only supported with the WriteToConsole method as it directly sets Console.ForegroundColor.
• ANSI color codes (3-bit or 4-bit)
• Extended ANSI color codes (32-bit where supported)
• Unity Rich Text
• Unity TextMeshPro Rich Text
• Html (with tags)

Example (Extended ANSI)

Usage

usingStackCleaner;usingColor=System.Drawing.Color;// only needed when dealing with Color32Config.

Get StackTrace from Exception

StackTracestackTrace=StackTraceCleaner.GetStackTrace(exception);

All the following methods also have an overload to print an exception's stack trace and any existing remote stack traces on Mono. Remote stack traces are mainly caused by a context switch in async functions.

Write To Console

StackTraceCleanercleaner=newStackTraceCleaner(newStackCleanerConfiguration{ColorFormatting=StackColorFormatType.ExtendedANSIColor,IncludeFileData=true,IncludeILOffset=true,IncludeNamespaces=false,Colors=Color32Config.Default});// assume Exception ex was caughtConsole.ForegroundColor=ConsoleColor.Red;Console.WriteLine(ex.GetType().Name+" - "+ex.Message);cleaner.WriteToConsole(ex);

Write To String

StackTraceCleanercleaner=newStackTraceCleaner(newStackCleanerConfiguration{ColorFormatting=StackColorFormatType.None,IncludeNamespaces=false});StackTracestackTrace=/* etc */;UnityEngine.UI.TextBoxtextBox=/* etc */;textBox.text=cleaner.GetString(stackTrace);

Write To File

StackTraceCleanercleaner=newStackTraceCleaner(newStackCleanerConfiguration{ColorFormatting=StackColorFormatType.Html,IncludeNamespaces=false,IncludeSourceData=false,HtmlUseClassNames=true});StackTracestackTrace=/* etc */;stringstr=cleaner.WriteToFile(@"C:\error.html",stackTrace,System.Text.Encoding.UTF8);

Write To Stream

StackTraceCleanercleaner=newStackTraceCleaner(newStackCleanerConfiguration{ColorFormatting=StackColorFormatType.Html,IncludeNamespaces=false,IncludeSourceData=false,HtmlUseClassNames=true});StackTracestackTrace=/* etc */;NetworkStreamstream=/* etc */;// async variant also availablecleaner.WriteToStream(stream,stackTrace,System.Text.Encoding.UTF8);

Write To TextWriter

StackTraceCleanercleaner=newStackTraceCleaner(newStackCleanerConfiguration{ColorFormatting=StackColorFormatType.UnityRichText,IncludeNamespaces=true,IncludeSourceData=false,HiddenTypes=newType[]{typeof(ExecutionContext),typeof(TaskAwaiter),typeof(TaskAwaiter<>),typeof(ConfiguredTaskAwaitable.ConfiguredTaskAwaiter),typeof(ConfiguredTaskAwaitable<>.ConfiguredTaskAwaiter),typeof(System.Runtime.ExceptionServices.ExceptionDispatchInfo),typeof(UnityEngine.Debug),typeof(UnityEngine.Assert),typeof(UnityEngine.PlayerLoop)}});StackTracestackTrace=/* etc */;Streamstream=/* etc */;// async variant also availableusingTextWriterwriter=newTextWriter(stream,System.Text.Encoding.UTF8);cleaner.WriteToTextWriter(stackTrace,writer);

Configuration

Default

// Default values (see default configuration values below)StackTraceCleaner.Default.WriteToConsole(stackTrace);

Custom

publicstaticreadonlyStackTraceCleanerStackTraceCleaner=newStackTraceCleaner(newStackCleanerConfiguration{/* Format Configuration = default */// Determines how colors are added to formatting (if at all), see StackColorFormatType below.ColorFormatting=StackColorFormatType.None,// Only used for Source Data, determines what format provider is used to translate line numbers and IL offsets to strings.Locale=CultureInfo.InvariantCulture,// Source data includes line number, column number, IL offset, and file name when available.IncludeSourceData=true,// Appends a warning to the end of the stack trace that lines were removed for visibility.WarnForHiddenLines=false,// Source data is put on the line after the stack frame declaration.PutSourceDataOnNewLine=true,// Namespaces are included in the method declaration.IncludeNamespaces=true,// IL offsets are included in the source data.IncludeILOffset=false,// Line and column numbers are included in the source data.IncludeLineData=true,// Relative source file path will be included in the source data.IncludeFileData=false,// Assembly-qualified name (and path if IncludeFileData is true) will be included in the source data.IncludeAssemblyData=false,// 'Primitive' types will use their aliases. For example, 'int' instead of 'Int32'.UseTypeAliases=false,// If ColorFormatting is set to 'Html', use css class names (defined as public constants in the StackTraceCleaner class) instead of style tags.HtmlUseClassNames=false,// If ColorFormatting is set to 'Html', write an outer <div> with a background color around the output HTML.HtmlWriteOuterDiv=false,// Types who's methods will be skipped in stack traces.HiddenTypes=/* See Below */,/* Color Configuration */// As close as possible to the default Visual Studio C# formatting rules in 4 bit color (System.ConsoleColor)// Default value of ColorsColors=Color4Config.Default.// The default Visual Studio C# formatting rulesColors=Color32Config.Default,// Color settings with 4 bit colors, best for Color formatting of ANSIColor or ConsoleColor (or None).Colors=newColor4Config{KeywordColor=ConsoleColor.Green},// Color settings with 32 bit colors, best for Color formatting of everything else (or None).Colors=newColor32Config{// alpha channel is ignoredKeywordColor=Color.FromArgb(255,230,255,153)},// Color settings with 32 bit colors when using UnityEngine (because System.Drawing is not available).// This is only available in the .NET Framework 4.6.1 or 4.8.1 and .NET Standard 2.1 builds.Colors=newUnityColor32Config{// alpha channel is ignoredKeywordColor=newColor(0.34f,0.61f,0.84f,1f)}});

Colors

enum StackColorFormatType

• None => No color formatting, just raw text.
• ConsoleColor => Sets the Console.ForegroundColor for each section. Only applicable when printed to console with WriteToConsole
• UnityRichText => UnityEngine rich text tags. See more: Unity Rich Text
• TextMeshProRichText => TextMeshPro rich text tags. See more: Unity Rich Text
• ANSIColor => ANSI Terminal text formatting codes. See more: Microsft: Virtual Terminal Text Formatting.
• ExtendedANSIColor => ANSI Terminal text formatting codes. See more: Microsft: Virtual Terminal Extended Color Formatting.
• Html => Text is colored with <span> tags. Use classes instead of constant CSS styles by setting HtmlUseClassNames to true. The classes are public constants in StackTraceCleaner.
• ANSIColorNoBright => ANSI Terminal text formatting codes without the bright bit. Discord can display this in an ansi code block.

Custom Color Provider

A UnityColor32Config is already included, but this shows one way you could create a custom color provider. The base properties are stored in Int32 values formatted in ARGB32 converted like shown below:

unchecked{intargb=color.a<<24|color.r<<16|color.g<<8|color.b;bytea=(byte)(argb>>24),r=(byte)(argb>>16),g=(byte)(argb>>8),b=(byte)argb;}

Please note that you can use StackCleaner without referencing UnityEngine.dll as long as you don't access the UnityColor32Config class.

UnityEngine.Color Custom Converter:

usingStackCleaner;usingUnityEngine;usingColor=UnityEngine.Color;internalsealedclassUnityColorConfig:ColorConfig{// intead of new you can also override the base properties to provide the colors as ARGB int32s directly.publicnewColorKeywordColor{get=>FromArgb(base.KeywordColor);set=>base.KeywordColor=ToArgb(value);}publicnewColorMethodColor{get=>FromArgb(base.MethodColor);set=>base.MethodColor=ToArgb(value);}publicnewColorPropertyColor{get=>FromArgb(base.PropertyColor);set=>base.PropertyColor=ToArgb(value);}publicnewColorParameterColor{get=>FromArgb(base.ParameterColor);set=>base.ParameterColor=ToArgb(value);}publicnewColorClassColor{get=>FromArgb(base.ClassColor);set=>base.ClassColor=ToArgb(value);}publicnewColorStructColor{get=>FromArgb(base.StructColor);set=>base.StructColor=ToArgb(value);}publicnewColorFlowKeywordColor{get=>FromArgb(base.FlowKeywordColor);set=>base.FlowKeywordColor=ToArgb(value);}publicnewColorInterfaceColor{get=>FromArgb(base.InterfaceColor);set=>base.InterfaceColor=ToArgb(value);}publicnewColorGenericParameterColor{get=>FromArgb(base.GenericParameterColor);set=>base.GenericParameterColor=ToArgb(value);}publicnewColorEnumColor{get=>FromArgb(base.EnumColor);set=>base.EnumColor=ToArgb(value);}publicnewColorNamespaceColor{get=>FromArgb(base.NamespaceColor);set=>base.NamespaceColor=ToArgb(value);}publicnewColorPunctuationColor{get=>FromArgb(base.PunctuationColor);set=>base.PunctuationColor=ToArgb(value);}publicnewColorExtraDataColor{get=>FromArgb(base.ExtraDataColor);set=>base.ExtraDataColor=ToArgb(value);}publicnewColorLinesHiddenWarningColor{get=>FromArgb(base.LinesHiddenWarningColor);set=>base.LinesHiddenWarningColor=ToArgb(value);}publicnewColorHtmlBackgroundColor{get=>FromArgb(base.HtmlBackgroundColor);set=>base.HtmlBackgroundColor=ToArgb(value);}publicstaticColorFromArgb(intvalue){returnnewColor(unchecked((byte)(value>>16))/255f,unchecked((byte)(value>>8))/255f,unchecked((byte)value)/255f,1f);}publicstaticintToArgb(Colorcolor){return0xFF<<24|(byte)Math.Min(255,Mathf.RoundToInt(color.r*255))<<16|(byte)Math.Min(255,Mathf.RoundToInt(color.g*255))<<8|(byte)Math.Min(255,Mathf.RoundToInt(color.b*255));}}