nodejs-quickstart-structure 1.1.11 → 1.3.2

package/README.md

@@ -22,7 +22,7 @@ We don't just generate boilerplate; we generate **production-ready** foundations
 -   **🔍 Code Quality**: Pre-configured `Eslint` and `Prettier` for consistent coding standards.
 -   **🛡️ Security**: Built-in `Helmet`, `HPP`, `CORS`, and Rate-Limiting middleware.
 -   **🧪 Testing Strategy**: Integrated `Jest` and `Supertest` setup for Unit and Integration testing.
--   **🔄 CI/CD Support**: Optional **GitHub Actions** workflow integration.
+-   **🔄 CI/CD Support**: Choice between **GitHub Actions** and **Jenkins**.
 -   **⚓ Git Hooks**: `Husky` and `Lint-Staged` to ensure no bad code is ever committed.
 -   **🐳 DevOps**: Highly optimized **Multi-Stage Dockerfile** for small, secure production images.
 
@@ -70,7 +70,7 @@ The CLI will guide you through the following steps:
 4.  **Database**: `MySQL` or `PostgreSQL`.
 5.  **Database Name**: The name of the initial database.
 6.  **Communication**: `REST APIs` (default) or `Kafka`.
-7.  **CI/CD**: `Include GitHub Actions Workflow` (Optional).
+7.  **CI/CD**: `GitHub Actions`, `Jenkins`, or `None`.
 
 ## Generated Project Structure
 

package/bin/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import { Command } from 'commander';
 import chalk from 'chalk';
@@ -32,12 +32,11 @@ program
     .option('-d, --database <database>', 'Database (MySQL, PostgreSQL)')
     .option('--db-name <name>', 'Database name')
     .option('-c, --communication <communication>', 'Communication (REST APIs, Kafka)')
-    .option('--include-ci', 'Include GitHub Actions CI Workflow')
+    .option('--ci-provider <provider>', 'CI/CD Provider (None, GitHub Actions, Jenkins)')
     .action(async (options) => {
         // Fix for Commander camelCase conversion
-        if (options.includeCi) {
-            options.includeCI = options.includeCi;
-            delete options.includeCi;
+        if (options.ciProvider) {
+            options.ciProvider = options.ciProvider;
         }
 
         console.log(chalk.blue('Welcome to the Node.js Quickstart Generator!'));
@@ -58,7 +57,6 @@ program
             process.exit(1);
         }
     });
-
 program.parse(process.argv);
 
 if (!process.argv.slice(2).length) {

package/lib/generator.js

@@ -7,7 +7,7 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 export const generateProject = async (config) => {
-    const { projectName, architecture, database, dbName, communication, language, viewEngine, includeCI } = config;
+    const { projectName, architecture, database, dbName, communication, language, viewEngine, ciProvider } = config;
     const targetDir = path.resolve(process.cwd(), projectName);
     const templatesDir = path.join(__dirname, '../templates');
 
@@ -60,7 +60,8 @@ export const generateProject = async (config) => {
         architecture,
         database,
         communication,
-        language
+        language,
+        ciProvider
     });
     await fs.writeFile(readmePath, readmeContent);
 
@@ -275,9 +276,16 @@ export const generateProject = async (config) => {
     await fs.writeFile(path.join(targetDir, 'tests', testFileName), healthTestContent);
 
     // 11. Copy CI/CD Config (Optional)
-    if (includeCI) {
+    // 11. Copy CI/CD Config
+    if (ciProvider === 'GitHub Actions') {
         await fs.ensureDir(path.join(targetDir, '.github/workflows'));
         await fs.copy(path.join(templatesDir, 'common', '_github/workflows/ci.yml'), path.join(targetDir, '.github/workflows/ci.yml'));
+    } else if (ciProvider === 'Jenkins') {
+        const jenkinsTemplate = await fs.readFile(path.join(templatesDir, 'common', 'Jenkinsfile.ejs'), 'utf-8');
+        const jenkinsContent = ejs.render(jenkinsTemplate, {
+             projectName
+        });
+        await fs.writeFile(path.join(targetDir, 'Jenkinsfile'), jenkinsContent);
     }
 
     console.log(`
@@ -299,7 +307,7 @@ export const generateProject = async (config) => {
       ✅  Security: Helmet, CORS, Rate-Limiting added
       ✅  Testing: Jest setup for Unit/Integration tests
       ✅  Docker: Production-ready multi-stage build
-      ${includeCI ? '✅  CI/CD: GitHub Actions Workflow ready' : '❌  CI/CD: Skipped (User preferred)'}
+      ${ciProvider !== 'None' ? `✅  CI/CD: ${ciProvider} Workflow ready` : '❌  CI/CD: Skipped (User preferred)'}
 
       ----------------------------------------------------
       👉  Next Steps:

package/lib/prompts.js

@@ -63,11 +63,12 @@ export const getProjectDetails = async (options = {}) => {
             when: !options.communication
         },
         {
-            type: 'confirm',
-            name: 'includeCI',
-            message: 'Include GitHub Actions CI Workflow? (Professional CI/CD pipeline included)',
-            default: false,
-            when: !options.includeCI
+            type: 'list',
+            name: 'ciProvider',
+            message: 'Select CI/CD Provider:',
+            choices: ['None', 'GitHub Actions', 'Jenkins'],
+            default: 'None',
+            when: !options.ciProvider
         }
     ];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodejs-quickstart-structure",
-  "version": "1.1.11",
+  "version": "1.3.2",
   "type": "module",
   "description": "A CLI to scaffold Node.js microservices with MVC or Clean Architecture",
   "main": "bin/index.js",
@@ -20,7 +20,7 @@
     "mvc",
     "clean-architecture"
   ],
-  "author": "Pau Dang <paudang@example.com>",
+  "author": "Pau Dang <phucdangb1400718@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/paudang/nodejs-quickstart-structure.git"

package/templates/clean-architecture/js/src/infrastructure/webserver/server.js.ejs

@@ -1,11 +1,11 @@
 const express = require('express');
 const cors = require('cors');
 require('dotenv').config();
-<% if (communication === 'REST APIs') { %>const apiRoutes = require('../../interfaces/routes/api');<% } %>
-<% if (communication === 'REST APIs') { %>
+<% if (communication === 'REST APIs') { %>const apiRoutes = require('../../interfaces/routes/api');<% } -%>
+<% if (communication === 'REST APIs') { -%>
 const swaggerUi = require('swagger-ui-express');
 const swaggerSpecs = require('./swagger');
-<% } %>
+<% } -%>
 
 const startServer = (port) => {
     const app = express();
@@ -13,11 +13,13 @@ const startServer = (port) => {
     app.use(cors());
     app.use(express.json());
 
-    <% if (communication === 'REST APIs') { %>app.use('/api', apiRoutes);<% } %>
+    <% if (communication === 'REST APIs') { -%>
+    app.use('/api', apiRoutes);
+    <% } -%>
 
-    <% if (communication === 'REST APIs') { %>
+    <% if (communication === 'REST APIs') { -%>
     app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
-    <% } %>
+    <% } -%>
 
     app.get('/health', (req, res) => {
         res.json({ status: 'UP' });

package/templates/clean-architecture/ts/src/index.ts.ejs

@@ -5,11 +5,11 @@ import hpp from 'hpp';
 import rateLimit from 'express-rate-limit';
 import dotenv from 'dotenv';
 import logger from './infrastructure/log/logger';
-<% if (communication === 'REST APIs') { %>import userRoutes from './interfaces/routes/userRoutes';<% } %>
-<% if (communication === 'REST APIs') { %>
+<% if (communication === 'REST APIs') { %>import userRoutes from './interfaces/routes/userRoutes';<% } -%>
+<% if (communication === 'REST APIs') { -%>
 import swaggerUi from 'swagger-ui-express';
-import swaggerSpecs from './config/swagger';<% } %>
-<% if (communication === 'Kafka') { %>import { KafkaService } from './infrastructure/messaging/kafkaClient';<% } %>
+import swaggerSpecs from './config/swagger';<% } -%>
+<% if (communication === 'Kafka') { %>import { KafkaService } from './infrastructure/messaging/kafkaClient';<% } -%>
 
 dotenv.config();
 
@@ -26,10 +26,12 @@ app.use(limiter);
 app.use(express.json());
 
 <% if (communication === 'REST APIs') { -%>
-app.use('/api/users', userRoutes);<% } -%>
+app.use('/api/users', userRoutes);
+<% } -%>
 
-<% if (communication === 'REST APIs') { %>
-app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));<% } %>
+<% if (communication === 'REST APIs') { -%>
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
+<% } -%>
 
 app.get('/health', (req: Request, res: Response) => {
   res.json({ status: 'UP' });
@@ -46,7 +48,7 @@ const syncDatabase = async () => {
             
             app.listen(port, async () => {
               logger.info(`Server running on port ${port}`);
-              <% if (communication === 'Kafka') { %>
+<%_ if (communication === 'Kafka') { -%>
               try {
                 const kafkaService = new KafkaService();
                 await kafkaService.connect();
@@ -56,7 +58,7 @@ const syncDatabase = async () => {
               } catch (err) {
                 logger.error('Failed to connect to Kafka:', err);
               }
-              <% } -%>
+<%_ } -%>
             });
             break;
         } catch (err) {

package/templates/common/Jenkinsfile.ejs

@@ -0,0 +1,35 @@
+pipeline {
+    agent any
+
+    environment {
+        CI = 'true'
+    }
+
+    stages {
+        stage('Install Dependencies') {
+            steps {
+                // Use npm ci for clean install if package-lock.json exists, else npm install
+                sh 'if [ -f package-lock.json ]; then npm ci; else npm install; fi'
+            }
+        }
+
+        stage('Lint') {
+            steps {
+                sh 'npm run lint'
+            }
+        }
+
+        stage('Test') {
+            steps {
+                sh 'npm test'
+            }
+        }
+    }
+
+    post {
+        always {
+            // Clean up workspace
+            cleanWs()
+        }
+    }
+}

package/templates/common/README.md.ejs

@@ -16,6 +16,23 @@ This project comes pre-configured with industry-standard tooling for **Code Qual
 -   **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
@@ -24,6 +41,9 @@ This project comes pre-configured with industry-standard tooling for **Code Qual
 
 ### 2. Quick Start
 ```bash
+# Initialize Git (Required for Husky)
+git init
+
 # Install dependencies
 npm install
 

package/templates/mvc/js/src/index.js.ejs

@@ -1,12 +1,12 @@
 const express = require('express');
 const cors = require('cors');
 require('dotenv').config();
-<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>const apiRoutes = require('./routes/api');<% } %>
-<% if (communication === 'Kafka') { %>const { connectKafka, sendMessage } = require('./services/kafkaService');<% } %>
-<% if (communication === 'REST APIs') { %>
+<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>const apiRoutes = require('./routes/api');<% } -%>
+<% if (communication === 'Kafka') { %>const { connectKafka, sendMessage } = require('./services/kafkaService');<% } -%>
+<% if (communication === 'REST APIs') { -%>
 const swaggerUi = require('swagger-ui-express');
 const swaggerSpecs = require('./config/swagger');
-<% } %>
+<% } -%>
 
 const app = express();
 const PORT = process.env.PORT || 3000;
@@ -15,11 +15,11 @@ const logger = require('./utils/logger');
 app.use(cors());
 app.use(express.json());
 
-<% if (communication === 'REST APIs') { %>
+<% if (communication === 'REST APIs') { -%>
 app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
-<% } %>
+<% } -%>
 
-<% if (viewEngine === 'EJS' || viewEngine === 'Pug') { %>
+<% if (viewEngine === 'EJS' || viewEngine === 'Pug') { -%>
 // View Engine Setup
 const path = require('path');
 app.set('views', path.join(__dirname, 'views'));
@@ -57,7 +57,7 @@ const syncDatabase = async () => {
             // Start Server after DB is ready
             app.listen(PORT, async () => {
               logger.info(`Server running on port ${PORT}`);
-              <% if (communication === 'Kafka') { %>
+<%_ if (communication === 'Kafka') { -%>
               try {
                 await connectKafka();
                 logger.info('Kafka connected');
@@ -66,7 +66,7 @@ const syncDatabase = async () => {
               } catch (err) {
                 logger.error('Failed to connect to Kafka:', err);
               }
-              <% } -%>
+<%_ } -%>
             });
             break;
         } catch (err) {

package/templates/mvc/ts/src/index.ts.ejs

@@ -5,11 +5,11 @@ import hpp from 'hpp';
 import rateLimit from 'express-rate-limit';
 import dotenv from 'dotenv';
 import logger from './utils/logger';
-<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>import apiRoutes from './routes/api';<% } %>
+<% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { %>import apiRoutes from './routes/api';<% } -%>
 <% if (communication === 'REST APIs') { %>
 import swaggerUi from 'swagger-ui-express';
-import swaggerSpecs from './config/swagger';<% } %>
-<% if (communication === 'Kafka') { %>import { KafkaService } from './services/kafkaService';<% } %>
+import swaggerSpecs from './config/swagger';<% } -%>
+<% if (communication === 'Kafka') { %>import { KafkaService } from './services/kafkaService';<% } -%>
 
 dotenv.config();
 
@@ -25,18 +25,21 @@ app.use(limiter);
 
 app.use(express.json());
 
-<% if (communication === 'REST APIs') { %>
-app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));<% } %>
+<% if (communication === 'REST APIs') { -%>
+app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecs));
+<% } -%>
 
-<% if (viewEngine === 'EJS' || viewEngine === 'Pug') { %>
+<% if (viewEngine === 'EJS' || viewEngine === 'Pug') { -%>
 // View Engine Setup
 import path from 'path';
 app.set('views', path.join(__dirname, 'views'));
-app.set('view engine', '<%= viewEngine.toLowerCase() %>');<% } -%>
+app.set('view engine', '<%= viewEngine.toLowerCase() %>');
+<% } -%>
 
 // Routes
 <% if (communication === 'REST APIs' || (viewEngine && viewEngine !== 'None')) { -%>
-app.use('/api', apiRoutes);<% } -%>
+app.use('/api', apiRoutes);
+<% } -%>
 <% if (viewEngine && viewEngine !== 'None') { -%>
 app.get('/', (req: Request, res: Response) => {
   res.render('index', { 
@@ -64,7 +67,7 @@ const syncDatabase = async () => {
             // Start Server after DB is ready
             app.listen(port, async () => {
               logger.info(`Server running on port ${port}`);
-              <% if (communication === 'Kafka') { %>
+<%_ if (communication === 'Kafka') { -%>
               try {
                 const kafkaService = new KafkaService();
                 await kafkaService.connect();
@@ -74,7 +77,7 @@ const syncDatabase = async () => {
               } catch (err) {
                 logger.error('Failed to connect to Kafka:', err);
               }
-              <% } -%>
+<%_ } -%>
             });
             break;
         } catch (err) {