ncguilbeault/sgen

Tool for automatically generating YML serialization classes from schema files

sgen

Tool for automatically generating YML serialization classes from schema files

Getting Started

1. Navigate to the Bonsai.Sgen toolbox NuGet 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 --version 0.1.0

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

   dotnet bonsai.sgen --help

4. To generate serialization classes from a schema file:

   dotnet bonsai.sgen --schema schema.json

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

6. Add the necessary package references to your Extensions.csproj file. For instance:

   <ItemGroup>
       <PackageReference Include="Bonsai.Core" Version="2.8.0" />
       <PackageReference Include="YamlDotNet" Version="12.0.2" />
   </ItemGroup>
   </Project>

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

   dotnet tool restore