ModulusKit.Generators 4.0.0

ModulusKit.Generators

Roslyn incremental source generators for Modulus -- strongly typed IDs, handler registration, and module auto-discovery.

Installation

dotnet add package ModulusKit.Generators

Or as an analyzer reference in your .csproj:

<PackageReference Include="ModulusKit.Generators"
                  OutputItemType="Analyzer"
                  ReferenceOutputAssembly="false" />

Note: This is a development-dependency (analyzer) package -- it does not flow transitively through other ModulusKit.* packages or through project references. Add the reference above to every project that defines handlers, validators, or [StronglyTypedId] types (and to the host, for module discovery). Solutions scaffolded by the modulus CLI have this wired up already.

Strongly Typed IDs

Generate type-safe entity identifiers with EF Core, JSON (including dictionary-key support), route/query binding, and comparison support:

using Modulus.Mediator.Abstractions;

[StronglyTypedId]
public readonly partial record struct OrderId;

[StronglyTypedId(typeof(int))]
public readonly partial record struct SequenceNumber;

[StronglyTypedId(typeof(string))]
public readonly partial record struct TenantId;

The generator produces: Value property, constructor, New() factory (Guid only), Empty, IComparable<T>, IParsable<T>/Parse/TryParse (minimal API route/query parameter binding), plus ValueConverter (EF Core), JsonConverter (System.Text.Json — including ReadAsPropertyName/WriteAsPropertyName for use as a Dictionary<TId, TValue> key), and TypeConverter (MVC model binding).

Supported backing types: Guid (default), int, long, string.

Bulk EF Core registration

When the compilation references EF Core, the generator also emits ModulusStronglyTypedIdConventions.UseModulusStronglyTypedIds(this ModelConfigurationBuilder) — one call from DbContext.ConfigureConventions that registers every discovered ID's ValueConverter (local declarations plus public ones from referenced assemblies that were themselves built with an EF Core reference):

protected override void ConfigureConventions(ModelConfigurationBuilder configurationBuilder)
    => configurationBuilder.UseModulusStronglyTypedIds();

Handler Registration

Auto-register all handlers and validators at compile time:

// Source-generated extension method
services.AddModulusHandlers();

Discovers: ICommandHandler<>, IQueryHandler<>, IStreamQueryHandler<>, IDomainEventHandler<>, IIntegrationEventHandler<>, and AbstractValidator<>.

Module Auto-Discovery

Auto-discover all IModuleRegistration implementations from referenced assemblies:

// Source-generated extension methods
builder.Services.AddAllModules(builder.Configuration);
app.MapAllModuleEndpoints();

Control initialization order with [ModuleOrder(n)].

Diagnostics

Learn More

See the Modulus documentation for full generator reference.