@saulpaulus17/node-module-generator 2.0.5 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saulpaulus17/node-module-generator",
-  "version": "2.0.5",
+  "version": "3.0.0",
   "description": "CLI tool to grenerate modular scaffolding for nodejs projects following clean arsitecture principles. ",
   "keywords": [
     "nodejs",
@@ -10,7 +10,15 @@
   ],
   "license": "MIT",
   "author": "saul-paulus (ixspx)",
-  "type": "commonjs",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/saul-paulus/node-module-generator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/saul-paulus/node-module-generator/issues"
+  },
+  "homepage": "https://github.com/saul-paulus/node-module-generator#readme",
   "main": "index.js",
   "bin": {
     "nmg": "./bin/cli.js"
@@ -19,7 +27,7 @@
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
   },
   "dependencies": {
-    "chalk": "^5.6.2",
+    "chalk": "^4.1.2",
     "commander": "^14.0.3",
     "ejs": "^5.0.1",
     "fs-extra": "^11.3.4"

package/templates/module/controller.test.ejs

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

package/templates/module/di.ejs

@@ -1,15 +1,15 @@
 import { asClass, asFunction } from 'awilix';
 
-import <%= className %>Controller from './interfaces/controllers/<%= className %>Controller';
-import create<%= className %>Routes from './interfaces/routes/<%= name.toLowerCase() %>.routes';
-import Create<%= className %>UseCase from './application/usecases/Create<%= className %>UseCase';
-import Prisma<%= className %>Repository from './infrastructure/repositories/Prisma<%= className %>Repository';
+import <%= className %>Controller from './interfaces/controllers/<%= kebabName %>-controller.js';
+import create<%= className %>Routes from './interfaces/routes/<%= kebabName %>-routes.js';
+import <%= className %>UseCase from './application/usecases/<%= kebabName %>-use-case.js';
+import Prisma<%= className %>Repository from './infrastructure/repositories/prisma-<%= kebabName %>-repository.js';
 
 export default function register<%= className %>Module(container) {
   container.register({
     <%= camelName %>Controller: asClass(<%= className %>Controller).singleton(),
     <%= camelName %>Routes: asFunction(create<%= className %>Routes).singleton(),
-    Create<%= className %>UseCase: asClass(Create<%= className %>UseCase).singleton(),
-    <%= camelName %>Repository: asFunction(({ prisma<%= className %>Repository }) => prisma<%= className %>Repository).scoped(),
+    <%= camelName %>UseCase: asClass(<%= className %>UseCase).singleton(),
+    <%= camelName %>Repository: asClass(Prisma<%= className %>Repository).singleton(),
   });
 }

package/templates/module/route.ejs

@@ -1,6 +1,7 @@
 // routes
+import express from 'express';
+
 export default ({ <%= camelName %>Controller }) => {
-  const express = require('express');
   const router = express.Router();
   
   router.get('/', <%= camelName %>Controller.index.bind(<%= camelName %>Controller));

package/templates/module/usecase.test.ejs

@@ -1,5 +1,5 @@
 import { jest, describe, it, expect, beforeEach } from '@jest/globals';
-import <%= className %>UseCase from './<%= className %>UseCase.js';
+import <%= className %>UseCase from './<%= kebabName %>-use-case.js';
 
 describe('<%= className %>UseCase', () => {
   let useCase;

package/utils/case.util.js

@@ -1,10 +1,27 @@
-exports.pascalCase = (str) => {
-  const words = str.match(/[a-z0-9]+/gi) || [];
-  return words.map(w => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase()).join('');
+export const pascalCase = (str) => {
+  // Split on hyphens, underscores, or camelCase boundaries
+  const words =
+    str.replace(/([a-z])([A-Z])/g, "$1 $2").match(/[a-z0-9]+/gi) || [];
+  return words
+    .map((w) => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
+    .join("");
 };
 
-exports.camelCase = (str) => {
-  const words = str.match(/[a-z0-9]+/gi) || [];
-  if (!words.length) return '';
-  return words[0].toLowerCase() + words.slice(1).map(w => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase()).join('');
+export const camelCase = (str) => {
+  const words =
+    str.replace(/([a-z])([A-Z])/g, "$1 $2").match(/[a-z0-9]+/gi) || [];
+  if (!words.length) return "";
+  return (
+    words[0].toLowerCase() +
+    words
+      .slice(1)
+      .map((w) => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
+      .join("")
+  );
+};
+
+export const kebabCase = (str) => {
+  const words =
+    str.replace(/([a-z])([A-Z])/g, "$1 $2").match(/[a-z0-9]+/gi) || [];
+  return words.map((w) => w.toLowerCase()).join("-");
 };

package/utils/file.util.js

@@ -0,0 +1,46 @@
+import fs from "fs-extra";
+import path from "path";
+import ejs from "ejs";
+import logger from "./logger.util.js";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+class FileUtil {
+  /**
+   * Ensure directories exist.
+   * @param {string} basePath Base directory path
+   * @param {string[]} dirs Array of relative directory paths
+   */
+  static ensureDirectories(basePath, dirs) {
+    dirs.forEach((dir) => {
+      const fullPath = path.join(basePath, dir);
+      fs.ensureDirSync(fullPath);
+    });
+  }
+
+  /**
+   * Render EJS template and write to an output path.
+   * @param {string} templatePath Template path relative to templates folder
+   * @param {Object} data Template data
+   * @param {string} outputPath Target output path relative to basePath
+   */
+  static async renderAndWrite(templatePath, data, outputPath) {
+    try {
+      const absoluteTemplatePath = path.join(
+        __dirname,
+        "../templates",
+        templatePath,
+      );
+      const templateContent = await ejs.renderFile(absoluteTemplatePath, data);
+      fs.writeFileSync(outputPath, templateContent);
+      logger.step(`Created ${path.basename(outputPath)}`);
+    } catch (error) {
+      logger.error(`Failed to process template: ${templatePath}`, error);
+      throw error;
+    }
+  }
+}
+
+export default FileUtil;

package/utils/logger.util.js

@@ -0,0 +1,30 @@
+import chalk from "chalk";
+
+export default class Logger {
+  static info(message) {
+    console.log(chalk.blue("ℹ INFO: ") + message);
+  }
+
+  static success(message) {
+    console.log(chalk.green("✔ SUCCESS: ") + message);
+  }
+
+  static warn(message) {
+    console.log(chalk.yellow("⚠ WARNING: ") + message);
+  }
+
+  static error(message, error = null) {
+    console.error(chalk.red("✖ ERROR: ") + message);
+    if (error) {
+      if (error.stack) {
+        console.error(chalk.red(error.stack));
+      } else {
+        console.error(chalk.red(error));
+      }
+    }
+  }
+
+  static step(message) {
+    console.log(chalk.cyan("➜ ") + message);
+  }
+}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/custom.md

@@ -1,10 +0,0 @@
----
-name: Custom issue template
-about: Describe this issue template's purpose here.
-title: ''
-labels: ''
-assignees: ''
-
----
-
-

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/workflows/ci.yml

@@ -1,28 +0,0 @@
-name: CI
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18, 20]
-    steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Cache node modules
-        uses: actions/cache@v4
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-      - name: Install dependencies
-        run: npm ci
-      - name: Run tests
-        run: npm test

package/.github/workflows/release.yml

@@ -1,31 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - 'v*.*.*'
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          registry-url: 'https://registry.npmjs.org'
-
-      - name: Install deps
-        run: npm install
-
-      - name: Run test
-        run: npm test
-
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/DOCS_STEPS.md

@@ -1,40 +0,0 @@
-# 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*

package/src/modules/Auth/Auth.module.js

@@ -1,15 +0,0 @@
-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(),
-  });
-}

package/src/modules/Auth/application/dtos/auth.dto.js

@@ -1,10 +0,0 @@
-// DTO Template
-export default {
-  // Define DTO validation schemas here (e.g. Joi, Zod)
-  createSchema: {
-    // rules
-  },
-  updateSchema: {
-    // rules
-  }
-};

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

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

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

@@ -1,30 +0,0 @@
-import { jest, describe, it, expect, beforeEach } from '@jest/globals';
-import AuthUseCase from './AuthUseCase.js';
-
-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: mockResult });
-    });
-  });
-});

package/src/modules/Auth/domain/entities/Auth.js

@@ -1,5 +0,0 @@
-export default class Auth {
-  constructor(props) {
-    Object.assign(this, props);
-  }
-}

package/src/modules/Auth/domain/repositories/AuthRepository.js

@@ -1,9 +0,0 @@
-export default class AuthRepository {
-  async findById(id) {
-    throw new Error('Method not implemented.');
-  }
-
-  async create(data) {
-    throw new Error('Method not implemented.');
-  }
-}

package/src/modules/Auth/infrastructure/repositories/PrismaAuthRepository.js

@@ -1,15 +0,0 @@
-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 });
-  }
-}

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

@@ -1,15 +0,0 @@
-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);
-    }
-  }
-}

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

@@ -1,49 +0,0 @@
-import { jest, describe, it, expect, beforeEach } from '@jest/globals';
-import AuthController from './AuthController.js';
-
-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);
-    });
-  });
-});

package/src/modules/Auth/interfaces/routes/auth.routes.js

@@ -1,9 +0,0 @@
-// routes
-export default ({ authController }) => {
-  const express = require('express');
-  const router = express.Router();
-  
-  router.get('/', authController.index.bind(authController));
-  
-  return router;
-};

package/src/modules/Auth/package.json

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

package/src/modules/order/application/usecases/create-order.usecase.js

@@ -1,15 +0,0 @@
-class CreateOrderUseCase {
-  constructor({ orderRepository }) {
-    this.orderRepository = orderRepository;
-  }
-
-  async execute(dto) {
-    // Validate DTO...
-    // Apply business logic...
-    
-    const entity = await this.orderRepository.save(dto);
-    return entity;
-  }
-}
-
-module.exports = CreateOrderUseCase;

package/src/modules/order/application/usecases/create-order.usecase.test.js

@@ -1,26 +0,0 @@
-const CreateOrderUseCase = require('./create-order.usecase');
-
-describe('CreateOrderUseCase', () => {
-  let useCase;
-  let mockRepository;
-
-  beforeEach(() => {
-    mockRepository = {
-      save: jest.fn()
-    };
-    useCase = new CreateOrderUseCase({ orderRepository: mockRepository });
-  });
-
-  describe('execute', () => {
-    it('should save data using the repository and return the entity', async () => {
-      const mockDto = { name: 'Test' };
-      const mockEntity = { id: 1, ...mockDto };
-      mockRepository.save.mockResolvedValue(mockEntity);
-
-      const result = await useCase.execute(mockDto);
-
-      expect(mockRepository.save).toHaveBeenCalledWith(mockDto);
-      expect(result).toEqual(mockEntity);
-    });
-  });
-});

package/src/modules/order/domain/entities/order.entity.js

@@ -1,8 +0,0 @@
-class OrderEntity {
-  constructor({ id, ...props }) {
-    this.id = id;
-    Object.assign(this, props);
-  }
-}
-
-module.exports = OrderEntity;

package/src/modules/order/domain/repositories/order.repository.interface.js

@@ -1,11 +0,0 @@
-class IOrderRepository {
-  async save(entity) {
-    throw new Error('Method not implemented.');
-  }
-
-  async findById(id) {
-    throw new Error('Method not implemented.');
-  }
-}
-
-module.exports = IOrderRepository;

package/src/modules/order/infrastructure/repositories/order.repository.impl.js

@@ -1,23 +0,0 @@
-const IOrderRepository = require('../../domain/repositories/order.repository.interface');
-const OrderEntity = require('../../domain/entities/order.entity');
-
-class OrderRepositoryImpl extends IOrderRepository {
-  // If using Prisma, you would do: constructor({ prisma }) { super(); this.prisma = prisma; }
-  constructor() {
-    super();
-    this.db = new Map();
-  }
-
-  async save(dto) {
-    const id = Date.now().toString(); // Mock ID generation
-    const entity = new OrderEntity({ id, ...dto });
-    this.db.set(id, entity);
-    return entity;
-  }
-
-  async findById(id) {
-    return this.db.get(id) || null;
-  }
-}
-
-module.exports = OrderRepositoryImpl;

package/src/modules/order/infrastructure/validation/create-order.schema.js

@@ -1,7 +0,0 @@
-const Joi = require('joi'); // Usually you'd use joi or another lib
-
-const createOrderSchema = Joi.object({
-  // Define DTO validation rules
-});
-
-module.exports = createOrderSchema;