Object.LiteralWriter 2.0.4

There is a newer version of this package available.
See the version list below for details.
dotnet add package Object.LiteralWriter --version 2.0.4                
NuGet\Install-Package Object.LiteralWriter -Version 2.0.4                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Object.LiteralWriter" Version="2.0.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Object.LiteralWriter --version 2.0.4                
#r "nuget: Object.LiteralWriter, 2.0.4"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Object.LiteralWriter as a Cake Addin
#addin nuget:?package=Object.LiteralWriter&version=2.0.4

// Install Object.LiteralWriter as a Cake Tool
#tool nuget:?package=Object.LiteralWriter&version=2.0.4                

ObjectLiteralWriter

Convert arbitrary .NET objects at runtime into strings containing their construction literal in C#

Library is available on NuGet https://www.nuget.org/packages/Object.LiteralWriter/

Ever had a case when you need to prepare data for a unit test, you have suitable object during runtime (i.e. you got it from DB or another service) and you need to produce its literal for use in that test? ObjectLiteralWriter solves this problem.

It will handle primitive values and built-in types, complex classes, nested objects, collections, tuples, etc...

hint: if you have a json representation of your object - you can run it through deserializer and feed the result into ObjectLiteralWriter. Strong typed C# class literals will be easier to maintain than json.

var subj = new object[]
{
    new Test1()
    {
        Foo = 1.1m,
        Bar = null,
        Bac = (1, 2, 3),
    },
    new DateTime(1, 2, 3, 4, 0, 0, DateTimeKind.Utc),
    null,
    1,
    2D,
    3M,
    Guid.Parse("d237f51b-61ec-4a53-a6df-56aeaee6bb68"),
    true,
    new object(),
};

var literal = new ObjectLiteralWriter.ObjectLiteralWriter().GetLiteral(subj, indentation: "    ");
// OR 
// var literal = new ObjectLiteralWriter().GetLiteral(subj).IndentLiteral();

/*
@"new Object[]
{
    new Test1()
    {
        Foo = 1.1M,
        Bac = (1, 2, 3),
    },
    new DateTime(1, 2, 3, 4, 0, 0, DateTimeKind.Utc),
    null,
    1,
    2D,
    3M,
    Guid.Parse("d237f51b-61ec-4a53-a6df-56aeaee6bb68"),
    true,
    new object(),
}"*/

In a rare case where you want to customize literals of specific types or specific properties, ObjectLiteralWriter has extension points:

/// <summary>
/// Function will get a chance to examine values 
/// that are being converted to literals.
/// Return literal string to write it.
/// Return null to fallback to default literal writer.
/// Return empty string to skip writing this value.
/// </summary>
Func<Type, object, string> CustomLiteralWriter
{
    get;
    set;
}

/// <summary>
/// Function will get a chance to examine type members
/// that are being converted to literals.
/// Return literal string to write it.
/// Return null to fallback to default literal writer.
/// Return empty string to skip writing this member.
/// </summary>
Func<PropertyInfo, FieldInfo, object, string> CustomMemberWriter
{
    get;
    set;
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.5 639 4/11/2023
2.0.4 667 4/8/2023
2.0.3 635 4/7/2023
2.0.2 653 4/7/2023
2.0.1 632 4/6/2023
2.0.0 656 4/6/2023