nestjs-module-generator

nestjs-module-generator

A command-line tool for generating NestJS modules with the necessary folder structure and boilerplate files. It automates the creation of common files like controllers, services, DTOs, entities, and interfaces, making it easy to quickly scaffold new modules in your NestJS application.

Table of Contents

• Installation
• Usage
• Features
• License

Installation

To install the package globally and use the CLI tool, run the following command:

npm install -g nestjs-module-generator

If you want to use it locally within your project:

npm install nestjs-module-generator --save-dev

Usage

Once the package is installed, you can use the generate-module command to create a new NestJS module with all the necessary boilerplate files.

Command Syntax:

generate-module <module-name>

Where <module-name> is the name of the module you want to create (e.g., products, users, etc.).

Example:

To create a module for products:

generate-module products

This will generate the following folder structure:

  products/
  ├── products.controller.ts
  ├── products.service.ts
  ├── products.module.ts
  ├── dto/
  │   ├── create-products.dto.ts
  │   └── update-products.dto.ts
  ├── entities/
  │   └── products.entity.ts
  └── interfaces/
      └── products.interface.ts
  

Each file is pre-configured with the necessary boilerplate for a typical NestJS module, ready for you to start implementing business logic.

Features

• Controller: Generates a basic controller with a route setup.
• Service: Generates a basic service class.
• Module: Generates the module file with necessary imports and providers.
• DTOs: Generates DTOs for creating and updating entities.
• Entities: Generates the entity file (using TypeORM).
• Interfaces: Generates an interface for the module.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Feel free to open issues and submit pull requests for enhancements or bug fixes. All contributions are welcome!

Support

For support, please open an issue in the GitHub repository or contact the author directly.