update readme

added nugets references in readme :)
fix nuget package for Generator assembly?
2025-11-07 13:34:51 -05:00 · 2025-11-07 13:01:24 -05:00 · 2025-11-07 12:48:00 -05:00
5 changed files with 132 additions and 132 deletions
--- a/.claude/settings.local.json
+++ b/.claude/settings.local.json
@ -32,7 +32,16 @@
      "Bash(lsof:*)",
      "Bash(xargs kill -9)",
      "Bash(dotnet run:*)",
-      "Bash(find:*)"
+      "Bash(find:*)",
+      "Bash(dotnet pack:*)",
+      "Bash(unzip:*)",
+      "WebFetch(domain:andrewlock.net)",
+      "WebFetch(domain:github.com)",
+      "WebFetch(domain:stackoverflow.com)",
+      "WebFetch(domain:www.kenmuse.com)",
+      "WebFetch(domain:blog.rsuter.com)",
+      "WebFetch(domain:natemcmaster.com)",
+      "WebFetch(domain:www.nuget.org)"
    ],
    "deny": [],
    "ask": []
--- a/README.md
+++ b/README.md
@ -12,10 +12,9 @@ Our implementation of query and command responsibility segregation (CQRS).
 |-----------------------------------------| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-----------------------------------------------------------------------:|
 | Svrnty.CQRS                         | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS/)             |                             ```dotnet add package Svrnty.CQRS ``` |
 | Svrnty.CQRS.MinimalApi              | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.MinimalApi.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS.MinimalApi/)             |                  ```dotnet add package Svrnty.CQRS.MinimalApi ``` |
-| Svrnty.CQRS.AspNetCore              | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.AspNetCore.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS.AspNetCore/)             |                  ```dotnet add package Svrnty.CQRS.AspNetCore ``` |
 | Svrnty.CQRS.FluentValidation        | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.FluentValidation.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS.FluentValidation/)          |            ```dotnet add package Svrnty.CQRS.FluentValidation ``` |
 | Svrnty.CQRS.DynamicQuery            | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.DynamicQuery.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS.DynamicQuery/)           |                ```dotnet add package Svrnty.CQRS.DynamicQuery ``` |
-| Svrnty.CQRS.DynamicQuery.AspNetCore | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.DynamicQuery.AspNetCore.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS.DynamicQuery.AspNetCore/)          |     ```dotnet add package Svrnty.CQRS.DynamicQuery.AspNetCore ``` |
+| Svrnty.CQRS.DynamicQuery.MinimalApi | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.DynamicQuery.MinimalApi.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS.DynamicQuery.MinimalApi/)          |     ```dotnet add package Svrnty.CQRS.DynamicQuery.MinimalApi ``` |
 | Svrnty.CQRS.Grpc                    | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.Grpc.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS.Grpc/)                    |                       ```dotnet add package Svrnty.CQRS.Grpc ``` |
 | Svrnty.CQRS.Grpc.Generators         | [![NuGet](https://img.shields.io/nuget/v/Svrnty.CQRS.Grpc.Generators.svg?style=flat-square&label=nuget)](https://www.nuget.org/packages/Svrnty.CQRS.Grpc.Generators/)          |        ```dotnet add package Svrnty.CQRS.Grpc.Generators ``` |

@ -31,28 +30,33 @@ Our implementation of query and command responsibility segregation (CQRS).
 ## Sample of startup code for gRPC (Recommended)

 ```csharp
+using Svrnty.CQRS;
+using Svrnty.CQRS.FluentValidation;
+using Svrnty.CQRS.Grpc;
+
 var builder = WebApplication.CreateBuilder(args);

-// Register CQRS core services
-builder.Services.AddSvrntyCQRS();
-builder.Services.AddDefaultCommandDiscovery();
-builder.Services.AddDefaultQueryDiscovery();
+// Register your commands with validators
+builder.Services.AddCommand<AddUserCommand, int, AddUserCommandHandler, AddUserCommandValidator>();
+builder.Services.AddCommand<RemoveUserCommand, RemoveUserCommandHandler>();

-// Add your commands and queries
-AddQueries(builder.Services);
-AddCommands(builder.Services);
+// Register your queries
+builder.Services.AddQuery<FetchUserQuery, User, FetchUserQueryHandler>();

-// Add gRPC support
-builder.Services.AddGrpc();
+// Configure CQRS with gRPC support
+builder.Services.AddSvrntyCqrs(cqrs =>
+{
+    // Enable gRPC endpoints with reflection
+    cqrs.AddGrpc(grpc =>
+    {
+        grpc.EnableReflection();
+    });
+});

 var app = builder.Build();

-// Map auto-generated gRPC service implementations
-app.MapGrpcService<CommandServiceImpl>();
-app.MapGrpcService<QueryServiceImpl>();
-
-// Enable gRPC reflection for tools like grpcurl
-app.MapGrpcReflectionService();
+// Map all configured CQRS endpoints
+app.UseSvrntyCqrs();

 app.Run();
 ```
@ -75,31 +79,9 @@ dotnet add package Grpc.StatusProto  # For Rich Error Model validation
 dotnet add package Svrnty.CQRS.Grpc.Generators
 ```

-The source generator is automatically configured as an analyzer when installed via NuGet and will generate the gRPC service implementations at compile time.
+The source generator is automatically configured as an analyzer when installed via NuGet and will generate both the `.proto` files and gRPC service implementations at compile time.

-#### 3. Define your proto files in `Protos/` directory:
-
-```protobuf
-syntax = "proto3";
-import "google/protobuf/empty.proto";
-
-service CommandService {
-  rpc AddUser(AddUserCommandRequest) returns (AddUserCommandResponse);
-  rpc RemoveUser(RemoveUserCommandRequest) returns (google.protobuf.Empty);
-}
-
-message AddUserCommandRequest {
-  string name = 1;
-  string email = 2;
-  int32 age = 3;
-}
-
-message AddUserCommandResponse {
-  int32 result = 1;
-}
-```
-
-#### 4. Define your C# commands matching the proto structure:
+#### 3. Define your C# commands and queries:

 ```csharp
 public record AddUserCommand
@ -116,28 +98,38 @@ public record RemoveUserCommand
 ```

 **Notes:**
- The source generator automatically creates `CommandServiceImpl` and `QueryServiceImpl` implementations
- Property names in C# commands must match proto field names (case-insensitive)
+- The source generator automatically creates:
+  - `.proto` files in the `Protos/` directory from your C# commands and queries
+  - `CommandServiceImpl` and `QueryServiceImpl` implementations
 - FluentValidation is automatically integrated with **Google Rich Error Model** for structured validation errors
 - Validation errors return `google.rpc.Status` with `BadRequest` containing `FieldViolations`
 - Use `record` types for commands/queries (immutable, value-based equality, more concise)
- No need for protobuf-net attributes
+- No need for protobuf-net attributes - just define your C# types

 ## Sample of startup code for Minimal API (HTTP)

 For HTTP scenarios (web browsers, public APIs), you can use the Minimal API approach:

 ```csharp
+using Svrnty.CQRS;
+using Svrnty.CQRS.FluentValidation;
+using Svrnty.CQRS.MinimalApi;
+
 var builder = WebApplication.CreateBuilder(args);

-// Register CQRS core services
-builder.Services.AddSvrntyCQRS();
-builder.Services.AddDefaultCommandDiscovery();
-builder.Services.AddDefaultQueryDiscovery();
+// Register your commands with validators
+builder.Services.AddCommand<CreatePersonCommand, CreatePersonCommandHandler, CreatePersonCommandValidator>();
+builder.Services.AddCommand<EchoCommand, string, EchoCommandHandler, EchoCommandValidator>();

-// Add your commands and queries
-AddQueries(builder.Services);
-AddCommands(builder.Services);
+// Register your queries
+builder.Services.AddQuery<PersonQuery, IQueryable<Person>, PersonQueryHandler>();
+
+// Configure CQRS with Minimal API support
+builder.Services.AddSvrntyCqrs(cqrs =>
+{
+    // Enable Minimal API endpoints
+    cqrs.AddMinimalApi();
+});

 // Add Swagger (optional)
 builder.Services.AddEndpointsApiExplorer();
@ -151,9 +143,8 @@ if (app.Environment.IsDevelopment())
    app.UseSwaggerUI();
 }

-// Map CQRS endpoints - automatically creates routes for all commands and queries
-app.MapSvrntyCommands();  // Creates POST /api/command/{commandName} endpoints
-app.MapSvrntyQueries();   // Creates POST/GET /api/query/{queryName} endpoints
+// Map all configured CQRS endpoints (automatically creates POST /api/command/* and POST/GET /api/query/*)
+app.UseSvrntyCqrs();

 app.Run();
 ```
@ -169,19 +160,32 @@ app.Run();
 You can enable both gRPC and traditional HTTP endpoints simultaneously, allowing clients to choose their preferred protocol:

 ```csharp
+using Svrnty.CQRS;
+using Svrnty.CQRS.FluentValidation;
+using Svrnty.CQRS.Grpc;
+using Svrnty.CQRS.MinimalApi;
+
 var builder = WebApplication.CreateBuilder(args);

-// Register CQRS core services
-builder.Services.AddSvrntyCQRS();
-builder.Services.AddDefaultCommandDiscovery();
-builder.Services.AddDefaultQueryDiscovery();
+// Register your commands with validators
+builder.Services.AddCommand<AddUserCommand, int, AddUserCommandHandler, AddUserCommandValidator>();
+builder.Services.AddCommand<RemoveUserCommand, RemoveUserCommandHandler>();

-// Add your commands and queries
-AddQueries(builder.Services);
-AddCommands(builder.Services);
+// Register your queries
+builder.Services.AddQuery<FetchUserQuery, User, FetchUserQueryHandler>();

-// Add gRPC support
-builder.Services.AddGrpc();
+// Configure CQRS with both gRPC and Minimal API support
+builder.Services.AddSvrntyCqrs(cqrs =>
+{
+    // Enable gRPC endpoints with reflection
+    cqrs.AddGrpc(grpc =>
+    {
+        grpc.EnableReflection();
+    });
+
+    // Enable Minimal API endpoints
+    cqrs.AddMinimalApi();
+});

 // Add HTTP support with Swagger
 builder.Services.AddEndpointsApiExplorer();
@ -195,14 +199,8 @@ if (app.Environment.IsDevelopment())
    app.UseSwaggerUI();
 }

-// Map gRPC endpoints
-app.MapGrpcService<CommandServiceImpl>();
-app.MapGrpcService<QueryServiceImpl>();
-app.MapGrpcReflectionService();
-
-// Map HTTP endpoints
-app.MapSvrntyCommands();
-app.MapSvrntyQueries();
+// Map all configured CQRS endpoints (both gRPC and HTTP)
+app.UseSvrntyCqrs();

 app.Run();
 ```
@ -214,47 +212,10 @@ app.Run();
 - Same commands, queries, and validation logic for both protocols
 - Swagger UI available for HTTP endpoints, gRPC reflection for gRPC clients

-> Example how to add your queries and commands.
-
-```csharp
-private void AddCommands(IServiceCollection services)
-{
-    services.AddCommand<CreatePersonCommand, CreatePersonCommandHandler>();
-    services.AddTransient<IValidator<CreatePersonCommand>, CreatePersonCommandValidator>();
-
-    services.AddCommand<EchoCommand, string, EchoCommandHandler>();
-    services.AddTransient<IValidator<EchoCommand>, EchoCommandValidator>();
-}
-
-private void AddQueries(IServiceCollection services)
-{
-    services.AddQuery<PersonQuery, IQueryable<Person>, PersonQueryHandler>();
-}
-```
-
 # Fluent Validation

 FluentValidation is optional but recommended for command and query validation. The `Svrnty.CQRS.FluentValidation` package provides extension methods to simplify validator registration.

-## Without Svrnty.CQRS.FluentValidation
-
-You need to register commands and validators separately:
-
-```csharp
-using Microsoft.Extensions.DependencyInjection;
-using FluentValidation;
-using Svrnty.CQRS;
-
-private void AddCommands(IServiceCollection services)
-{
-    // Register command handler
-    services.AddCommand<EchoCommand, string, EchoCommandHandler>();
-
-    // Manually register validator
-    services.AddTransient<IValidator<EchoCommand>, EchoCommandValidator>();
-}
-```
-
 ## With Svrnty.CQRS.FluentValidation (Recommended)

 The package exposes extension method overloads that accept the validator as a generic parameter:
@ -264,17 +225,13 @@ dotnet add package Svrnty.CQRS.FluentValidation
 ```

 ```csharp
-using Microsoft.Extensions.DependencyInjection;
 using Svrnty.CQRS.FluentValidation; // Extension methods for validator registration

-private void AddCommands(IServiceCollection services)
-{
-    // Command without result - validator included in generics
-    services.AddCommand<EchoCommand, string, EchoCommandHandler, EchoCommandValidator>();
+// Command with result - validator as last generic parameter
+builder.Services.AddCommand<EchoCommand, string, EchoCommandHandler, EchoCommandValidator>();

-    // Command with result - validator as last generic parameter
-    services.AddCommand<CreatePersonCommand, CreatePersonCommandHandler, CreatePersonCommandValidator>();
-}
+// Command without result - validator included in generics
+builder.Services.AddCommand<CreatePersonCommand, CreatePersonCommandHandler, CreatePersonCommandValidator>();
 ```

 **Benefits:**
@ -283,6 +240,21 @@ private void AddCommands(IServiceCollection services)
 - **Less boilerplate** - No need for separate `AddTransient<IValidator<T>>()` calls
 - **Cleaner code** - Clear intent that validation is part of command pipeline

+## Without Svrnty.CQRS.FluentValidation
+
+If you prefer not to use the FluentValidation package, you need to register commands and validators separately:
+
+```csharp
+using FluentValidation;
+using Svrnty.CQRS;
+
+// Register command handler
+builder.Services.AddCommand<EchoCommand, string, EchoCommandHandler>();
+
+// Manually register validator
+builder.Services.AddTransient<IValidator<EchoCommand>, EchoCommandValidator>();
+```
+
 # 2024-2025 Roadmap

 | Task                                                                             | Description                                                                                          | Status |
--- a/Svrnty.CQRS.Grpc.Generators/Svrnty.CQRS.Grpc.Generators.csproj
+++ b/Svrnty.CQRS.Grpc.Generators/Svrnty.CQRS.Grpc.Generators.csproj
@ -7,7 +7,10 @@
    <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
    <IsPackable>true</IsPackable>
    <DevelopmentDependency>true</DevelopmentDependency>
+    <!-- Don't include build output in lib/ - this is an analyzer/generator package -->
    <IncludeBuildOutput>false</IncludeBuildOutput>
+    <NoPackageAnalysis>true</NoPackageAnalysis>
+    <NoWarn>$(NoWarn);NU5128</NoWarn>
    <SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>

    <Company>Svrnty</Company>
@ -20,11 +23,8 @@
    <PackageLicenseExpression>MIT</PackageLicenseExpression>
    <Description>Source Generator for Svrnty.CQRS.Grpc - generates .proto files and gRPC service implementations from commands and queries</Description>

-    <DebugType>portable</DebugType>
-    <DebugSymbols>true</DebugSymbols>
-    <IncludeSymbols>true</IncludeSymbols>
-    <IncludeSource>true</IncludeSource>
-    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <!-- Disable symbol packages for analyzer/generator packages (prevents NU5017 error) -->
+    <IncludeSymbols>false</IncludeSymbols>
  </PropertyGroup>

  <ItemGroup>
@ -39,11 +39,24 @@
  </ItemGroup>

  <ItemGroup>
-    <!-- Package as analyzer -->
-    <None Include="$(OutputPath)\$(AssemblyName).dll" Pack="true" PackagePath="analyzers/dotnet/cs" Visible="false" />
-
-    <!-- Also package as build task -->
-    <None Include="$(OutputPath)\$(AssemblyName).dll" Pack="true" PackagePath="build" Visible="false" />
+    <!-- Include targets and props files in both build and buildTransitive for proper dependency flow -->
    <None Include="build\Svrnty.CQRS.Grpc.Generators.targets" Pack="true" PackagePath="build" />
+    <None Include="build\Svrnty.CQRS.Grpc.Generators.targets" Pack="true" PackagePath="buildTransitive" />
+    <None Include="build\Svrnty.CQRS.Grpc.Generators.props" Pack="true" PackagePath="build" />
+    <None Include="build\Svrnty.CQRS.Grpc.Generators.props" Pack="true" PackagePath="buildTransitive" />
  </ItemGroup>
+
+  <!-- Use the recommended pattern to include the generator DLL in the package -->
+  <PropertyGroup>
+    <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);IncludeGeneratorAssemblyInPackage</TargetsForTfmSpecificContentInPackage>
+  </PropertyGroup>
+
+  <Target Name="IncludeGeneratorAssemblyInPackage">
+    <ItemGroup>
+      <!-- Include in analyzers folder for Roslyn source generator -->
+      <TfmSpecificPackageFile Include="$(OutputPath)$(AssemblyName).dll" PackagePath="analyzers/dotnet/cs" />
+      <!-- Include in build folder for MSBuild task (WriteProtoFileTask) -->
+      <TfmSpecificPackageFile Include="$(OutputPath)$(AssemblyName).dll" PackagePath="build" />
+    </ItemGroup>
+  </Target>
 </Project>
--- a/Svrnty.CQRS.Grpc.Generators/build/Svrnty.CQRS.Grpc.Generators.props
+++ b/Svrnty.CQRS.Grpc.Generators/build/Svrnty.CQRS.Grpc.Generators.props
@ -0,0 +1,6 @@
+<Project>
+  <PropertyGroup>
+    <!-- Marker to indicate Svrnty.CQRS.Grpc.Generators is referenced -->
+    <SvrntyCqrsGrpcGeneratorsVersion>$(SvrntyCqrsGrpcGeneratorsVersion)</SvrntyCqrsGrpcGeneratorsVersion>
+  </PropertyGroup>
+</Project>
--- a/Svrnty.Sample/Program.cs
+++ b/Svrnty.Sample/Program.cs
@ -24,14 +24,14 @@ builder.Services.AddTransient<PoweredSoft.Data.Core.IAsyncQueryableService, Simp
 builder.Services.AddTransient<PoweredSoft.DynamicQuery.Core.IQueryHandlerAsync, PoweredSoft.DynamicQuery.QueryHandlerAsync>();
 builder.Services.AddDynamicQueryWithProvider<User, UserQueryableProvider>();

+// Register commands and queries with validators
+builder.Services.AddCommand<AddUserCommand, int, AddUserCommandHandler, AddUserCommandValidator>();
+builder.Services.AddCommand<RemoveUserCommand, RemoveUserCommandHandler>();
+builder.Services.AddQuery<FetchUserQuery, User, FetchUserQueryHandler>();
+
 // Configure CQRS with fluent API
 builder.Services.AddSvrntyCqrs(cqrs =>
 {
-    // Register commands and queries with validators
-    cqrs.AddCommand<AddUserCommand, int, AddUserCommandHandler, AddUserCommandValidator>();
-    cqrs.AddCommand<RemoveUserCommand, RemoveUserCommandHandler>();
-    cqrs.AddQuery<FetchUserQuery, User, FetchUserQueryHandler>();
-
    // Enable gRPC endpoints with reflection
    cqrs.AddGrpc(grpc =>
    {
Author	SHA1	Message	Date
Mathias Beaulieu-Duncan	e72cbe4319	update readme	2025-11-07 13:34:51 -05:00
Mathias Beaulieu-Duncan	467e700885	added nugets references in readme :)	2025-11-07 13:01:24 -05:00
Mathias Beaulieu-Duncan	898aca0905	fix nuget package for Generator assembly? All checks were successful Publish NuGets / build (release) Successful in 46s Details	2025-11-07 12:48:00 -05:00