@wallentaine/cqrs-schematics 0.1.1 → 0.1.2

package/README.md

@@ -0,0 +1,80 @@
+# CQRS Schematics for NestJS
+
+Кастомные схемытики для быстрой генерации CQRS-файлов в NestJS.
+
+## Установка
+
+```bash
+npm i -D @wallentaine/cqrs-schematics
+# или
+yarn add --dev @wallentaine/cqrs-schematics
+# или
+pnpm add --dev @wallentaine/cqrs-schematics
+```
+
+## Использование
+
+### Базовые команды
+
+```bash
+# Command
+nest g -c @wallentaine/cqrs-schematics command <Name>
+
+# Query
+nest g -c @wallentaine/cqrs-schematics query <Name>
+
+# Event
+nest g -c @wallentaine/cqrs-schematics event <Name>
+```
+
+### Примеры
+
+```bash
+nest g -c @wallentaine/cqrs-schematics command CreateUser
+nest g -c @wallentaine/cqrs-schematics query GetUserProfile
+nest g -c @wallentaine/cqrs-schematics event UserCreated
+```
+
+### Bash алиасы (добавьте в ~/.bashrc или ~/.zshrc)
+
+```bash
+alias ngc="nest g -c @wallentaine/cqrs-schematics command"
+alias ngq="nest g -c @wallentaine/cqrs-schematics query"
+alias nge="nest g -c @wallentaine/cqrs-schematics event"
+```
+
+Теперь комады будут выглядеть так:
+
+```bash
+ngc CreatePost
+ngq FindPostById
+nge PostCreated
+```
+
+### Что генерируется
+
+Для каждой команды создаются:
+
+- Файл с самой командой/запросом/событием
+- Файл `handler` с готовым шаблоном обработчика
+- Файл `httpController` с готовым шаблоном контроллера(для `command` и `query`)
+
+
+### Пример для CreatePost:
+
+```
+src/commands/CreatePost.command.ts
+src/commands/handlers/CreatePost.commandHandler.ts
+```
+
+### Регистрация
+
+Не забудьте добавить обработчик и контроллер в providers модуля:
+
+```ts
+@Module({
+	providers: [CreatePostCommandHandler, FindPostByIdQueryHandler],
+	controllers: [CreatePostHttpController, FindPostByIdHttpController],
+})
+export class PostModule {}
+```

package/lib/schematics/command/files/__name__.commandHandler.ts.template

@@ -1,12 +1,14 @@
+import { Logger } from "@nestjs/common";
 import { CommandHandler, ICommandHandler } from '@nestjs/cqrs';
 import { <%= className %>Command } from './<%= name %>.command';
 
 @CommandHandler(<%= className %>Command)
 export class <%= className %>CommandHandler implements ICommandHandler<<%= className %>Command> {
-  
+  private readonly logger = new Logger(<%= className %>CommandHandler.name);
+
   public constructor() {}
 
-  async execute(command: <%= className %>Command): Promise<any> {
+  async execute(command: <%= className %>Command): Promise<void> {
     // Implement your command logic here
   }
 }

package/lib/schematics/event/files/__name__.event.ts.template

@@ -1,7 +1,7 @@
-import { QueryBase } from '@Libs/DDD/Query.base';
+import { ApplicationEvent, ApplicationEventProps } from '@Libs/Application/Application.event';
 
-export class <%= className %>Query extends QueryBase {
-  public constructor(props: <%= className %>Query) {
+export class <%= className %>Event extends ApplicationEvent {
+  public constructor(props: ApplicationEventProps<<%= className %>Event>) {
     super();
   }
 }

package/lib/schematics/event/files/__name__.eventHandler.ts.template

@@ -1,12 +1,14 @@
-import { QueryHandler, IQueryHandler } from '@nestjs/cqrs';
-import { <%= className %>Query } from './<%= name %>.query';
+import { ApplicationEventProps } from "@Libs/Application/Application.event";
+import { Logger } from "@nestjs/common";
+import { OnEvent } from "@nestjs/event-emitter";
+
+export class <%= className %>EventHandler {
+  private readonly logger = new Logger(<%= className %>EventHandler.name);
 
-@QueryHandler(<%= className %>Query)
-export class <%= className %>QueryHandler implements IQueryHandler<<%= className %>Query> {
-  
   public constructor() {}
 
-  async execute(query: <%= className %>Query): Promise<any> {
+  @OnEvent()
+  async handle(event: ApplicationEventProps<<%= className %>Event>): Promise<void> {
     // Implement your query logic here
   }
 }

package/lib/schematics/query/files/__name__.queryHandler.ts.template

@@ -1,12 +1,14 @@
+import { Logger } from "@nestjs/common";
 import { QueryHandler, IQueryHandler } from '@nestjs/cqrs';
 import { <%= className %>Query } from './<%= name %>.query';
 
 @QueryHandler(<%= className %>Query)
 export class <%= className %>QueryHandler implements IQueryHandler<<%= className %>Query> {
-  
+  private readonly logger = new Logger(<%= className %>QueryHandler.name);
+
   public constructor() {}
 
-  async execute(query: <%= className %>Query): Promise<any> {
+  async execute(query: <%= className %>Query): Promise<void> {
     // Implement your query logic here
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wallentaine/cqrs-schematics",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"scripts": {
@@ -9,7 +9,8 @@
 	},
 	"files": [
 		"lib/**/*",
-		"collection.json"
+		"collection.json",
+		"README.md"
 	],
 	"keywords": [
 		"nestjs",