Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skbkontur/TypeScript.ContractGenerator

A tool that can generate TypeScript types from C# classes
https://github.com/skbkontur/TypeScript.ContractGenerator

code-generation code-generator csharp roslyn typescript

Last synced: about 2 months ago
JSON representation

A tool that can generate TypeScript types from C# classes

Host: GitHub
URL: https://github.com/skbkontur/TypeScript.ContractGenerator
Owner: skbkontur
License: mit
Created: 2019-01-25T10:09:16.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-05-16T12:16:38.000Z (4 months ago)
Last Synced: 2024-07-16T13:54:29.127Z (2 months ago)
Topics: code-generation, code-generator, csharp, roslyn, typescript
Language: C#
Homepage:
Size: 657 KB
Stars: 57
Watchers: 21
Forks: 24
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

jimsghstars - skbkontur/TypeScript.ContractGenerator - A tool that can generate TypeScript types from C# classes (C# #)

README

        # TypeScript.ContractGenerator

A tool that can generate TypeScript types from C# classes

|                                     | Build Status |

|-------------------------------------|:--------------: |

| TypeScript.ContractGenerator        | [![NuGet Status](https://img.shields.io/nuget/v/SkbKontur.TypeScript.ContractGenerator.svg)](https://www.nuget.org/packages/SkbKontur.TypeScript.ContractGenerator/) |

| TypeScript.ContractGenerator.Roslyn | [![NuGet Status](https://img.shields.io/nuget/v/SkbKontur.TypeScript.ContractGenerator.Roslyn.svg)](https://www.nuget.org/packages/SkbKontur.TypeScript.ContractGenerator.Roslyn/) |

| TypeScript.ContractGenerator.Cli    | [![NuGet Status](https://img.shields.io/nuget/v/SkbKontur.TypeScript.ContractGenerator.Cli.svg)](https://www.nuget.org/packages/SkbKontur.TypeScript.ContractGenerator.Cli/) |

| Build                               | [![Build status](https://github.com/skbkontur/TypeScript.ContractGenerator/actions/workflows/actions.yml/badge.svg)](https://github.com/skbkontur/TypeScript.ContractGenerator/actions) |

## Release Notes

See [CHANGELOG](CHANGELOG.md).

## How to Use

See https://github.com/skbkontur/TypeScript.ContractGenerator/wiki#how-to-use

See [Quick Start](https://github.com/skbkontur/TypeScript.ContractGenerator/wiki/Quick-Start) for more detailed guide

## Generation options

See https://github.com/skbkontur/TypeScript.ContractGenerator/wiki/Generation-Options

## Attributes

There is `ContractGeneratorIgnore` attribute that can be applied to properties and makes generator skip current property.

## Roslyn usage

To use Roslyn you should get a `Compilation` object of your project. It can be done with helper method `AdhocProject.GetCompilation(string[] directories, string[] assemblies)`.

You can then get customization info from this compilation by calling extension method `compilation.GetCustomization()` and call `TypeScriptGenerator` with this customization:

```csharp

var (customTypeGenerator, typesProvider) = AdhocProject.GetCompilation(directories, assemblies).GetCustomization();

var typeGenerator = new TypeScriptGenerator(options, customTypeGenerator, typesProvider);

typeGenerator.GenerateFiles(outputDirectory);

```

## dotnet tool usage

Install tool with command:

`dotnet tool install -g SkbKontur.TypeScript.ContractGenerator.Cli`

Use tool with command:

`dotnet ts-gen --assembly ./Api/bin/Api.dll --outputDir ./src/Api`

dotnet tool also supports Roslyn:

`dotnet ts-gen --directory ./Api;./Core --assembly ./External/Dependency.dll --outputDir ./src/Api`