🛠️ Generate Module Script

This script automates the creation of a NestJS module with Mongoose integration. It scaffolds all the essential files and folders for a new module, including DTOs, schema, service, resource, controller, and module definition.

🚀 Features

Creates a complete NestJS module structure automatically.

Generates folders:

services/

controllers/

dto/

schemas/

resources/

tests/

Pre-generates:

Mongoose schema with timestamps.

DTOs (create and update).

Resource class for database access with CRUD operations.

Service class to handle business logic.

Controller with REST endpoints.

NestJS module preconfigured with MongooseModule.

📦 Usage

Run the script with the desired module name:

node scripts/generate-module.js ModuleName

ModuleName should be in PascalCase (e.g., User, Product, Order).

Example:

node scripts/generate-module.js User

🏗️ What it Generates

For a module named User, the script will create:

src/user/ ├── controllers/ │ └── user.controller.ts ├── dto/ │ ├── create-user.dto.ts │ └── update-user.dto.ts ├── resources/ │ └── user.resource.ts ├── schemas/ │ └── user.schema.ts ├── services/ │ └── user.service.ts ├── tests/ ├── user.module.ts

📑 Generated Files

Schema → Defines the Mongoose schema with timestamps.

DTOs → For validation and API docs (create and update).

Resource → Encapsulates direct database operations.

Service → Handles business logic using the resource.

Controller → Provides REST endpoints (CRUD + count).

Module → Registers schema, service, resource, and controller with NestJS.

⚡ Benefits

Saves time by automating repetitive boilerplate code.

Ensures consistent structure across all modules.

Ready-to-use CRUD module with minimal adjustments.

Integrates seamlessly with NestJS + Mongoose.

✅ Example Endpoints (for User)

POST /user → Create a new user

GET /user → Get all users

GET /user/:id → Get a user by ID

PATCH /user/:id → Update a user

DELETE /user/:id → Delete a user

GET /user/count/all → Get total count of users