Skip to content

Commit

Permalink
un-expected changes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Joe Duffin authored and Joe Duffin committed Jun 30, 2021
1 parent e1464a3 commit bd5c7fc
Showing 1 changed file with 52 additions and 53 deletions.
105 changes: 52 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Then in .csproj add a Target.

## Options

_WorkingDirectory_ is the input directory of the c# dtos. (seperate multiple directories with ';')
_WorkingDirectory_ is the input directory of the c# dtos (seperate multiple directories with ';')

_ConvertDirectory_ is the output directory of the ts interfaces

Expand Down Expand Up @@ -55,7 +55,7 @@ using Example.Resources.Parts.Unit;

namespace Example.Resources.Vehicles
{
public abstract class Vehicle : Entity
public abstract class Vehicle : Entity
{
public int Year { get; set; }
public string Make { get; set; }
Expand All @@ -80,71 +80,70 @@ import { VehicleState } from "./vehicleState";
import { Part } from "./../Parts/part";

export interface Vehicle extends Entity {
year: number;
make: string;
model: string;
mileage?: number;
options: Partial<Record<string, Units>>;
condition: VehicleState;
parts: Part[];
spareParts: Part[];
year: number;
make: string;
model: string;
mileage?: number;
options: Partial<Record<string, Units>>;
condition: VehicleState;
parts: Part[];
spareParts: Part[];
}

```

## Types

It correctly converts the following C# types to the equivalent typescript:

- bool
- byte
- decimal
- double
- float
- int
- uint
- long
- sbyte
- short
- string
- ulong
- ushort
- Boolean
- Byte
- Char
- DateTime
- Decimal
- Double
- Int16
- Int32
- Int64
- SByte
- UInt16
- UInt32
- UInt64
- Array
- Collection
- Enumerbale
- IEnumerable
- ICollection
- IList
- Enum
- Optional
- virtual
- abstract
- Dictionary
- IDictionary
- Guid
* bool
* byte
* decimal
* double
* float
* int
* uint
* long
* sbyte
* short
* string
* ulong
* ushort
* Boolean
* Byte
* Char
* DateTime
* Decimal
* Double
* Int16
* Int32
* Int64
* SByte
* UInt16
* UInt32
* UInt64
* Array
* Collection
* Enumerbale
* IEnumerable
* ICollection
* IList
* Enum
* Optional
* virtual
* abstract
* Dictionary
* IDictionary
* Guid

## Notes

**If a _Convert Directory_ is supplied, it will be deleted everytime script is ran and will be remade**

**If a _Working Directory_ is supplied along with a list of _Working Directories_ they will all be considered for conversion**

Comments like `//` are ignored in c# files. Comments like `/* */` could cause undefined behavior.
Comments like `//` are ignored in c# files. Comments like `/* */` could cause undefined behavior.

Tested on Windows 10, macOS Big Sur, and Ubuntu 18.04

Follows the case and naming conventions of each language.

Thanks to natemcmaster [this project](https://github.com/natemcmaster/msbuild-tasks) really helped me out!
Thanks to natemcmaster [this project](https://github.com/natemcmaster/msbuild-tasks) really helped me out!

0 comments on commit bd5c7fc

Please sign in to comment.