fix: update test

Author: saul-paulus

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing Guide
+
+## How to Contribute
+
+1. Fork this repository
+2. Create your feature branch:
+   git checkout -b feature/your-feature-name
+3. Commit your changes:
+   git commit -m "feat: add new feature"
+4. Push to your branch
+5. Open a Pull Request
+
+## Code Style
+
+- Follow existing code structure
+- Use consistent naming conventions
+- Write clean and readable code
+
+## Commit Convention
+
+- feat: new feature
+- fix: bug fix
+- docs: documentation
+- refactor: code improvement

README.md

@@ -1,15 +1,16 @@
 <div align="center">
-  <h1>🚀 Node Module Generator</h1>
-  <p>A robust CLI tool for scaffolding Express.js projects using Clean Architecture & Dependency Injection.</p>
+  <img src="https://raw.githubusercontent.com/saul-paulus/node-module-generator/main/assets/banner.png" alt="Node Module Generator Banner" width="600" style="max-width: 100%;" />
+  <h1>🚀 Node Module Generator (NMG)</h1>
+  <p><strong>The ultimate CLI companion for rapid, enterprise-grade Node.js scaffolding.</strong></p>
   <p>
     <a href="https://github.com/saul-paulus/node-module-generator/actions/workflows/ci.yml">
       <img src="https://github.com/saul-paulus/node-module-generator/actions/workflows/ci.yml/badge.svg" alt="CI Status">
     </a>
     <a href="https://www.npmjs.com/package/@saulpaulus17/node-module-generator">
-      <img src="https://img.shields.io/npm/v/@saulpaulus17/node-module-generator.svg" alt="NPM Version" />
+      <img src="https://img.shields.io/npm/v/@saulpaulus17/node-module-generator.svg?logo=npm&logoColor=white" alt="NPM Version" />
     </a>
     <a href="https://www.npmjs.com/package/@saulpaulus17/node-module-generator">
-      <img src="https://img.shields.io/npm/dt/@saulpaulus17/node-module-generator.svg" alt="NPM Downloads" />
+      <img src="https://img.shields.io/npm/dt/@saulpaulus17/node-module-generator.svg?logo=npm&logoColor=white" alt="NPM Downloads" />
     </a>
     <a href="https://github.com/saul-paulus/node-module-generator/blob/main/LICENSE">
       <img src="https://img.shields.io/npm/l/@saulpaulus17/node-module-generator.svg" alt="License" />
@@ -19,107 +20,147 @@
 
 ---
 
-## 📖 Overview
+## 🏛️ Architecture Overview
+
+Node Module Generator (NMG) enforces **Clean Architecture** principles to ensure your backend remains scalable, testable, and decoupled. It is purpose-built for high-performance **Express.js** environments using **Awilix** for Dependency Injection.
+
+### Layered Structure
+```mermaid
+graph TD
+    UI[Interfaces Layer: Controllers & Routes] --> APP[Application Layer: Use Cases & DTOs]
+    APP --> DOM[Domain Layer: Entities & Repository Interfaces]
+    INF[Infrastructure Layer: Repository Impl & External Services] --> DOM
+    
+    subgraph "Inner Layers"
+    DOM
+    APP
+    end
+    
+    subgraph "Outer Layers"
+    UI
+    INF
+    end
+```
 
-**Node Module Generator** provides a world-class Developer Experience (DX) equivalent to the robust CLIs found in ecosystems like NestJS or Angular, but designed specifically for pure Node.js environments utilizing **Express.js** and **Clean Architecture**.
+---
 
-It instantly scaffolds fully-tested, decoupled, and highly cohesive module structures with built-in Dependency Injection using **Awilix**.
+## 🔥 Key Features
 
-## ✨ Features
+- 💎 **Clean Architecture by Design**: Strict separation into Domain, Application, Infrastructure, and Interface layers.
+- 💉 **Native Dependency Injection**: Fully pre-configured for **Awilix**, providing seamless DI management.
+- 🧪 **Test-Ready Scaffolding**: Automatically generates **Jest** test suites for Controllers and Use Cases.
+- 🚀 **Modern Tooling**: Native support for **ES Modules (ESM)**, **Prisma ORM**, and **Joi/Zod** DTO patterns.
+- 🤖 **Granular Control**: Generate full modules or individual components (UseCases, Repos, DTOs) without disrupting existing code.
 
-- 🏗️ **Clean Architecture by Default**: Automatically separates concerns into Domain, Application, Infrastructure, and Interface layers.
-- 💉 **Dependency Injection Ready**: Auto-generates Awilix configurations mapped correctly across use cases, controllers, and repositories.
-- 🧪 **Test-Driven Design**: Scaffolds adjoining `*.test.js` files containing boilerplates for Jest to promote TDD.
-- 🤖 **Continuous Integration**: Codebase natively incorporates GitHub Actions for automated unit testing checks.
-- 🧩 **Granular Scaffolding**: Generate specific components (UseCases, Repositories, DTOs) dynamically on demand without overriding existing folders!
+---
 
 ## 📦 Installation
 
 ### Prerequisites
-- **Node.js**: v18.0.0 or higher.
-- **NPM** or **Yarn**.
+- **Node.js**: v18.0.0 or higher (LTS recommended)
+- **NPM**, **Yarn**, or **PNPM**
 
-To use this CLI tool locally or globally on your machine, you can install it directly from NPM.
+### Global Installation (Recommended)
+Install NMG globally to access the command from any project.
 
 ```bash
-# Install globally via NPM
 npm install -g @saulpaulus17/node-module-generator
 ```
 
-## 🚀 Usage
+### Direct Execution
+Run it on-the-fly without a permanent installation:
 
-Once installed globally, you can execute the CLI commands from any of your Node.js project directories using the `nmg` command keyword.
+```bash
+npx @saulpaulus17/node-module-generator <command> <name>
+```
 
-### Granular CLI Commands
-Scaffold specifically what you need, exactly how you do it in NestJS:
+---
 
-```bash
-# 1. Scaffolds a new module architecture and empty DI registry
-nmg module product
+## 🚀 Detailed Usage
 
+### 1. Generating a Full Module
+Scaffolds a complete standard architecture with all 4 layers and initial unit tests.
 
-# 2. Creates a specific Use Case and its Test inside an existing module
-nmg usecase updateProduct --module=product
+```bash
+nmg module Auth
+```
 
-# 3. Creates Domain Entity and Repository Interfaces/Implementations
-nmg repository product
+### 2. Generating Individual Components
+Quickly add specific components to an existing module structure.
+
+```bash
+# Add a new UseCase (e.g., login) to the Auth module
+nmg usecase login --module=Auth
 
-# 4. Scaffolds a DTO validation schema
-nmg dto getProduct --module=product
+# Add a Repository Interface and Implementation (Prisma)
+nmg repository User
 
-# 5. Generates an entire full-stack CRUD Resource (Controller, Entity, Repos, DI, etc.)
-nmg resource order
+# Add a DTO validation schema
+nmg dto userRegistration --module=Auth
 ```
 
-_(Note: If you haven't installed the package globally, you can run it via `npx @saulpaulus17/node-module-generator <command> <name>`)_
+---
 
-## 📂 Full Resource Structure
+## 📂 Project Blueprint
 
-Running the powerhouse command `nmg resource user` instantly generates the following decoupled blueprint within your project's `src/modules` directory:
+Scaffolding a module (e.g., `nmg module Product`) produces the following industry-standard structure:
 
 ```text
-src/modules/user/
-├── application/                 # Orchestration & Use Cases
-│   ├── dtos/                    # (Generated schema references)
-│   └── usecases/
-│       ├── create-user.usecase.js      # Business logically perfectly isolated
-│       └── create-user.usecase.test.js # Scaffolded test harness
-├── domain/                      # Blueprints & Business Rules (Pure Logic)
-│   ├── entities/
-│   │   └── user.entity.js
-│   └── repositories/            # Repository Interfaces (Contracts)
-│       └── user.repository.interface.js
-├── infrastructure/              # Technical Details & Implementation
-│   ├── repositories/            # Implementations (mocked to replace with Prisma/TypeORM)
-│   │   └── user.repository.impl.js
-│   └── validation/              # Input validation schemas
-│       └── create-user.schema.js       # Auto-stubbed validation schema
-├── interfaces/                  # Entry Points (Web/API)
-│   ├── controllers/
-│   │   ├── user.controller.js          # Express.js class handlers
-│   │   └── user.controller.test.js
-│   └── routes/
-│       └── user.routes.js              # Express routers integrating the controller
-└── user.module.js               # Centralised Awilix Dependency Injection bindings
+src/modules/Product/
+├── application/                 
+│   ├── dtos/                    # DTO schemas (e.g., product.dto.js)
+│   └── usecases/                # Business orchestration
+│       ├── ProductUseCase.js    # Logic implementation
+│       └── ProductUseCase.test.js # Unit tests
+├── domain/                      
+│   ├── entities/                # Business entity definitions
+│   │   └── Product.js
+│   └── repositories/            # Repository Interface (Contracts)
+│       └── ProductRepository.js
+├── infrastructure/              
+│   ├── repositories/            # Implementation (default: Prisma)
+│   │   └── PrismaProductRepository.js
+├── interfaces/                  
+│   ├── controllers/             # Express handlers
+│   │   ├── ProductController.js
+│   │   └── ProductController.test.js
+│   └── routes/                  # Express routes & method binding
+│       └── product.routes.js
+└── Product.module.js            # Central Awilix Module Registration
 ```
 
-## 🛠️ Technological Footprint
+---
+
+## 🛠️ Post-Scaffolding Integration
 
-The scaffolded code integrates perfectly if you are using the following libraries in your Express application:
+To finalize your new module integration, follow these standard steps:
 
-- **[Express.js](https://expressjs.com/)** - Web Framework
-- **[Awilix](https://github.com/jeffijoe/awilix)** - Powerful Dependency Injection container
-- **[Jest](https://jestjs.io/)** - For the colocated testing environments
-- **[Joi](https://joi.dev/)** - For infrastructure schema validations
+1.  **DI Registration**: Open `src/container.js` and register any specific repository aliases or scoped usecases.
+2.  **Route Mounting**: Mount the generated router in `src/app.js`:
+    ```javascript
+    app.use('/api/v1/product', container.resolve('productRoutes'));
+    ```
+3.  **Detailed Implementation**: Build out the specific logic in the generated templates (which are already integrated via Awilix).
 
-## 🤝 Contributing
+---
+
+## 🤝 Contributing & Support
 
-Contributions are always welcome! Feel free to open issues or submit Pull Requests.
-1. Fork the repo and create your branch (`git checkout -b feature/amazing-feature`).
-2. Commit your changes (`git commit -m 'feat: add amazing feature'`).
-3. Push to the branch (`git push origin feature/amazing-feature`).
-4. Open a Pull Request.
+We welcome contributions from the community!
+1. Fork the project.
+2. Create your Feature Branch (`git checkout -b feat/NewFeature`).
+3. Commit your changes (`git commit -m 'feat: Add some NewFeature'`).
+4. Push to the Branch (`git push origin feat/NewFeature`).
+5. Open a Pull Request.
+
+---
 
 ## 📝 License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+Distributed under the **MIT License**. See `LICENSE` for more information.
+
+---
+<div align="center">
+  <p>Built with ❤️ for modern Node.js developers</p>
+  <sub>Copyright © 2024 saul-paulus</sub>
+</div>

generator/module.generator.js

@@ -19,6 +19,9 @@ module.exports = async function (name) {
   // Create directories
   dirs.forEach((dir) => fs.ensureDirSync(path.join(basePath, dir)));
 
+  // Generate scoped package.json for ESM support
+  fs.writeJsonSync(path.join(basePath, "package.json"), { type: "module" }, { spaces: 2 });
+
   const templateData = {
     name,
     className: pascalCase(name),

generator/resource.generator.js

@@ -18,6 +18,9 @@ module.exports = async function (name) {
 
   dirs.forEach((dir) => fs.ensureDirSync(path.join(basePath, dir)));
 
+  // Generate scoped package.json for ESM support
+  fs.writeJsonSync(path.join(basePath, "package.json"), { type: "module" }, { spaces: 2 });
+
   const templateData = {
     name,
     className: pascalCase(name),

package.json

@@ -16,7 +16,7 @@
     "nmg": "./bin/cli.js"
   },
   "scripts": {
-    "test": "jest"
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
   },
   "dependencies": {
     "chalk": "^5.6.2",

src/modules/Auth/application/usecases/AuthUseCase.js

@@ -6,6 +6,7 @@ export default class AuthUseCase {
 
   async execute(inputData) {
     // Logic for AuthUseCase
-    return { success: true, data: inputData };
+    const result = await this.authRepository.create(inputData);
+    return { success: true, data: result };
   }
 }

src/modules/Auth/application/usecases/AuthUseCase.test.js

@@ -1,4 +1,5 @@
-const AuthUseCase = require('./AuthUseCase');
+import { jest, describe, it, expect, beforeEach } from '@jest/globals';
+import AuthUseCase from './AuthUseCase.js';
 
 describe('AuthUseCase', () => {
   let useCase;
@@ -23,7 +24,7 @@ describe('AuthUseCase', () => {
       const result = await useCase.execute(mockDto);
 
       expect(mockRepository.create).toHaveBeenCalledWith(mockDto);
-      expect(result).toEqual({ success: true, data: mockDto });
+      expect(result).toEqual({ success: true, data: mockResult });
     });
   });
 });

src/modules/Auth/interfaces/controllers/AuthController.test.js

@@ -1,4 +1,5 @@
-const AuthController = require('./AuthController');
+import { jest, describe, it, expect, beforeEach } from '@jest/globals';
+import AuthController from './AuthController.js';
 
 describe('AuthController', () => {
   let controller;

src/modules/Auth/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

templates/module/controller.test.ejs

@@ -1,4 +1,5 @@
-const <%= className %>Controller = require('./<%= className %>Controller');
+import { jest, describe, it, expect, beforeEach } from '@jest/globals';
+import <%= className %>Controller from './<%= className %>Controller.js';
 
 describe('<%= className %>Controller', () => {
   let controller;