ATK.Command.CsToTsGenerator 1.1.9

ATK.Command.CsToTsGenerator - Technical Documentation

Code generator for automatic generation of TypeScript types from C# types using .NET Reflection.

Requirements

• .NET 10.0
• Microsoft.CodeAnalysis 5.0.0
• System.CodeDom 10.0.1

Entry Point

using ATK.Command.CsToTsGenerator;

var generator = new Generator();
var tsGenerator = generator.TypeScript();

The class Generator is the central entry point:

• Generator.TypeScript() → Instantiates TypeScriptGenerator
• TypeScriptGenerator orchestrates the entire generation process

Generation Modes

SeparatedFiles - Each type in separate file

• One file per type
• Barrel export via index.ts
• Automatic directory clearing with flag
• Template: Templates/SeparatedFiles/
• Classes: SeparatedFilesGenerator, SeparatedFilesGeneratorWithMetaData, SeparatedFilesGeneratorWithRenderedTypes

OneFile - All types in one file

• All types in a single file
• Compact output
• Classes: OneFileGenerator, OneFileGeneratorWithMetaData

Core Components

Type Mapping

Template Engine

T4 Text Templates in Templates/:

• SeparatedFiles/ComplexTypes/ - Class/Record generation
• SeparatedFiles/Commands/ - Command interface
• SeparatedFiles/Enums/ - Enum generation
• SeparatedFiles/TypeScriptImports/ - Import statements
• SeparatedFiles/CodeGenerationWarning/ - Generation header

API

SeparatedFilesGenerator

using ATK.Command.CsToTsGenerator;

var generator = new Generator();
var tsGenerator = generator.TypeScript();

var builtFiles = tsGenerator
    .SeparatedFiles()
    .SetInterfaceFilter(typeof(IRequestCommand))
    .SetReturnTypeOfCommands(typeof(Response))
    .SetRequestCommandInterfaceNameForGeneratedCommands("ICommand")
    .AddRangeOfCommandTypesToGenerate(commandTypes)
    .AddRangeOfExtraTypesToGenerate(dtoTypes)
    .GenerateMetadata()
    .GenerateTypeScript()
    .Build();

builtFiles.Save(clearDestinationFolder: true);

OneFileGenerator

using ATK.Command.CsToTsGenerator;

var generator = new Generator();
var tsGenerator = generator.TypeScript();

var builtFile = tsGenerator
    .OneFile()
    .SetInterfaceFilter(typeof(IRequestCommand))
    .SetReturnTypeOfCommands(typeof(Response))
    .SetRequestCommandInterfaceNameForGeneratedCommands("ICommand")
    .AddRangeOfCommandTypesToGenerate(commandTypes)
    .AddRangeOfExtraTypesToGenerate(dtoTypes)
    .GenerateMetadata()
    .GenerateTypeScript()
    .Build("output/api-types.ts");

builtFile.Save();

Data Models

Filter and Configuration

SetInterfaceFilter

• Only types implementing this interface
• Type selection for commands

SetReturnTypeOfCommands

• Response type for generated commands
• Default: Response, ApiResponse

AddRangeOfCommandTypesToGenerate

• Select command types
• Converted to TypeScript interfaces

AddRangeOfExtraTypesToGenerate

• Add DTOs and other types

Type Classification

GeneratorTypeKind Enum:

• Class - Regular classes
• Interface - Interfaces
• Record - Record types
• Enum - Enumerations
• Struct - Structure types

Testing

Test projects in src/ATK.Command.CsToTsGenerator.Tests:

• GeneratorTypeTests - Type recognition
• ClassGeneratorTypeTests - Class generation
• OneFileGeneratorTests - OneFile mode
• SeparatedFilesGeneratorTests - SeparatedFiles mode
• InheritanceTests - Inheritance handling
• TypeDependencyResolverTests - Dependency resolution
• TypeNameResolverTests - Name resolution

Build & NuGet

Build:

dotnet build
dotnet test

Package:

• ATK.Command.CsToTsGenerator
• Repository: https://github.com/a-t-k/ATK.Command.CsToTsGenerator
• License: LICENSE