VarDump 2.0.3

VarDump

VarDump turns runtime .NET objects into readable C# or Visual Basic source code.

Use it when you want copyable object initializers for tests, diagnostics, documentation, samples, or debugging workflows where plain text dumps are not enough.

dotnet add package VarDump

Quick Start

C# Source Output

This is the smallest useful VarDump example: create a dumper, pass any object, and print the generated source.

<p align="right"><a href="https://dotnetfiddle.net/vI6Wq4">Run .NET fiddle</a></p>

using System;
using VarDump;

var person = new
{
    Name = "Nick",
    Age = 23,
    Tags = new[] { "admin", "active" }
};

var source = new CSharpDumper().Dump(person);

Console.WriteLine(source);

Visual Basic Source Output

Use VisualBasicDumper when the output needs to be Visual Basic source.

using System;
using VarDump;

var person = new { Name = "Nick", Age = 23 };
var source = new VisualBasicDumper().Dump(person);

Console.WriteLine(source);

Core Features

VarDump is built for source-code output.

For behavior examples, see the unit tests.

Configure Output

Member Sorting And Skipped Values

Pass DumpOptions to either dumper to control member selection, sorting, formatting, collection layout, string literal style, and more.

<p align="right"><a href="https://dotnetfiddle.net/p4oIKX">Run .NET fiddle</a></p>

using System;
using System.ComponentModel;
using VarDump;
using VarDump.Visitor;

var options = new DumpOptions
{
    SortDirection = ListSortDirection.Ascending,
    IgnoreNullValues = false,
    IgnoreDefaultValues = false
};

var person = new { Name = "Nick", Age = 23, MiddleName = (string?)null };
var source = new CSharpDumper(options).Dump(person);

Console.WriteLine(source);

Full reference: DumpOptions API Guide.

Modern C# Literal Styles

Use literal style options when generated C# should target newer language features.

using VarDump;
using VarDump.Visitor;

var options = new DumpOptions
{
    StringLiteralStyle = StringLiteralStyle.Raw,
    CollectionLiteralStyle = CollectionLiteralStyle.Expression
};

var source = new CSharpDumper(options).Dump(new[] { "one", "two" });

Raw string literals require modern C# language support. Expression collection literals require C# 12 support.

Extension Methods

Install the separate extension package when you want DumpText(), DumpConsole(), DumpDebug(), or DumpTrace() on any object.

dotnet add package VarDump.Extensions

Object Extension Methods

<p align="right"><a href="https://dotnetfiddle.net/n9kjiF">Run .NET fiddle</a></p>

using System;
using System.Linq;

var dictionary = new[]
{
    new { Name = "Name1", Surname = "Surname1" }
}.ToDictionary(x => x.Name, x => x);

Console.WriteLine(dictionary.DumpText());
dictionary.DumpConsole();
dictionary.DumpDebug();
dictionary.DumpTrace();

Visual Basic Extension Output

<p align="right"><a href="https://dotnetfiddle.net/OGCcrk">Run .NET fiddle</a></p>

using System;
using System.Linq;

VarDumpExtensions.VarDumpFactory = VarDumpFactories.VisualBasic;

var dictionary = new[]
{
    new { Name = "Name1", Surname = "Surname1" }
}.ToDictionary(x => x.Name, x => x);

Console.WriteLine(dictionary.DumpText());

Advanced And Extensibility

Use the advanced APIs when you need to transform object descriptions before output or teach VarDump how to serialize a specific type.

Comparison

VarDump grew out of work on Object Dumper Visual Studio, Visual Studio Code, and Rider extensions. It focuses on richer source-code generation options than ObjectDumper.NET.

Powered By

Repository	License
Heavily customized version of System.CodeDom

Privacy Notice: No personal data is collected.

This tool has been working well for my personal needs, but outside that its future depends on your feedback. Please open an issue with problems, ideas, or examples that should work better.

Sponsor the project on GitHub or PayPal.