nodejs-quickstart-structure 1.6.1 → 1.8.0

package/lib/prompts.js

@@ -1,7 +1,7 @@
 import inquirer from 'inquirer';
 
 const validateName = (name) => {
-    return /^[a-zA-Z0-9-_]+$/.test(name) ? true : 'Project name may only include letters, numbers, underscores and hashes.';
+    return /^[a-zA-Z0-9-_]+$/.test(name) ? true : 'Project name may only include letters, numbers, underscores and dashes.';
 };
 
 export const getProjectDetails = async (options = {}) => {
@@ -62,11 +62,19 @@ export const getProjectDetails = async (options = {}) => {
             default: 'REST APIs',
             when: !options.communication
         },
+        {
+            type: 'list',
+            name: 'caching',
+            message: 'Caching Layer:',
+            choices: ['None', 'Redis'],
+            default: 'None',
+            when: (answers) => !options.caching && (options.database || answers.database) !== 'None'
+        },
         {
             type: 'list',
             name: 'ciProvider',
             message: 'Select CI/CD Provider:',
-            choices: ['None', 'GitHub Actions', 'Jenkins'],
+            choices: ['None', 'GitHub Actions', 'Jenkins', 'GitLab CI'],
             default: 'None',
             when: !options.ciProvider
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodejs-quickstart-structure",
-  "version": "1.6.1",
+  "version": "1.8.0",
   "type": "module",
   "description": "A CLI to scaffold Node.js microservices with MVC or Clean Architecture",
   "main": "bin/index.js",

package/templates/clean-architecture/ts/src/config/swagger.ts.ejs

@@ -1,5 +1,4 @@
-<% if (communication === 'REST APIs') { %>
-import swaggerJsdoc from 'swagger-jsdoc';
+<% if (communication === 'REST APIs') { %>import swaggerJsdoc from 'swagger-jsdoc';
 
 const options = {
   definition: {

package/templates/common/.env.example.ejs

@@ -0,0 +1,39 @@
+# Application
+PORT=3000
+NODE_ENV=development
+
+<%_ if (database !== 'None') { -%>
+# Database
+<%_ if (database === 'MySQL') { -%>
+DB_HOST=localhost
+DB_PORT=3306
+DB_USER=root
+DB_PASSWORD=root
+DB_NAME=<%= dbName %>
+<%_ } -%>
+<%_ if (database === 'PostgreSQL') { -%>
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=root
+DB_NAME=<%= dbName %>
+<%_ } -%>
+<%_ if (database === 'MongoDB') { -%>
+DB_URI=mongodb://localhost:27017/<%= dbName %>
+<%_ } -%>
+<%_ } -%>
+
+
+<%_ if (communication === 'Kafka') { -%>
+# Communication
+KAFKA_BROKER=localhost:9092
+KAFKA_CLIENT_ID=<%= projectName %>
+KAFKA_GROUP_ID=<%= projectName %>-group
+<%_ } -%>
+
+<%_ if (caching === 'Redis') { -%>
+# Caching
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_PASSWORD=
+<%_ } -%>

package/templates/common/.gitlab-ci.yml.ejs

@@ -0,0 +1,35 @@
+variables:
+  NODE_ENV: 'test'
+
+stages:
+  - lint
+  - test
+  - build
+
+cache:
+  paths:
+    - node_modules/
+
+install_dependencies:
+  stage: .pre
+  image: node:18-alpine
+  script:
+    - npm ci
+
+lint_code:
+  stage: lint
+  image: node:18-alpine
+  script:
+    - npm run lint
+
+run_tests:
+  stage: test
+  image: node:18-alpine
+  script:
+    - npm test
+
+build_app:
+  stage: build
+  image: node:18-alpine
+  script:
+    - npm run build --if-present

package/templates/common/Jenkinsfile.ejs

@@ -24,6 +24,47 @@ pipeline {
                 sh 'npm test'
             }
         }
+
+        // stage('Build') {
+        //     steps {
+        //         sh 'npm run build'
+        //     }
+        // }
+
+        // stage('SonarQube Analysis') {
+        //     environment {
+        //         scannerHome = tool 'SonarScanner'
+        //     }
+        //     steps {
+        //         withSonarQubeEnv('SonarQube') {
+        //             sh "${scannerHome}/bin/sonar-scanner"
+        //         }
+        //     }
+        // }
+
+        // stage('Security Scan') {
+        //     steps {
+        //         sh 'npm audit --audit-level=high'
+        //     }
+        // }
+
+        // stage('Docker Build & Push') {
+        //     steps {
+        //         script {
+        //             docker.withRegistry('https://registry.hub.docker.com', 'docker-hub-credentials') {
+        //                 def appImage = docker.build("my-image:${env.BUILD_ID}")
+        //                 appImage.push()
+        //                 appImage.push("latest")
+        //             }
+        //         }
+        //     }
+        // }
+
+        // stage('Deploy to Staging') {
+        //     steps {
+        //         sh './scripts/deploy.sh staging'
+        //     }
+        // }
     }
 
     post {

package/templates/common/README.md.ejs

@@ -1,107 +1,122 @@
-# <%= projectName %>
-
-![Node.js](https://img.shields.io/badge/Node.js-18%2B-green.svg)
-![License](https://img.shields.io/badge/License-ISC-blue.svg)
-<% if (language === 'TypeScript') { %>![TypeScript](https://img.shields.io/badge/Language-TypeScript-blue.svg)<% } else { %>![JavaScript](https://img.shields.io/badge/Language-JavaScript-yellow.svg)<% } %>
-
-A production-ready Node.js microservice generated with **<%= architecture %>** and **<%= database %>**.
-This project comes pre-configured with industry-standard tooling for **Code Quality**, **Testing**, and **Security**.
-
-## 🚀 Key Features
-
--   **Architecture**: <%= architecture %> (<% if (architecture === 'Clean Architecture') { %>Domain, UseCases, Infrastructure<% } else { %>MVC Pattern<% } %>).
--   **Database**: <%= database %> <% if (database !== 'MongoDB') { %>with **Flyway** migrations<% } else { %>with **Mongoose** schemas<% } %>.
--   **Security**: Helmet, CORS, Rate Limiting, HPP.
--   **Quality**: Eslint, Prettier, Husky, Lint-Staged.
--   **Testing**: Jest (Unit & Integration).
--   **DevOps**: Multi-stage Docker build, CI/CD ready.
-
-## 🔄 CI/CD Pipeline
-<% if (ciProvider === 'GitHub Actions') { -%>
-This project includes a **GitHub Actions** workflow located in `.github/workflows/ci.yml`.
-It automatically runs:
--   Linting
--   Tests
--   Builds
-<% } else if (ciProvider === 'Jenkins') { -%>
-This project includes a **Jenkinsfile** for comprehensive CI/CD.
-Pipeline stages:
--   Install Dependencies
--   Lint
--   Test
-<% } else { -%>
-CI/CD is not currently configured, but the project is ready for integration.
-<% } -%>
-
-## 🛠️ Getting Started
-
-### 1. Prerequisites
--   Node.js (v18+)
--   Docker & Docker Compose
-
-### 2. Quick Start
-```bash
-# Initialize Git (Required for Husky)
-git init
-
-# Install dependencies
-npm install
-
-# Setup Git Hooks (Husky)
-npm run prepare
-
-# Start Infrastructure (DB, etc.)
-docker-compose up -d
-
-# Run Development Server
-npm run dev
-```
-
-### 3. Development Standards
-Ensure your code meets quality standards before committing:
-
-```bash
-# Run Linter
-npm run lint
-
-# Run Tests
-npm test
-
-# Format Code
-npm run format
-```
-
-## 📂 Project Structure
-
-The project follows **<%= architecture %>** principles.
-<% if (communication === 'Kafka') { -%>
-Microservices communication handled via **Kafka**.
-<% } else { -%>
-API is exposed via **REST**.
-A Swagger UI for API documentation is available at:
-- **URL**: `http://localhost:3000/api-docs` (Dynamic based on PORT)
-<% } -%>
-
-## 📝 Logging
-This project uses **Winston** for structured logging.
-- **Development**: Logs are printed to the console.
-- **Production**: Logs are saved to files:
-  - `error.log`: Only error level logs.
-  - `combined.log`: All logs.
-
-## 🐳 Docker Deployment
-This project uses a **Multi-Stage Dockerfile** for optimized production images.
-
-```bash
-# Build Production Image
-docker build -t <%= projectName %> .
-
-# Run Container
-docker run -p 3000:3000 -e DATABASE_URL=... <%= projectName %>
-```
-
-## 🔒 Security Features
--   **Helmet**: Sets secure HTTP headers.
--   **CORS**: Configured for cross-origin requests.
--   **Rate Limiting**: Protects against DDoS / Brute-force.
+# <%= projectName %>
+
+![Node.js](https://img.shields.io/badge/Node.js-18%2B-green.svg)
+![License](https://img.shields.io/badge/License-ISC-blue.svg)
+<% if (language === 'TypeScript') { %>![TypeScript](https://img.shields.io/badge/Language-TypeScript-blue.svg)<% } else { %>![JavaScript](https://img.shields.io/badge/Language-JavaScript-yellow.svg)<% } %>
+
+A production-ready Node.js microservice generated with **<%= architecture %>** and **<%= database %>**.
+This project comes pre-configured with industry-standard tooling for **Code Quality**, **Testing**, and **Security**.
+
+## 🚀 Key Features
+
+-   **Architecture**: <%= architecture %> (<% if (architecture === 'Clean Architecture') { %>Domain, UseCases, Infrastructure<% } else { %>MVC Pattern<% } %>).
+-   **Database**: <%= database %> <% if (database !== 'MongoDB') { %>with **Flyway** migrations<% } else { %>with **Mongoose** schemas<% } %>.
+-   **Security**: Helmet, CORS, Rate Limiting, HPP.
+-   **Quality**: Eslint, Prettier, Husky, Lint-Staged.
+-   **Testing**: Jest (Unit & Integration).
+-   **DevOps**: Multi-stage Docker build, CI/CD ready.
+
+## 🔄 CI/CD Pipeline
+<%_ if (ciProvider === 'GitHub Actions') { -%>
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/yourusername/<%= projectName %>/ci.yml?branch=main)
+This project includes a **GitHub Actions** workflow located in `.github/workflows/ci.yml`.
+It automatically runs:
+-   Linting
+-   Tests
+-   Builds
+<%_ } else if (ciProvider === 'GitLab CI') { -%>
+![GitLab CI Status](https://img.shields.io/gitlab/pipeline/yourusername/<%= projectName %>?branch=main)
+This project includes a **GitLab CI** configuration in `.gitlab-ci.yml`.
+It automatically runs:
+-   Linting
+-   Tests
+-   Builds
+<% } else if (ciProvider === 'Jenkins') { -%>
+This project includes a **Jenkinsfile** for comprehensive CI/CD.
+Pipeline stages:
+-   Install Dependencies
+-   Lint
+-   Test
+<% } else { -%>
+CI/CD is not currently configured, but the project is ready for integration.
+<% } -%>
+
+## 🛠️ Getting Started
+
+### 1. Prerequisites
+-   Node.js (v18+)
+-   Docker & Docker Compose
+
+### 2. Quick Start
+```bash
+# Initialize Git (Required for Husky)
+git init
+
+# Install dependencies
+npm install
+
+# Setup Git Hooks (Husky)
+npm run prepare
+
+# Start Infrastructure (DB, etc.)
+docker-compose up -d
+
+# Run Development Server
+npm run dev
+```
+
+### 3. Development Standards
+Ensure your code meets quality standards before committing:
+
+```bash
+# Run Linter
+npm run lint
+
+# Run Tests
+npm test
+
+# Format Code
+npm run format
+```
+
+## 📂 Project Structure
+
+The project follows **<%= architecture %>** principles.
+<% if (communication === 'Kafka') { -%>
+Microservices communication handled via **Kafka**.
+<% } else { -%>
+API is exposed via **REST**.
+A Swagger UI for API documentation is available at:
+- **URL**: `http://localhost:3000/api-docs` (Dynamic based on PORT)
+<% } -%>
+
+<% if (caching === 'Redis') { -%>
+## ⚡ Caching
+This project uses **Redis** for caching.
+- **Client**: `ioredis`
+- **Connection**: Configured via `REDIS_HOST`, `REDIS_PORT`, `REDIS_PASSWORD` in `.env`.
+<% } -%>
+
+## 📝 Logging
+This project uses **Winston** for structured logging.
+- **Development**: Logs are printed to the console.
+- **Production**: Logs are saved to files:
+  - `error.log`: Only error level logs.
+  - `combined.log`: All logs.
+
+## 🐳 Docker Deployment
+This project uses a **Multi-Stage Dockerfile** for optimized production images.
+
+```bash
+# Build Production Image
+docker build -t <%= projectName %> .
+
+# Run Container
+docker run -p 3000:3000 -e DATABASE_URL=... <%= projectName %>
+```
+
+## 🔒 Security Features
+-   **Helmet**: Sets secure HTTP headers.
+-   **CORS**: Configured for cross-origin requests.
+-   **Rate Limiting**: Protects against DDoS / Brute-force.
 -   **HPP**: Prevents HTTP Parameter Pollution attacks.

package/templates/common/caching/clean/js/CreateUser.js.ejs

@@ -0,0 +1,25 @@
+const User = require('../domain/models/User');
+const redis = require('../infrastructure/caching/redisClient');
+const logger = require('../infrastructure/log/logger');
+
+class CreateUser {
+    constructor(userRepository) {
+        this.userRepository = userRepository;
+    }
+
+    async execute(name, email) {
+        const user = new User(null, name, email);
+        const savedUser = await this.userRepository.save(user);
+
+        try {
+            await redis.del('users:all');
+            logger.info('Invalidated users:all cache');
+        } catch (error) {
+            logger.error('Redis error (del):', error);
+        }
+
+        return savedUser;
+    }
+}
+
+module.exports = CreateUser;

package/templates/common/caching/clean/js/GetAllUsers.js.ejs

@@ -0,0 +1,33 @@
+const redis = require('../infrastructure/caching/redisClient');
+const logger = require('../infrastructure/log/logger');
+
+class GetAllUsers {
+    constructor(userRepository) {
+        this.userRepository = userRepository;
+    }
+
+    async execute() {
+        const cacheKey = 'users:all';
+        try {
+            const cachedUsers = await redis.get(cacheKey);
+            if (cachedUsers) {
+                logger.info('Serving users from cache');
+                return cachedUsers;
+            }
+        } catch (error) {
+            logger.error('Redis error (get):', error);
+        }
+
+        const users = await this.userRepository.getUsers();
+
+        try {
+            await redis.set(cacheKey, users, 60);
+        } catch (error) {
+            logger.error('Redis error (set):', error);
+        }
+
+        return users;
+    }
+}
+
+module.exports = GetAllUsers;

package/templates/common/caching/clean/ts/createUser.ts.ejs

@@ -0,0 +1,23 @@
+import { User } from '@/domain/user';
+
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+import redis from '@/infrastructure/caching/redisClient';
+import logger from '@/infrastructure/log/logger';
+
+export default class CreateUser {
+    constructor(private userRepository: UserRepository) {}
+
+    async execute(name: string, email: string) {
+        const user = new User(null, name, email);
+        const savedUser = await this.userRepository.save(user);
+
+        try {
+            await redis.del('users:all');
+            logger.info('Invalidated users:all cache');
+        } catch (error) {
+            logger.error('Redis error (del):', error);
+        }
+
+        return savedUser;
+    }
+}

package/templates/common/caching/clean/ts/getAllUsers.ts.ejs

@@ -0,0 +1,30 @@
+import { UserRepository } from '@/infrastructure/repositories/UserRepository';
+import redis from '@/infrastructure/caching/redisClient';
+import logger from '@/infrastructure/log/logger';
+
+export default class GetAllUsers {
+    constructor(private userRepository: UserRepository) {}
+
+    async execute() {
+        const cacheKey = 'users:all';
+        try {
+            const cachedUsers = await redis.get(cacheKey);
+            if (cachedUsers) {
+                logger.info('Serving users from cache');
+                return cachedUsers;
+            }
+        } catch (error) {
+            logger.error('Redis error (get):', error);
+        }
+
+        const users = await this.userRepository.getUsers();
+
+        try {
+            await redis.set(cacheKey, users, 60);
+        } catch (error) {
+            logger.error('Redis error (set):', error);
+        }
+
+        return users;
+    }
+}

package/templates/common/caching/js/redisClient.js.ejs

@@ -0,0 +1,71 @@
+const Redis = require('ioredis');
+require('dotenv').config();
+const logger = require('<%- loggerPath %>');
+
+class RedisService {
+    constructor() {
+        this.client = new Redis({
+            host: process.env.REDIS_HOST || 'localhost',
+            port: Number(process.env.REDIS_PORT) || 6379,
+            password: process.env.REDIS_PASSWORD || undefined,
+            retryStrategy: (times) => Math.min(times * 50, 2000),
+        });
+
+        this.client.on('connect', () => {
+            logger.info('Redis connected');
+        });
+
+        this.client.on('error', (err) => {
+            logger.error('Redis error:', err);
+        });
+    }
+
+    static getInstance() {
+        if (!RedisService.instance) {
+            RedisService.instance = new RedisService();
+        }
+        return RedisService.instance;
+    }
+
+    async get(key) {
+        try {
+            const data = await this.client.get(key);
+            return data ? JSON.parse(data) : null;
+        } catch (error) {
+            logger.error(`Redis get error for key ${key}:`, error);
+            return null;
+        }
+    }
+
+    async set(key, value, ttl) {
+        try {
+            const data = JSON.stringify(value);
+            if (ttl) {
+                await this.client.set(key, data, 'EX', ttl);
+            } else {
+                await this.client.set(key, data);
+            }
+        } catch (error) {
+            logger.error(`Redis set error for key ${key}:`, error);
+        }
+    }
+
+    async del(key) {
+        try {
+            await this.client.del(key);
+        } catch (error) {
+            logger.error(`Redis del error for key ${key}:`, error);
+        }
+    }
+
+    async getOrSet(key, fetcher, ttl = 3600) {
+        const cached = await this.get(key);
+        if (cached) return cached;
+
+        const data = await fetcher();
+        if (data) await this.set(key, data, ttl);
+        return data;
+    }
+}
+
+module.exports = RedisService.getInstance();

package/templates/common/caching/ts/redisClient.ts.ejs

@@ -0,0 +1,76 @@
+import Redis from 'ioredis';
+import dotenv from 'dotenv';
+import logger from '<%- loggerPath %>';
+
+dotenv.config();
+
+class RedisService {
+    private client: Redis;
+    private static instance: RedisService;
+
+    private constructor() {
+        this.client = new Redis({
+            host: process.env.REDIS_HOST || 'localhost',
+            port: Number(process.env.REDIS_PORT) || 6379,
+            password: process.env.REDIS_PASSWORD || undefined,
+            retryStrategy: (times) => Math.min(times * 50, 2000),
+        });
+
+        this.client.on('connect', () => {
+            logger.info('Redis connected');
+        });
+
+        this.client.on('error', (err) => {
+            logger.error('Redis error:', err);
+        });
+    }
+
+    public static getInstance(): RedisService {
+        if (!RedisService.instance) {
+            RedisService.instance = new RedisService();
+        }
+        return RedisService.instance;
+    }
+
+    public async get<T>(key: string): Promise<T | null> {
+        try {
+            const data = await this.client.get(key);
+            return data ? JSON.parse(data) : null;
+        } catch (error) {
+            logger.error(`Redis get error for key ${key}:`, error);
+            return null;
+        }
+    }
+
+    public async set(key: string, value: unknown, ttl?: number): Promise<void> {
+        try {
+            const data = JSON.stringify(value);
+            if (ttl) {
+                await this.client.set(key, data, 'EX', ttl);
+            } else {
+                await this.client.set(key, data);
+            }
+        } catch (error) {
+            logger.error(`Redis set error for key ${key}:`, error);
+        }
+    }
+
+    public async del(key: string): Promise<void> {
+        try {
+            await this.client.del(key);
+        } catch (error) {
+            logger.error(`Redis del error for key ${key}:`, error);
+        }
+    }
+
+    public async getOrSet<T>(key: string, fetcher: () => Promise<T>, ttl: number = 3600): Promise<T> {
+        const cached = await this.get<T>(key);
+        if (cached) return cached;
+
+        const data = await fetcher();
+        if (data) await this.set(key, data, ttl);
+        return data;
+    }
+}
+
+export default RedisService.getInstance();