Substantive.ComponentModel.SourceGenerators

Incremental Roslyn generators that implement common metadata interfaces in the Substantive.ComponentModel stack. Each generator discovers partial classes or records annotated with a matching attribute and injects the interface implementation so you avoid repetitive boilerplate when modeling domain, data-transfer, or view models.

Included generators

All generators share the same discovery rules:

• Targets must be partial classes or records.
• Apply the corresponding attribute from Substantive.ComponentModel.
• Add [IgnoreSourceGen] (or derive from IgnoreSourceGenAttribute) to opt out on a specific type.

Getting started

1. Reference the analyzer NuGet in the consuming project (the generator compiles for netstandard2.0, so it works on .NET Framework, .NET Core, .NET, and Xamarin/MAUI targets).

   <PackageReference Include="Substantive.ComponentModel.SourceGenerators" PrivateAssets="all" />
   <PackageReference Include="Substantive.ComponentModel" />
   

2. Mark eligible models as partial and decorate them with the metadata attributes you need.
3. Build the project; the generator runs at compile time and emits the interface members into *.g.cs artifacts under obj/.

Usage example

using Substantive.ComponentModel;

[SoftDeleteMetadata]
[TimestampMetadata]
[SchemaVersionMetadata]
public partial record CaseFile
{
    public Guid Id { get; init; }
    public string Title { get; init; }
}

After compilation the partial record implements ISoftDeleteMetadata, ITimestampMetadata, and ISchemaVersionMetadata, so you can inject CaseFile into services that expect those contracts without hand-writing the repetitive properties.

Build, pack, and test

• dotnet build src/BuildingBlocks/ComponentModel.SourceGenerators/ComponentModel.SourceGenerators.csproj compiles analyzers and verifies Roslyn APIs.
• dotnet pack ... -c Release produces a NuGet package that already includes readme.md and icon.png.
• Add CI steps to copy the produced Substantive.ComponentModel.SourceGenerators.dll into analyzers/dotnet/cs/ inside the nupkg (the project file already configures this).

Troubleshooting

• Ensure consumers use the same version of Substantive.ComponentModel so the attribute namespaces match the generator expectations.
• Keep model files nullable-enabled; the generated members respect the project-wide nullable context.
• If you modify the attributes or interfaces, update the generator constants (InterfaceTypeName / FullyQualifiedAttributeName) to keep them synchronized.