Code Generation Overview¶
One of the primary functions of Coalesce is as a code generation framework. Below, you find an overview of the different components of Coalesce's code generation features.
Coalesce's code generation is ran via a dotnet CLI tool,
dotnet coalesce. In order to invoke this tool, you must have the appropriate references to the package that provides it in your .csproj file:
<Project Sdk="Microsoft.NET.Sdk.Web"> ... <ItemGroup> <PackageReference Include="IntelliTect.Coalesce" Version="..." /> </ItemGroup> <ItemGroup> <DotNetCliToolReference Include="IntelliTect.Coalesce.Tools" Version="..." /> </ItemGroup> </Project>
All configuration of the way that Coalesce interacts with your projects, including locating, analyzing, and producing generated code, is done in a json configuration file,
coalesce.json. Read more about this file at Code Generation Configuration.
There are a couple of extra options which are only available as CLI parameters to
dotnet coalesce. These options do not affect the behavior of the code generation - only the behavior of the CLI itself.
- When this flag is specified when running
dotnet coalesce, Coalesce will wait for a debugger to be attached to its process before starting code generation.
- Set the verbosity of the output. Options are
Coalesce has the option of two front-end stacks - either Knockout, or Vue. The Vue-based stack is the current focus of all development efforts against Coalesce going forward - the Knockout stack is effectively in maintenance-only mode.
For either stack, Coalesce will generate a variety of different kinds of code for you:
- API Controllers
For each of your Entity Models, Custom DTOs, and Services, an API controller is created in the
/Api/Generateddirectory of your web project. These controllers provide a number of endpoints for interacting with your data.
- C# DTOs
For each of your Entity Models, a C# DTO class is created. These classes are used to hold the data that will be serialized and sent to the client, as well as data that has been received from the client before it has been mapped back to your EF POCO class.
See Generated C# DTOs for more information.