adrianwilczynski/csharptotypescript

Convert C# Models, ViewModels and DTOs into their TypeScript equivalents using webapps, CLI Tool or VSCode extension. Links: https://marketplace.visualstudio.com/items?itemName=adrianwilczynski.csharp-to-typescript - https://csharptotypescript.azurewebsites.net - https://adrianwilczynski.github.io/CSharpToTypeScript/ - https://www.nuget.org/packages/CSharpToTypeScript.CLITool/

csharptotypescript's Issues

Add an advertisement/donate button to csharptotypescript.azurewebsites.net

Hey just wanted to let you know that my team and I use your website consistently and I recommend adding an ad or donate button

Thanks for the great free tool, you have really made our lives a lot easier!

Option to add suffix for the interface names

Would it make sense to add an option --interface-name-suffix <string> to allow modification of the interface's name?

Example: Suppose we have a C# class called ExampleClass. I would like to generate an interface with the name ExampleClassInterface. This could be achieved with the option --interface-name-suffix Interface.

Use case: Later I can easily create a TypeScript class ExampleClass that implements ExampleClassInterface. This I could not do, if the interface itself is already called ExampleClass, or I would need to do something like this:

import {ExampleClass as ExampleClassInterface} from "bla";

It could also be the option --interface-name-prefix I to generate IExampleClass.

Option for no semicolons?

Would you consider adding in a config option to have no semicolons on the output typescript?

Thanks, Carl

TSX support?

Hello,

Is there any plan to support TSX (.tsx) files? TSX is very commonly used in react environments.

Right now the extension is not running for that filetype.

how to convert to lowerCamelCase

I want my typescript properties are lowerCamelCase, How to change the settings?

Use Map in JS/TS for Dictionary in C#

https://www.javatpoint.com/typescript-map
Example here

Some Chinese characters trigger error

One example to reproduce the issue is the following:

public class FundWithdrawModel  {
	[DisplayName("手續費")]
	public decimal Fee { get; set; }
}

The character "費" here somehow leads to an error converting. Removing it solves the problem.

Preserve comments

It'd be great to preserve comments which we typically add near field declaration. This way typescript files will have the same documentation.

Does not work when "required" keyword is used in property declarations in class

Example:

    public class ExchangeOverflowCompletedResponse
    {
        public required long OverflowId { get; set; }
        public required Resource Resource { get; set; }
        public required double Quantity { get; set; }
        public required double Fee { get; set; }
    }

Converts to:

export interface ExchangeOverflowCompletedResponse {
    resource: required;
}

Const strings are not converted

We have C# files that define what looks like dictionaries?

That is, it has code like this:

public class Foo {
  public const string AConstant = "A string constant";
  public const string AnotherConstant = "Another string constant";
}

This was converted by the plugin to a structure like this:

export interface Foo {
  aConstant: string;
  anotherConstant: string;
}

So, for one, I'm not sure how it is useful to convert the casing. In my case, I'm converting Razor templates into Vue ones, and they have bindings into these constants, so it's a matter of converting '@Foo.AnotherConstant' to Foo.AnotherConstant, but the casing conversion would make that impossible.

Secondly, of course, the values are missing. I don't understand this kind of conversion because TypeScript has classes, and classes can be used as interfaces, so why isn't the output just:

export class Foo {
  static AConstant = "A string constant";
  static AnotherConstant = "Another string constant";
}

That would be a direct representation of the class.

Types not converted correctly

C#

namespace Business.Models
{
    using System;

    public partial class DealerLender
    {
        public long DealerLenderID { get; set; }
        public string ProgramCode { get; set; }
        public string DealerCode { get; set; }
        public string Name { get; set; }
        public string Address1 { get; set; }
        public string Address2 { get; set; }
        public string City { get; set; }
        public string StateAbbreviation { get; set; }
        public string ZipCode { get; set; }
        public string PhoneNumber { get; set; }
        public System.DateTime CreateDate { get; set; }
        public System.DateTime UpdateDate { get; set; }
        public Nullable<bool> IsGenericLender { get; set; }
        public Nullable<bool> IsMBPFinanceLender { get; set; }
    }
}

converts to

interface DealerLender {
    dealerLenderID: number;
    programCode: string;
    dealerCode: string;
    name: string;
    address1: string;
    address2: string;
    city: string;
    stateAbbreviation: string;
    zipCode: string;
    phoneNumber: string;
    createDate: string;
    updateDate: string;
    isGenericLender: Nullable<boolean>;
    isMBPFinanceLender: Nullable<boolean>;
}

Anyway we can convert System.DateTime to a Date?
Also nulls should be converted to one of the following:

isGenericLender?: boolean;
isGenericLender: boolean | null;

I'm willing to help as I just found this and we are trying to keep c# and typescript models in sync during our ci/cd pipeline or build process.

Using variable name as TypeScript comment

I don't know if that would be a complicated feature to add (I'll be glad to help but I know nothing about Extension's programming).

My idea would be to add Variables name as a comment name in TypeScript (so it can be viewed with Intellisense), and it could be toggled from extension's preference.

Simple Example :

Indicator.cs

    public class Indicator
    {
        [JsonProperty("n")]
        public string Name { get; set; }
    }

Indicator.ts

export interface Indicator {
    /** Name */
    n: string;
}

String enums for the command line interface

Hey Adrian,

Great package.

Any chance we could have a string Enum option for the command line? I tried just to set it with stringEnums: true but it did not seem to work.

Thanks!

support record types

hi
I want to convert record type but dont get any result

summary tag support

Our c# classes usually add summary tag recognition, and additional tag recognition will make our classes more readable

Fixed string to constant

First of all, thanks for the work put in here 🎉

Just one nuance I came to notice when I wanted to use it in my project: In my codebase in C# I have two types (tracks and albums) which both can be in a list (as IDocuments). Both have the property type on which they both have a fixed name.

By this I can have a union-type in typescript but am able to determine by the property type which of them I have at hand, and the typescript compiler will narrow down the type. This is not possible if I want to use this repo to convert my C# classes to typescript, because it translates the property type to string.

Input

public interface IDocument : IDocument<int>
{ }

public interface IDocument<T>
{
    T Id { get; set; }

    string Type { get; }
}

public class Album : IDocument
{
    public static string TypeName = "album";

    public int Id { get; set; }

    public IEnumerable<Track> Tracks { get; set; }

    public string Type => TypeName;
}

public class Track : IDocument
{
    public static string TypeName = "track";

    public int Id { get; set; }

    public int Length { get; set; }

   public string Type => TypeName;
}

Current output

export interface Document extends Document<number> {

}

export interface Document<T> {
    id: T;
    type: string;
}

export interface Album {
    id: number;
    tracks: Track[];
    type: string;
}

export interface Track {
    id: number;
    length: number;
    type: string;
}

Expected output

export interface Document extends Document<number> {

}

export interface Document<T> {
    id: T;
    type: string;
}

export interface Album {
    id: number;
    tracks: Track[];
    type: "album";
}

export interface Track {
    id: number;
    length: number;
    type: "track";
}

By the expected output, this typescript code would be valid:

(foo: Album | Track) => {
    if (foo.type === "track") {
        foo.length
    }
};

CLI tool improperly recognizing directories

When attempting to use command line tool on a directory with a . in the final folder level, the input is incorrectly assumed to be a file. For instance, C:/A.Directory is assumed to be a file, even if it's a folder name.

The root cause is a result of using a regex to determine filenames at:

CSharpToTypeScript/src/CSharpToTypeScript.CLITool/Utilities/FileSystem.cs

Lines 18 to 19 in f36b19e

	public static bool EndsWithFileExtension(this string text)
	=> Regex.IsMatch(text, @"\.\w+$");

I'd propose ditching the use of that extension method and just checking both file/directory existence at the same time.

So change the existing:

CSharpToTypeScript/src/CSharpToTypeScript.CLITool/Validation/InputExists.cs

Lines 20 to 27 in f36b19e

	else if (command.Input.EndsWithFileExtension() && !File.Exists(command.Input))
	{
	return new ValidationResult($"The file path '{command.Input}' does not exist.");
	}
	else if (!command.Input.EndsWithFileExtension() && !Directory.Exists(command.Input))
	{
	return new ValidationResult($"The directory path '{command.Input}' does not exist.");
	}

to simply:

else if (!File.Exists(command.Input) && !Directory.Exists(command.Input))
{
    return new ValidationResult($"The file or directory path '{command.Input}' does not exist.");
}

Might resolve #44?

Uri not converted correctly

C#

public Uri Url { get; set; }

converts to

url: Uri;

but should converts to

url: string;

I have dared to do a pull request but I am not sure I have done everything right.

Nullable for non-primitive fields

Since non-primitives in C# are nullable, would it make sense if all the transformed non-primitive fields in the TypeScript interfaces also get nullable?

Example: Suppose we have a C# class ExampleClass with one field a of type NestedClass. Then the transformed TypeScript interface could automatically be:

export interface ExampleClass {
a: NestedClass | null;
}

instead of

export interface ExampleClass {
a: NestedClass;
}

Property Name Not Match CamelCase

According to the camel case rule
The camel case of ABCdefg should be abCdefg not aBCdefg

Support dotnet 5

Hi,
I'm trying to install CLI Tool for net5.0 project, but I'm getting compatibility error.

Restoring packages for .NETCoreApp,Version=v5.0...
Resolving conflicts for net5.0...
Checking compatibility of packages on net5.0.
Checking compatibility for shared-enum 1.0.0 with net5.0.
Checking compatibility for CSharpToTypeScript.CLITool 2.5.1 with net5.0.
Package CSharpToTypeScript.CLITool 2.5.1 is not compatible with net5.0 (.NETCoreApp,Version=v5.0). Package CSharpToTypeScript.CLITool 2.5.1 supports: netcoreapp2.2 (.NETCoreApp,Version=v2.2) / any
Invalid project-package combination for CSharpToTypeScript.CLITool 2.5.1. DotnetToolReference project style can only contain references of the DotnetTool type 
Incompatible packages: 2
Package 'CSharpToTypeScript.CLITool 2.5.1' has a package type 'DotnetTool' that is not supported by project 'shared-enum'.

Is it possible to add support for net5.0?
I'm working on converting backend enums and interfaces to TypeScript files. We're going to automate it and add it to the build pipeline in order to keep interfaces and enums the same on both sides.

DateOnly not converting to string

public class Sample
{
  public DateTime DT { get; set; }
  public DateOnly DO { get; set; }
}

converts to

export interface Sample {
  dT: string;
  dO: DateOnly;
}

I would expect it DateOnly to convert to a string just like DateTime

"C# to TypeScript" server related error occurred: "spawn dotnet ENOENT".

I am new to C#, coming from TypeScript/Node.js land. I installed the VSCode extension but it is saying that error:

Do I need to install anything else to get this running? I am going to try brew install --cask dotnet, but not sure.

Is there a possibility to change the outputtype to type instead of interface?

I didnt find a possibility to change the output in ts to "type" instead of "interface". We use "type" in our project. So it would help if there was an option to select "type" and not only "class" and "interface"

Generate one class/interface/enum per file

Hi @AdrianWilczynski ,
the VS Code extension and CLI tools are great, very helpful and already saved me a lot of time 😉 Thanks for your great job!

However, I have some issue and want to ask you first, maybe you know something about that. I see that normally if I have few classes/interfaces/enums in a single C# file, cs2ts generates a single file with all these objects from C# file. However, in some cases from a single .cs file I have 2 .ts files generated - both with the same content (2 interfaces inside).

I'm also using import-generation = Simple. The issue is that sometimes few classes are defined in a single .cs file, but are needed in other .cs files (multiple), so the default naming convention for imports generation doesn't work properly.

What I'd like to achieve is that cs2ts generates a separate .ts file for each class/interface/enum it finds in the source .cs file. Do you know if this is somehow already supported?
If not, where should I look in the source code to contribute and add such a feature?

Thanks a lot for answering 😉

[feature request] output file name begin with capital letter

Can you please add an option for output file name. It begins with lower case, and I want the file name begins with capital letter.

Thank you!

Option to add custom type mapping

I have a C# class with a property of type IFormFile and I would like to have CSharpToTypeScript transform this property to the type of a TypeScript File.

I suggest adding the option to add custom mapping rules (similar to Dates), e.g.

--addCustomMapping IFormFile File

Being able to have multiple directories/files

Is there an option to enable convert methods？

Is there an option to enable convert methods？Only classes and properties can be converted, methods cannot be converted.