👁 Image
Bonsai.Sgen 0.5.0

Serializer Generator Tool

Tool for automatically generating YAML / JSON serialization classes and constructor operators from schema files.

Getting Started

1. Navigate to the Bonsai.Sgen NuGet tool package

2. Click .NET CLI (Local) and copy the two suggested commands. E.g.:

   dotnet new tool-manifest # if you are setting up this repo
   dotnet tool install --local Bonsai.Sgen
   

3. To view the tool help reference documentation, run:

   dotnet bonsai.sgen --help
   

4. To generate YAML serialization classes from a schema file:

   dotnet bonsai.sgen --schema schema.json --serializer YamlDotNet
   

5. To generate JSON serialization classes from a schema file:

   dotnet bonsai.sgen --schema schema.json --serializer NewtonsoftJson
   

6. Copy the generated class file to your project Extensions folder.

7. Add the necessary package references to your Extensions.csproj file. For example:

   <ItemGroup>
    <PackageReference Include="Bonsai.Core" Version="2.8.5" />
    <PackageReference Include="YamlDotNet" Version="13.7.1" />
   </ItemGroup>
   

8. To restore the tool at any point, run:

   dotnet tool restore