TypeGen

TypeGen is a single-class-per-file C# to TypeScript generator. Key features include:

• Generating TypeScript classes, interfaces, and enums (one file per class).
• Generating barrel (index) files.
• Support for collections and generic types.
• Support for inheritance.
• Customizable translation of naming conventions.

TypeGen allows you to specify which C# classes should be converted to TypeScript using two different methods:

Method 1: Using Attributes

Decorate your C# classes with the [ExportTsClass] attribute.

Method 2: Using a Generation Spec

Create a class that inherits from GenerationSpec and use the AddClass<T>() method to register types. This is useful if you want to manage exports in a centralized file rather than decorating every class.

// Method 1: Using attributes
[ExportTsClass]
public class ProductDto
{
    public decimal Price { get; set; }
    public string[] Tags { get; set; }
}

// Method 2: Using a specification file
public class MyGenerationSpec : GenerationSpec
{
    public MyGenerationSpec()
    {
        AddClass<ProductDto>();
    }
}

You can obtain TypeGen via NuGet in two ways depending on your needs:

1. As a library: Add the TypeGen NuGet package to your project to use attributes for type selection.
2. As a .NET CLI tool: Install the dotnet-typegen NuGet package to run generation commands from the system console or Package Manager Console.

# Use the TypeGen NuGet package for library integration
# Use the dotnet-typegen NuGet package for CLI tool usage

After configuring your types and tgconfig.json, you can trigger the generation process using the following commands:

Using the .NET Tool (System Console)

Run this command from your terminal: dotnet typegen generate

Using the Package Manager Console (Visual Studio)

Run one of these commands (you may need to restart Visual Studio after installation):

• TypeGen generate
• TypeGen -p "MyProjectName" generate (if not in the project directory)

If you choose to use a GenerationSpec class instead of attributes, you must create a tgconfig.json file in your project folder to tell TypeGen which spec to use. Include the name of your spec class in the generationSpecs array.

{
  "generationSpecs": ["MyGenerationSpec"]
}