TypeNameFormatter.Sources 1.1.1

Requires NuGet 2.8 or higher.

dotnet add package TypeNameFormatter.Sources --version 1.1.1
NuGet\Install-Package TypeNameFormatter.Sources -Version 1.1.1
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="TypeNameFormatter.Sources" Version="1.1.1">
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TypeNameFormatter.Sources --version 1.1.1
#r "nuget: TypeNameFormatter.Sources, 1.1.1"
#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 TypeNameFormatter.Sources as a Cake Addin
#addin nuget:?package=TypeNameFormatter.Sources&version=1.1.1

// Install TypeNameFormatter.Sources as a Cake Tool
#tool nuget:?package=TypeNameFormatter.Sources&version=1.1.1

TypeNameFormatter is a small .NET library for formatting type names à la C#.

What is this good for?

Have you ever stumbled over the cryptic formatting of Type objects?

var someType = typeof(IEnumerable<int[]>);

// => System.Collections.Generic.IEnumerable`1[System.Int32[]]

If you'd rather see something that looks more like a C# type name, then this library might be for you:

using TypeNameFormatter;

var someType = typeof(IEnumerable<int[]>);

// => IEnumerable<int[]>

Formatting any Type involves more special cases than you might expect (such as generic types, nested types, multi-dimensional and jagged arrays, by-reference and pointer types). This library deals with all of those, so that you don't have to.

How do I use it?

By importing the TypeNameFormatter namespace, the following extension methods become available:

  • stringBuilder.AppendFormattedName(Type type, [TypeNameFormatOptions options]):
    Appends a C#-formatted type name to the given StringBuilder.

  • type.GetFormattedName([TypeNameFormatOptions options]):
    Returns a C#-formatted type name as a string. (This is a convenience method that does exactly the same as the above, using a throw-away StringBuilder.)

Both methods allow you to specify any combination of the following TypeNameFormatOptions flags:

  • Namespaces:
    Namespaces should be included. (For example, System.Action instead of Action.)

  • NoAnonymousTypes:
    Anonymous types should not have their "display class" name transformed to a more legible syntax. (For example, ˂˃f__AnonymousType5˂string, int˃ instead of {string Name, int Count}.)

  • NoGenericParameterNames:
    Parameter names of an open generic type should be omitted. (For example, IEnumerable˂˃ instead of IEnumerable˂T˃. Note that this setting does not affect closed generic types; their arguments are always included.)

  • NoKeywords:
    Primitive types should not be mapped to their corresponding C# language keywords. (For example, Int32 instead of int.)

  • NoNullableQuestionMark:
    Nullable types should not be formatted using C# question mark syntax. (For example, Nullable˂int˃ instead of int?.)

  • NoTuple:
    Value tuple types should not be formatted using C# tuple syntax. (For example, ValueTuple˂bool, int˃ instead of (bool, int).)

But it doesn't format ˂some type˃ correctly!

If you think you've found a bug, please raise an issue so it can be looked into. (Make sure to mention the type that doesn't get formatted as expected.)


  • If you're targeting the .NET Framework, you can use good old System.CodeDom (which isn't particularly fast, however):

    using Microsoft.CSharp;
    using System.CodeDom;
    static string GetFormattedName(this Type type)
         using (var provider = new CSharpCodeProvider())
             var typeReference = new CodeTypeReference(type);
             return provider.GetTypeOutput(typeReference);
  • You could perhaps use Microsoft's .NET Compiler Platform (Roslyn), but that is a large library that can do much more than is needed.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on TypeNameFormatter.Sources:

Repository Stars
The most popular and friendly mocking framework for .NET
The most popular and friendly mocking framework for .NET
A modern compile-time generated interception/proxy library
Version Downloads Last updated
1.1.1 236,817 1/16/2021
1.1.0 629 11/12/2020
1.0.1 5,098 12/30/2018
1.0.0 7,662 7/11/2018
1.0.0-beta3 892 6/7/2018
1.0.0-beta 945 5/24/2018
1.0.0-alpha 1,161 5/24/2018