Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/armandj77-zz/cqrsandmediator-scaffolding
A dotnet CLI code scaffolding tool for domains that implement CQRS and Mediator Patterns
https://github.com/armandj77-zz/cqrsandmediator-scaffolding
blog-article cqrs-pattern dotnetcore31 mediator-pattern mediatr medium-article nuget-package roslyn scaffold-template
Last synced: about 2 months ago
JSON representation
A dotnet CLI code scaffolding tool for domains that implement CQRS and Mediator Patterns
- Host: GitHub
- URL: https://github.com/armandj77-zz/cqrsandmediator-scaffolding
- Owner: ArmandJ77-zz
- License: mit
- Created: 2020-01-26T13:55:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-23T20:51:12.000Z (6 months ago)
- Last Synced: 2024-11-07T10:02:30.778Z (about 2 months ago)
- Topics: blog-article, cqrs-pattern, dotnetcore31, mediator-pattern, mediatr, medium-article, nuget-package, roslyn, scaffold-template
- Language: C#
- Homepage: https://armandjordaan.com
- Size: 236 KB
- Stars: 19
- Watchers: 2
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# CQRS and Mediator Scaffolding
## Medium article
> [CQRS & Mediator Part 2: Domain scaffolding with Roslyn API and Dotnet CLI](https://medium.com/@armandjordaan6/cqrs-mediator-part-2-domain-scaffolding-with-roslyn-api-and-dotnet-cli-7c99b5b011f) in this part we will be building a dotnet CLI tool which follows the CQRS and Mediator patterns to auto generate commands, queries, responses and handlers in the domain layer using Roslyn API for code generation.
## Installation
Install using dotnet cli:
```
dotnet tool install --global CQRSAndMediator.Scaffolding
```
To uninstall use:
```
dotnet tool uninstall cqrsandmediator.scaffolding --global
```
## Breakdown of concepts and commands
Show help information:
```
scaffold -h
```
Create a new solution
```
scaffold new sln -n
```
Creates a new solution along with the class libraries, Nunit projects, setup dependencies
and install nuget packages
Create new Mediator handlers
```
scaffold new domain -c -o -ot
```
Example of a new Create Orders handler
### New Solution
Preview of a newly created solution:
#### Command Parameters:
**Concern:** Name of the domain area you are working in i.e Orders, People, Invoice ect.
```
-c|--concern
```
**Operation:** Name of the action you are taking in your concern i.e GetById, GetPagedResult for queries or Create, Patch, Update for commands.
```
-o|--operation
```
**OperationType:** The type of CQRS operation you are scaffolding i.e command or query
```
-ot|--operationtype
```
**GroupBy:** Specify how to group the domain actions. Either by _concern_ or _operation_:
Group domain objects by [C] for concerns or [O] for operations, **defaults to concerns**
```
-g|--groupBy
```
By **concern**:
i.e group by concern when parameters are -c Orders -o GetById -ot query
```
| YourDomainLayer
| Orders
| Handlers
| OrdersGetByIdHandler.cs
| Responses
| OrdersGetByIdResponse.cs
| Queries
| OrderGetByIdQuery.cs
```
By **operation**
i.e group by operation when parameters are -c Orders -o GetById -ot query -g O
```
| YourDomainLayer
| Handler
| OrdersGetByIdHandler.cs
| Responses
| OrdersGetByIdResponse.cs
| Queries
| OrderGetByIdQuery.cs
```
## Usage
**Note:** The tool requires that the project is setup already and that the actions are executed in the top level directory of where your domain layer directory is located.
Use case scaffold out the CRUD domain for an invoice:
The Create Command
```
scaffold new domain -c Invoices -o Create -ot command
```
The Get By id query
```
scaffold new domain -c Invoices -o GetById -ot query
```
The Patch Command
```
scaffold new domain -c Invoices -o Patch -ot command
```
##
## Develop locally
Update the nuget package version located in CQRSAndMediator.Scaffolding.csproj
```
dotnet build .
dotnet pack
```
then in the solution directory:
```
dotnet tool update -g cqrsandmediator.scaffolding --add-source ./nupkg --version x.x.x
```