https://github.com/jvorssel/sushi
Converting C# classes to Javascript & Typescript classes in different scopes.
https://github.com/jvorssel/sushi
c-sharp c-sharp-library code-generation code-generator compiler ecmascript ecmascript6 extension-methods framework javascript model typescript unit-test validation validator
Last synced: 2 months ago
JSON representation
Converting C# classes to Javascript & Typescript classes in different scopes.
- Host: GitHub
- URL: https://github.com/jvorssel/sushi
- Owner: jvorssel
- License: mit
- Created: 2018-02-19T20:34:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-02T18:58:57.000Z (over 1 year ago)
- Last Synced: 2025-08-17T01:32:32.728Z (10 months ago)
- Topics: c-sharp, c-sharp-library, code-generation, code-generator, compiler, ecmascript, ecmascript6, extension-methods, framework, javascript, model, typescript, unit-test, validation, validator
- Language: C#
- Size: 1.95 MB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
-# SushiScript Library for converting .NET classes to script language classes.
**Currently supports**
- **[TypeScript](https://github.com/jvorssel/Sushi/tree/master/TestResults)**
- **[ECMAScript 5](https://github.com/jvorssel/Sushi/tree/master/TestResults)**
- **[ECMAScript 6](https://github.com/jvorssel/Sushi/tree/master/TestResults)**
**Author**
Jeroen Vorsselman @ 2024
**[GitHub](https://github.com/jvorssel)**
**[NuGet](https://www.nuget.org/packages/SushiScriptCore/1.0.0)**
---
## Features
- Converts .NET classes to script languages (typescript / ECMAScript)
- Compiled using **[.NET Standard 2.0](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0)**
- Supports native types, type inheritance, generics and enum types
- Adds documentation using the generated MS build XML file
- 95% Code coverage
---
## About
```
string xmlDocPath = Path.Combine(Environment.CurrentDirectory, "Sushi.tests.xml");
// Specify the types to convert using a Type[] or Assembly.ExportedTypes.
Assembly assembly = typeof(PersonViewModel).Assembly;
SushiConverter converter = new SushiConverter(assembly).UseDocumentation(xmlDocPath);
// Specify the script language and convert by invoking ToString().
ConverterOptions options = new ConverterOptions(excludeComments: true);
string result = converter.TypeScript(options).ToString();
```
Create a new `SushiConverter` instance with the given `Assembly` or `Type[]` that contain the types you want to convert.
These classes must be decorated with the `ConvertToScriptAttribute` or inherit the `IScriptModel` interface. Classes can be excluded using the `IgnoreForScriptAttribute`.
The converter contains a collection of type- and enum-descriptors. These are used to generate script models.
## Helpers
You can check if a type exists using:
`IsSushiType(IConvertModels converter, Type type, out Type resolvedType) : boolean`
You can convert types using:
`TypeScriptConverter.ResolveScriptType(Type type, string prefix = "") : string`
You can get the script default value using:
`TypeScriptConverter.ResolveDefaultValue(IPropertyDescriptor prop) : string`
## Conversion result
### C# class
```
///
/// Simple model to verify complex types.
///
public sealed class TypeModel : ViewModel
{
///
/// A nullable boolean.
///
public bool? NullableBool { get; set; } = null;
///
/// A nullable string, defaults to null.
///
public string? NullableString { get; set; } = null;
///
/// A readonly string.
///
public readonly string ReadonlyString = "readonly";
///
public new Guid Guid { get; set; } = Guid.NewGuid();
///
/// A DateTime instance.
///
public DateTime Date{get;set;} = DateTime.Now;
public StudentViewModel Student { get; set; } = new StudentViewModel();
public List Students { get; set; }
public Dictionary StudentPerClass { get; set; } = new ();
}
```
### Typescript class
```
/**
* Simple model to verify complex types.
* Sushi.Tests.Models.TypeModel
* @extends ViewModel
*/
export class TypeModel extends ViewModel {
/**
* A nullable boolean.
* @type (boolean | null)
*/
nullableBool: boolean | null = null;
/**
* A nullable string, defaults to null.
* @type (string | null)
*/
nullableString: string | null = null;
/**
* .
* @type (string)
*/
override guid: string = "f64db319-ebb2-4b6d-89f4-18abbb2604e7";
/**
* A DateTime instance.
* @type (Date | string | null)
*/
date!: Date | string | null;
student: StudentViewModel = new StudentViewModel();
students: Array = [];
studentPerClass: { [key: string]: Array } = {};
/**
* A readonly string.
* @type (string)
*/
static readonly readonlyString: string = "readonly";
constructor(value: Partial = {}) {
super(value);
if (value.nullableBool !== undefined) this.nullableBool = value.nullableBool;
if (value.nullableString !== undefined) this.nullableString = value.nullableString;
if (value.guid !== undefined) this.guid = value.guid;
if (value.date !== undefined) this.date = value.date;
if (value.student !== undefined) this.student = value.student;
if (value.students !== undefined) this.students = value.students;
if (value.studentPerClass !== undefined) this.studentPerClass = value.studentPerClass;
}
}
```