fix: Aprove the node-module-generator to ensure that every module generated follows the specified Clean Architecture standard, including all layers and naming conventions.

saul-paulus · saul-paulus · commit 4e116f953b1d · 2026-04-06T21:01:09.000+07:00
diff --git a/DOCS_STEPS.md b/DOCS_STEPS.md
@@ -0,0 +1,40 @@
+# Langkah-langkah Setelah Generate Modul Baru
+
+Setelah menjalankan perintah `nmg module <name>`, ikuti langkah-langkah berikut untuk mengintegrasikan modul ke dalam proyek Node.js Anda:
+
+## 1. Registrasi di Awilix Container (`src/container.js`)
+
+Buka file `src/container.js` dan tambahkan registrasi untuk repository jika Anda ingin menggunakan alias spesifik:
+
+```javascript
+import { asFunction } from 'awilix';
+
+// ... di dalam container.register({ ... })
+container.register({
+  // Contoh alias: [module]Repository -> prisma[Module]Repository
+  authRepository: asFunction(({ prismaAuthRepository }) => prismaAuthRepository).scoped(),
+});
+```
+
+*Catatan: Secara default, generator Awilix biasanya mengauto-load file. Pastikan loader Anda dikonfigurasi untuk memuat folder `usecases`, `repositories`, `controllers`, dan `routes`.*
+
+## 2. Registrasi Route di Express (`src/app.js`)
+
+Buka file `src/app.js` dan daftarkan router dari modul yang baru dibuat:
+
+```javascript
+// ...
+app.use('/api/v1/auth', container.resolve('authRoutes'));
+// ...
+```
+
+## 3. Implementasi Detail Bisnis
+*   **Domain**: Tentukan skema data di `domain/entities`.
+*   **Repository Interface**: Tambahkan method yang dibutuhkan di `domain/repositories`.
+*   **Repository Implementation**: Implementasikan query database (Prisma) di `infrastructure/repositories`.
+*   **UseCase**: Tulis logika bisnis utama di `application/usecases`.
+*   **Controller**: Tangani input request dan panggil UseCase di `interfaces/controllers`.
+*   **Routes**: Definisikan endpoint HTTP di `interfaces/routes`.
+
+---
+*Generated by node-module-generator*
diff --git a/generator/dto.generator.js b/generator/dto.generator.js
@@ -5,8 +5,8 @@ const { pascalCase, camelCase } = require("../utils/case.util");
 
 module.exports = async function (schemaName, moduleName) {
   const basePath = path.join(process.cwd(), "src/modules", moduleName);
-  const validationDir = path.join(basePath, "infrastructure/validation");
-  fs.ensureDirSync(validationDir);
+  const dtoDir = path.join(basePath, "application/dtos");
+  fs.ensureDirSync(dtoDir);
 
   const templateData = {
     name: moduleName, 
@@ -15,7 +15,7 @@ module.exports = async function (schemaName, moduleName) {
   };
 
   const templateContent = await ejs.renderFile(path.join(__dirname, "../templates/module/dto.ejs"), templateData);
-  fs.writeFileSync(path.join(validationDir, `${schemaName}.schema.js`), templateContent);
+  fs.writeFileSync(path.join(dtoDir, `${schemaName.toLowerCase()}.dto.js`), templateContent);
 
-  console.log(`✔ DTO Schema ${schemaName} generated inside module ${moduleName}.`);
+  console.log(`✔ DTO ${schemaName} generated inside module ${moduleName} at application/dtos.`);
 };
diff --git a/generator/module.generator.js b/generator/module.generator.js
@@ -19,12 +19,36 @@ module.exports = async function (name) {
   // Create directories
   dirs.forEach((dir) => fs.ensureDirSync(path.join(basePath, dir)));
 
-  console.log(`✔ Module ${name} directory structure created.`);
+  const templateData = {
+    name,
+    className: pascalCase(name),
+    camelName: camelCase(name),
+    useCaseClassName: `${pascalCase(name)}UseCase`,
+    useCaseFileName: `${name.toLowerCase()}.usecase`,
+  };
+
+  const renderAndWrite = async (templateName, outputPath) => {
+    const templateContent = await ejs.renderFile(
+      path.join(__dirname, "../templates/module", templateName),
+      templateData
+    );
+    fs.writeFileSync(path.join(basePath, outputPath), templateContent);
+  };
+
+  await renderAndWrite("controller.ejs", `interfaces/controllers/${pascalCase(name)}Controller.js`);
+  await renderAndWrite("controller.test.ejs", `interfaces/controllers/${pascalCase(name)}Controller.test.js`);
+  await renderAndWrite("route.ejs", `interfaces/routes/${name.toLowerCase()}.routes.js`);
+  
+  await renderAndWrite("usecase.ejs", `application/usecases/${pascalCase(name)}UseCase.js`);
+  await renderAndWrite("usecase.test.ejs", `application/usecases/${pascalCase(name)}UseCase.test.js`);
   
-  // Optionally create an empty module DI file
-  const diFile = path.join(basePath, `${name}.module.js`);
-  if (!fs.existsSync(diFile)) {
-    fs.writeFileSync(diFile, `module.exports = function register${pascalCase(name)}Module(container) {\n  container.register({\n    // Inject dependencies here\n  });\n};\n`);
-    console.log(`✔ Module DI registry ${name}.module.js created.`);
-  }
+  await renderAndWrite("entity.ejs", `domain/entities/${pascalCase(name)}.js`);
+  await renderAndWrite("repository.interface.ejs", `domain/repositories/${pascalCase(name)}Repository.js`);
+  
+  await renderAndWrite("repository.impl.ejs", `infrastructure/repositories/Prisma${pascalCase(name)}Repository.js`);
+  await renderAndWrite("dto.ejs", `application/dtos/${name.toLowerCase()}.dto.js`);
+  
+  await renderAndWrite("di.ejs", `${name}.module.js`);
+
+  console.log(`✔ Module ${name} directory structure, standard files, and tests created.`);
 };
diff --git a/generator/resource.generator.js b/generator/resource.generator.js
@@ -22,8 +22,8 @@ module.exports = async function (name) {
     name,
     className: pascalCase(name),
     camelName: camelCase(name),
-    useCaseClassName: `Create${pascalCase(name)}UseCase`,
-    useCaseFileName: `Create${pascalCase(name)}UseCase`,
+    useCaseClassName: `${pascalCase(name)}UseCase`,
+    useCaseFileName: `${name.toLowerCase()}.usecase`,
   };
 
   const renderAndWrite = async (templateName, outputPath) => {
@@ -38,8 +38,8 @@ module.exports = async function (name) {
   await renderAndWrite("controller.test.ejs", `interfaces/controllers/${pascalCase(name)}Controller.test.js`);
   await renderAndWrite("route.ejs", `interfaces/routes/${name.toLowerCase()}.routes.js`);
   
-  await renderAndWrite("usecase.ejs", `application/usecases/Create${pascalCase(name)}UseCase.js`);
-  await renderAndWrite("usecase.test.ejs", `application/usecases/Create${pascalCase(name)}UseCase.test.js`);
+  await renderAndWrite("usecase.ejs", `application/usecases/${pascalCase(name)}UseCase.js`);
+  await renderAndWrite("usecase.test.ejs", `application/usecases/${pascalCase(name)}UseCase.test.js`);
   
   await renderAndWrite("entity.ejs", `domain/entities/${pascalCase(name)}.js`);
   await renderAndWrite("repository.interface.ejs", `domain/repositories/${pascalCase(name)}Repository.js`);
diff --git a/src/modules/Auth/Auth.module.js b/src/modules/Auth/Auth.module.js
@@ -0,0 +1,15 @@
+import { asClass, asFunction } from 'awilix';
+
+import AuthController from './interfaces/controllers/AuthController';
+import createAuthRoutes from './interfaces/routes/auth.routes';
+import CreateAuthUseCase from './application/usecases/CreateAuthUseCase';
+import PrismaAuthRepository from './infrastructure/repositories/PrismaAuthRepository';
+
+export default function registerAuthModule(container) {
+  container.register({
+    authController: asClass(AuthController).singleton(),
+    authRoutes: asFunction(createAuthRoutes).singleton(),
+    CreateAuthUseCase: asClass(CreateAuthUseCase).singleton(),
+    authRepository: asFunction(({ prismaAuthRepository }) => prismaAuthRepository).scoped(),
+  });
+}
diff --git a/src/modules/Auth/application/dtos/auth.dto.js b/src/modules/Auth/application/dtos/auth.dto.js
@@ -0,0 +1,10 @@
+// DTO Template
+export default {
+  // Define DTO validation schemas here (e.g. Joi, Zod)
+  createSchema: {
+    // rules
+  },
+  updateSchema: {
+    // rules
+  }
+};
diff --git a/src/modules/Auth/application/usecases/AuthUseCase.js b/src/modules/Auth/application/usecases/AuthUseCase.js
@@ -0,0 +1,11 @@
+export default class AuthUseCase {
+  constructor({ authRepository, jwtService }) {
+    this.authRepository = authRepository;
+    this.jwtService = jwtService;
+  }
+
+  async execute(inputData) {
+    // Logic for AuthUseCase
+    return { success: true, data: inputData };
+  }
+}
diff --git a/src/modules/Auth/application/usecases/AuthUseCase.test.js b/src/modules/Auth/application/usecases/AuthUseCase.test.js
@@ -0,0 +1,29 @@
+const AuthUseCase = require('./AuthUseCase');
+
+describe('AuthUseCase', () => {
+  let useCase;
+  let mockRepository;
+
+  beforeEach(() => {
+    mockRepository = {
+      create: jest.fn()
+    };
+    useCase = new AuthUseCase({ 
+      authRepository: mockRepository,
+      jwtService: {} 
+    });
+  });
+
+  describe('execute', () => {
+    it('should call repository create and return success', async () => {
+      const mockDto = { name: 'Test' };
+      const mockResult = { id: 1, ...mockDto };
+      mockRepository.create.mockResolvedValue(mockResult);
+
+      const result = await useCase.execute(mockDto);
+
+      expect(mockRepository.create).toHaveBeenCalledWith(mockDto);
+      expect(result).toEqual({ success: true, data: mockDto });
+    });
+  });
+});
diff --git a/src/modules/Auth/domain/entities/Auth.js b/src/modules/Auth/domain/entities/Auth.js
@@ -0,0 +1,5 @@
+export default class Auth {
+  constructor(props) {
+    Object.assign(this, props);
+  }
+}
diff --git a/src/modules/Auth/domain/repositories/AuthRepository.js b/src/modules/Auth/domain/repositories/AuthRepository.js
@@ -0,0 +1,9 @@
+export default class AuthRepository {
+  async findById(id) {
+    throw new Error('Method not implemented.');
+  }
+
+  async create(data) {
+    throw new Error('Method not implemented.');
+  }
+}
diff --git a/src/modules/Auth/infrastructure/repositories/PrismaAuthRepository.js b/src/modules/Auth/infrastructure/repositories/PrismaAuthRepository.js
@@ -0,0 +1,15 @@
+export default class PrismaAuthRepository {
+  constructor({ prisma }) {
+    this.prisma = prisma;
+  }
+
+  async findById(id) {
+    return this.prisma.auths.findUnique({
+      where: { id },
+    });
+  }
+
+  async create(data) {
+    return this.prisma.auths.create({ data });
+  }
+}
diff --git a/src/modules/Auth/interfaces/controllers/AuthController.js b/src/modules/Auth/interfaces/controllers/AuthController.js
@@ -0,0 +1,15 @@
+export default class AuthController {
+  constructor({ authRepository, authUseCase }) {
+    this.authRepository = authRepository;
+    this.authUseCase = authUseCase;
+  }
+
+  async index(req, res, next) {
+    try {
+      const result = await this.authUseCase.execute(req.body);
+      res.json(result);
+    } catch (error) {
+      next(error);
+    }
+  }
+}
diff --git a/src/modules/Auth/interfaces/controllers/AuthController.test.js b/src/modules/Auth/interfaces/controllers/AuthController.test.js
@@ -0,0 +1,48 @@
+const AuthController = require('./AuthController');
+
+describe('AuthController', () => {
+  let controller;
+  let mockUseCase;
+  let mockReq;
+  let mockRes;
+  let mockNext;
+
+  beforeEach(() => {
+    mockUseCase = {
+      execute: jest.fn()
+    };
+    controller = new AuthController({ 
+      authRepository: {}, 
+      authUseCase: mockUseCase 
+    });
+    mockReq = {
+      body: { test: 'data' }
+    };
+    mockRes = {
+      status: jest.fn().mockReturnThis(),
+      json: jest.fn()
+    };
+    mockNext = jest.fn();
+  });
+
+  describe('index', () => {
+    it('should return result if use case succeeds', async () => {
+      const mockResult = { success: true, data: mockReq.body };
+      mockUseCase.execute.mockResolvedValue(mockResult);
+
+      await controller.index(mockReq, mockRes, mockNext);
+
+      expect(mockUseCase.execute).toHaveBeenCalledWith(mockReq.body);
+      expect(mockRes.json).toHaveBeenCalledWith(mockResult);
+    });
+
+    it('should call next with error if use case fails', async () => {
+      const error = new Error('Test error');
+      mockUseCase.execute.mockRejectedValue(error);
+
+      await controller.index(mockReq, mockRes, mockNext);
+
+      expect(mockNext).toHaveBeenCalledWith(error);
+    });
+  });
+});
diff --git a/src/modules/Auth/interfaces/routes/auth.routes.js b/src/modules/Auth/interfaces/routes/auth.routes.js
@@ -0,0 +1,9 @@
+// routes
+export default ({ authController }) => {
+  const express = require('express');
+  const router = express.Router();
+  
+  router.get('/', authController.index.bind(authController));
+  
+  return router;
+};
diff --git a/templates/module/controller.ejs b/templates/module/controller.ejs
@@ -1,11 +1,12 @@
 export default class <%= className %>Controller {
-  constructor({ <%= camelName %>Repository }) {
+  constructor({ <%= camelName %>Repository, <%= camelName %>UseCase }) {
     this.<%= camelName %>Repository = <%= camelName %>Repository;
+    this.<%= camelName %>UseCase = <%= camelName %>UseCase;
   }
 
-  async findById(req, res, next) {
+  async index(req, res, next) {
     try {
-      const result = await this.<%= camelName %>Repository.findById(req.params.id);
+      const result = await this.<%= camelName %>UseCase.execute(req.body);
       res.json(result);
     } catch (error) {
       next(error);
diff --git a/templates/module/controller.test.ejs b/templates/module/controller.test.ejs
@@ -1,4 +1,4 @@
-const <%= className %>Controller = require('./<%= name %>.controller');
+const <%= className %>Controller = require('./<%= className %>Controller');
 
 describe('<%= className %>Controller', () => {
   let controller;
@@ -11,7 +11,10 @@ describe('<%= className %>Controller', () => {
     mockUseCase = {
       execute: jest.fn()
     };
-    controller = new <%= className %>Controller({ <%= camelName %>UseCase: mockUseCase });
+    controller = new <%= className %>Controller({ 
+      <%= camelName %>Repository: {}, 
+      <%= camelName %>UseCase: mockUseCase 
+    });
     mockReq = {
       body: { test: 'data' }
     };
@@ -22,23 +25,22 @@ describe('<%= className %>Controller', () => {
     mockNext = jest.fn();
   });
 
-  describe('create', () => {
-    it('should return 201 and result if use case succeeds', async () => {
-      const mockResult = { id: 1, ...mockReq.body };
+  describe('index', () => {
+    it('should return result if use case succeeds', async () => {
+      const mockResult = { success: true, data: mockReq.body };
       mockUseCase.execute.mockResolvedValue(mockResult);
 
-      await controller.create(mockReq, mockRes, mockNext);
+      await controller.index(mockReq, mockRes, mockNext);
 
       expect(mockUseCase.execute).toHaveBeenCalledWith(mockReq.body);
-      expect(mockRes.status).toHaveBeenCalledWith(201);
-      expect(mockRes.json).toHaveBeenCalledWith({ success: true, data: mockResult });
+      expect(mockRes.json).toHaveBeenCalledWith(mockResult);
     });
 
     it('should call next with error if use case fails', async () => {
       const error = new Error('Test error');
       mockUseCase.execute.mockRejectedValue(error);
 
-      await controller.create(mockReq, mockRes, mockNext);
+      await controller.index(mockReq, mockRes, mockNext);
 
       expect(mockNext).toHaveBeenCalledWith(error);
     });
diff --git a/templates/module/dto.ejs b/templates/module/dto.ejs
@@ -1,7 +1,10 @@
-const Joi = require('joi'); // Usually you'd use joi or another lib
-
-const create<%= className %>Schema = Joi.object({
-  // Define DTO validation rules
-});
-
-module.exports = create<%= className %>Schema;
+// DTO Template
+export default {
+  // Define DTO validation schemas here (e.g. Joi, Zod)
+  createSchema: {
+    // rules
+  },
+  updateSchema: {
+    // rules
+  }
+};
diff --git a/templates/module/repository.impl.ejs b/templates/module/repository.impl.ejs
@@ -8,4 +8,8 @@ export default class Prisma<%= className %>Repository {
       where: { id },
     });
   }
+
+  async create(data) {
+    return this.prisma.<%= camelName %>s.create({ data });
+  }
 }
diff --git a/templates/module/repository.interface.ejs b/templates/module/repository.interface.ejs
diff --git a/templates/module/route.ejs b/templates/module/route.ejs
diff --git a/templates/module/usecase.ejs b/templates/module/usecase.ejs
diff --git a/templates/module/usecase.test.ejs b/templates/module/usecase.test.ejs
