Nesttem

Nesttem is a CLI tool to generate NestJS module templates dynamically. This tool helps you quickly scaffold NestJS modules with pre-defined templates like controllers, services, and DTOs, saving you time during development.

Features

• Generate fully structured NestJS modules.
• Supports dynamic module naming and permissions.
• Automatically generates controller, service, and DTO files based on templates.
• Works with custom directories or the current working directory.

Installation

You can install nesttem locally for development or use it globally via npx.

Using npx

You don't need to install the package globally. Simply run the following:

npx nesttem

Installing locally

You can clone the repository and install dependencies locally:

git clone https://github.com/your-username/nesttem.git
cd nesttem
pnpm install

Usage

To generate a new NestJS module, run the command and follow the prompts to input the module name, permission, and directory:

pnpm exec ts-node src/index.ts

Options

• Module Name: The name of the module to generate.
• Permission: Role-based permissions for the generated module (e.g., MASTER, ADMIN, USER).
• Directory: Optionally specify a custom directory for the module (leave empty to use the current directory).

Example:

? Digite o nome do módulo: User
? Escolha a permissão: MASTER
? Digite o diretório (deixe vazio para usar o diretório atual): src/modules

This will generate the following structure:

src/modules/
  user/
    dto/
      id.filter.ts
      query.filter.ts
      create.dto.ts
      status.dto.ts
      update.dto.ts
    user.module.ts
    user.controller.ts
    user.service.ts

Templates

The following files are generated based on templates stored in src/templates/:

• module.ts.ejs: NestJS module template.
• controller.ts.ejs: NestJS controller template.
• service.ts.ejs: NestJS service template.
• DTO templates inside dto/ folder:
  • create.dto.ts.ejs
  • update.dto.ts.ejs
  • id.filter.ts.ejs
  • query.filter.ts.ejs
  • status.dto.ts.ejs

License

This project is licensed under the MIT License. See the LICENSE file for more details.