Skip to content

README.md

Latest commit

 

History

History
88 lines (76 loc) · 3.16 KB

README.md

File metadata and controls

88 lines (76 loc) · 3.16 KB

Net2TypeScript

.NET tool to generate TypeScript interfaces/enums from .NET assembly classes/interfaces/enums

.NET tool command

Description:
  .NET tool to create TypeScript types/models from .NET models

Usage:
  net2typescript [options]

Avaliable options

Options:
  -s|--settings         Path to JSON settings file that uses the settings "$schema" (see
                        schema URL below). If argument is omitted, the settings file is expected
                        to be found in the same folder as the Net2TypeScript executable with the
                        file name "settings.json".

  -c|--configuration    The build configuration (e.g. 'Release'/'Debug').
                        Emitting this parameter, enables interpolation of $(BuildConfiguration)
                        variables in the JSON settings file's path properties.
                        This is particularily useful when you want to pick assembly files from
                        different folders dynamically for different build configurations.
                        Defaults to 'Debug' when argument is omitted.

  -t|--targetframework  The target framework (e.g. 'net9.0').
                        Emitting this parameter, enables interpolation of $(TargetFramework)
                        variables in the JSON settings file's path properties.
                        This is particularily useful when you want to pick assembly files from
                        different folders dynamically for different target frameworks.

  --*                   All global properties (of "primitive" value types) in the settings file
                        schema can be set or overriden using command line arguments as an
                        alternative to using the settings file.

  -h|--help             Show this help information.

JSON schema for settings file:
https://raw.githubusercontent.com/josundt/Net2TypeScript/master/Net2TypeScript/settings.schema.json```

Sample settings file

{
  "$schema": "https://raw.githubusercontent.com/josundt/Net2TypeScript/master/Net2TypeScript/settings.schema.json",
  "assemblyPaths": [
    "./bin/$(BuildConfiguration)/net6.0/My.App.Models.dll",
    "../My.App.ApiModels/bin/$(BuildConfiguration)/netstandard2.0/My.App.ApiModels.dll"
  ],
  "outputPath": "../My.App.Spa/src/models/models.ts",
  "dotNetRootNamespace": "My.App",
  "tsRootNamespace": null,
  "tsFlattenNamespaces": true,
  "classNamespaceFilter": [
    "My.App.Models*",
    "My.App.ApiModels*"
  ],
  "enumNamespaceFilter": [
    "My.App.Models*",
    "My.App.ApiModels*"
  ],
  "indent": "    ",
  "enumType": "stringIfNotFlagEnum",
  "enumFormat": "unionType",
  "camelCase": true,
  "excludeClass": false,
  "excludeInterface": true,
  "nullableReferenceTypes": true,
  "nullableProps": "optional",
  "namespaceOverrides": {
    "My.App.ApiModels*": {
      "nullableReferenceTypes": false
    }
  },
  "classOverrides": {
    "My.App.ApiModels.PersonLocation": {
      "extraProperties": {
        "location": "import(\"./geography-point.js\").IGeographyPoint"
      }
    }
  }
}