🛠️ nest-cqrs-schematics

A custom schematic collection to generate Command and Query files (along with their handlers) for NestJS projects using the CQRS pattern.

> ⚡️ Built to save time and reduce boilerplate when working with @nestjs/cqrs.

---

✨ Features

- 🧩 Generate Command and CommandHandler
- 🔍 Generate Query and QueryHandler
- 🚀 Quick scaffolding using Nest CLI
- ✍️ Easily customizable boilerplate after generation

---

📆 Installation

Install the package as a dev dependency:

``bash
pnpm add -D nest-cqrs-schematics
`

> You can also use npm or yarn if preferred.

---

🚀 Usage

Add the following scripts to your package.json to simplify command execution:

`json
{
"scripts": {
"gen:cmd": "nest g -c nest-cqrs-schematics command",
"gen:query": "nest g -c nest-cqrs-schematics query"
}
}
`

Run the following commands using the NestJS CLI:

$3

`bash
npm run gen:cmd create-user modules/features/users
`

Generates:

`
src/
└── modules/
└── features/
└── users/
└── commands/
├── impl/
│ └── create-user.command.ts
└── handlers/
└── create-user.handler.ts
`

---

$3

`bash
npm run gen:query get-user modules/features/users
`

Generates:

`
src/
└── modules/
└── features/
└── users/
└── queries/
├── impl/
│ └── get-user.query.ts
└── handlers/
└── get-user.handler.ts
`

---

🔧 Example Output

$3

`ts
export class CreateUserCommand {
constructor(public readonly name: string, public readonly email: string) {}
}
`

$3

`ts
import { CommandHandler, ICommandHandler } from "@nestjs/cqrs";
import { CreateUserCommand } from "../impl/create-user.command";

@CommandHandler(CreateUserCommand)
export class CreateUserHandler implements ICommandHandler {
async execute(command: CreateUserCommand): Promise {
const { name, email } = command;

// TODO: Implement business logic
}
}
`

---

🔮 Coming Soon

Planned for future versions:

- 📣 Support for Events and Event Handlers
- 🔁 Support for Sagas
- 🎛️ Custom configuration options (e.g., naming, file structure)

---

💡 Notes

- This package only works with NestJS projects.
- Ensure you have the @nestjs/cqrs` module installed in your project.
- Generated code is fully editable and meant to be a starting point.

---

👨‍💼 Developed By

If you find this tool helpful, feel free to share your feedback, report issues, or contribute improvements!

Maintained with ❤️ by Rameez Hasan — always open to collaboration and community input.

---

📄 License

MIT