nodejs-quickstart-structure 1.18.1 → 1.19.1

package/lib/prompts.js

@@ -1,100 +1,100 @@
-import inquirer from 'inquirer';
-
-const validateName = (name) => {
-    return /^[a-zA-Z0-9-_]+$/.test(name) ? true : 'Project name may only include letters, numbers, underscores and dashes.';
-};
-
-export const getProjectDetails = async (options = {}) => {
-    const questions = [
-        {
-            type: 'input',
-            name: 'projectName',
-            message: 'Project name:',
-            default: 'nodejs-service',
-            validate: validateName,
-            when: !options.projectName
-        },
-        {
-            type: 'select',
-            name: 'language',
-            message: 'Select Language:',
-            choices: ['JavaScript', 'TypeScript'],
-            default: 'TypeScript',
-            when: !options.language
-        },
-        {
-            type: 'select',
-            name: 'architecture',
-            message: 'Select Architecture:',
-            choices: ['MVC', 'Clean Architecture'],
-            default: 'MVC',
-            when: !options.architecture
-        },
-        {
-            type: 'select',
-            name: 'viewEngine',
-            message: 'Select View Engine:',
-            choices: ['None', 'EJS', 'Pug'],
-            when: (answers) => (options.architecture || answers.architecture) === 'MVC' && !options.viewEngine,
-            default: 'None'
-        },
-        {
-            type: 'select',
-            name: 'database',
-            message: 'Select Database:',
-            choices: ['None', 'MySQL', 'PostgreSQL', 'MongoDB'],
-            default: 'None',
-            when: !options.database
-        },
-        {
-            type: 'input',
-            name: 'dbName',
-            message: 'Database Name:',
-            default: 'demo',
-            validate: validateName,
-            when: (answers) => !options.dbName && (options.database || answers.database) !== 'None'
-        },
-        {
-            type: 'select',
-            name: 'communication',
-            message: 'Microservices Communication:',
-            choices: ['REST APIs', 'GraphQL', 'Kafka'],
-            default: 'REST APIs',
-            when: !options.communication
-        },
-        {
-            type: 'select',
-            name: 'caching',
-            message: 'Caching Layer:',
-            choices: ['None', 'Redis', 'Memory Cache'],
-            default: 'None',
-            when: (answers) => !options.caching && (options.database || answers.database) !== 'None'
-        },
-        {
-            type: 'select',
-            name: 'ciProvider',
-            message: 'Select CI/CD Provider:',
-            choices: ['None', 'GitHub Actions', 'Jenkins', 'GitLab CI'],
-            default: 'None',
-            when: !options.ciProvider
-        },
-        {
-            type: 'select',
-            name: 'includeSecurity',
-            message: 'Include Enterprise Security Hardening (Big Tech Standard: Snyk, SonarQube)?',
-            choices: ['No', 'Yes'],
-            default: "No",
-            when: (answers) => !options.includeSecurity && (options.ciProvider || answers.ciProvider) !== 'None'
-        }
-    ];
-
-    const answers = await inquirer.prompt(questions);
-    const result = { ...options, ...answers };
-
-    // Normalize includeSecurity to boolean if it's a string from the select prompt
-    if (typeof result.includeSecurity === 'string') {
-        result.includeSecurity = result.includeSecurity === 'Yes';
-    }
-
-    return result;
-};
+import inquirer from 'inquirer';
+
+const validateName = (name) => {
+    return /^[a-zA-Z0-9-_]+$/.test(name) ? true : 'Project name may only include letters, numbers, underscores and dashes.';
+};
+
+export const getProjectDetails = async (options = {}) => {
+    const questions = [
+        {
+            type: 'input',
+            name: 'projectName',
+            message: 'Project name:',
+            default: 'nodejs-service',
+            validate: validateName,
+            when: !options.projectName
+        },
+        {
+            type: 'select',
+            name: 'language',
+            message: 'Select Language:',
+            choices: ['JavaScript', 'TypeScript'],
+            default: 'TypeScript',
+            when: !options.language
+        },
+        {
+            type: 'select',
+            name: 'architecture',
+            message: 'Select Architecture:',
+            choices: ['MVC', 'Clean Architecture'],
+            default: 'MVC',
+            when: !options.architecture
+        },
+        {
+            type: 'select',
+            name: 'viewEngine',
+            message: 'Select View Engine:',
+            choices: ['None', 'EJS', 'Pug'],
+            when: (answers) => (options.architecture || answers.architecture) === 'MVC' && !options.viewEngine,
+            default: 'None'
+        },
+        {
+            type: 'select',
+            name: 'database',
+            message: 'Select Database:',
+            choices: ['None', 'MySQL', 'PostgreSQL', 'MongoDB'],
+            default: 'None',
+            when: !options.database
+        },
+        {
+            type: 'input',
+            name: 'dbName',
+            message: 'Database Name:',
+            default: 'demo',
+            validate: validateName,
+            when: (answers) => !options.dbName && (options.database || answers.database) !== 'None'
+        },
+        {
+            type: 'select',
+            name: 'communication',
+            message: 'Microservices Communication:',
+            choices: ['REST APIs', 'GraphQL', 'Kafka'],
+            default: 'REST APIs',
+            when: !options.communication
+        },
+        {
+            type: 'select',
+            name: 'caching',
+            message: 'Caching Layer:',
+            choices: ['None', 'Redis', 'Memory Cache'],
+            default: 'None',
+            when: (answers) => !options.caching && (options.database || answers.database) !== 'None'
+        },
+        {
+            type: 'select',
+            name: 'ciProvider',
+            message: 'Select CI/CD Provider:',
+            choices: ['None', 'GitHub Actions', 'Jenkins', 'GitLab CI'],
+            default: 'None',
+            when: !options.ciProvider
+        },
+        {
+            type: 'select',
+            name: 'includeSecurity',
+            message: 'Include Enterprise Security Hardening (Big Tech Standard: Snyk, SonarQube)?',
+            choices: ['No', 'Yes'],
+            default: "No",
+            when: (answers) => !options.includeSecurity && (options.ciProvider || answers.ciProvider) !== 'None'
+        }
+    ];
+
+    const answers = await inquirer.prompt(questions);
+    const result = { ...options, ...answers };
+
+    // Normalize includeSecurity to boolean if it's a string from the select prompt
+    if (typeof result.includeSecurity === 'string') {
+        result.includeSecurity = result.includeSecurity === 'Yes';
+    }
+
+    return result;
+};

package/package.json

@@ -1,67 +1,78 @@
-{
-  "name": "nodejs-quickstart-structure",
-  "version": "1.18.1",
-  "type": "module",
-  "description": "The ultimate nodejs quickstart structure CLI to scaffold Node.js microservices with MVC or Clean Architecture",
-  "main": "bin/index.js",
-  "bin": {
-    "nodejs-quickstart": "./bin/index.js"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "test:e2e": "npm run test:e2e:windows",
-    "test:e2e:windows": "node scripts/validate-windows.js",
-    "test:e2e:linux": "node scripts/validate-linux.js",
-    "test:verify:mongo": "node scripts/verify-migration.js",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs",
-    "security:check": "npm audit && npm run snyk:test",
-    "snyk:test": "snyk test"
-  },
-  "keywords": [
-    "nodejs",
-    "node",
-    "quickstart",
-    "structure",
-    "cli",
-    "scaffold",
-    "mvc",
-    "clean-architecture",
-    "microservices",
-    "backend",
-    "generator",
-    "boilerplate"
-  ],
-  "author": "Pau Dang <[EMAIL_ADDRESS]>",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/paudang/nodejs-quickstart-structure.git"
-  },
-  "bugs": {
-    "url": "https://github.com/paudang/nodejs-quickstart-structure/issues"
-  },
-  "homepage": "https://github.com/paudang/nodejs-quickstart-structure#readme",
-  "license": "ISC",
-  "dependencies": {
-    "chalk": "^5.4.1",
-    "commander": "^14.0.3",
-    "ejs": "^5.0.1",
-    "fs-extra": "^11.3.0",
-    "inquirer": "^13.3.2"
-  },
-  "overrides": {
-    "esbuild": "^0.25.0"
-  },
-  "devDependencies": {
-    "snyk": "^1.1303.2",
-    "vitepress": "^1.0.0-rc.45"
-  },
-  "files": [
-    "bin",
-    "lib",
-    "templates",
-    "README.md",
-    "CHANGELOG.md"
-  ]
-}
+{
+  "name": "nodejs-quickstart-structure",
+  "version": "1.19.1",
+  "type": "module",
+  "description": "The ultimate nodejs quickstart structure CLI to scaffold Node.js microservices with MVC or Clean Architecture",
+  "main": "bin/index.js",
+  "bin": {
+    "nodejs-quickstart": "./bin/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "test:e2e": "npm run test:e2e:windows",
+    "test:e2e:windows": "node scripts/validate-windows.js",
+    "test:e2e:linux": "node scripts/validate-linux.js",
+    "test:verify:mongo": "node scripts/verify-migration.js",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs",
+    "security:check": "npm audit && npm run snyk:test",
+    "snyk:test": "snyk test"
+  },
+  "keywords": [
+    "nodejs",
+    "node",
+    "quickstart",
+    "structure",
+    "cli",
+    "scaffold",
+    "mvc",
+    "clean-architecture",
+    "microservices",
+    "backend",
+    "generator",
+    "boilerplate"
+  ],
+  "author": "Pau Dang <[phucdangb1400718@gmail.com]>",
+  "contributors": [
+    {
+      "name": "Pau Dang",
+      "url": "https://github.com/paudang"
+    },
+    {
+      "name": "Gemini AI",
+      "url": "https://deepmind.google/technologies/gemini/",
+      "role": "AI Architectural Assistant"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/paudang/nodejs-quickstart-structure.git"
+  },
+  "bugs": {
+    "url": "https://github.com/paudang/nodejs-quickstart-structure/issues"
+  },
+  "homepage": "https://github.com/paudang/nodejs-quickstart-structure#readme",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^14.0.3",
+    "ejs": "^5.0.1",
+    "fs-extra": "^11.3.0",
+    "inquirer": "^13.3.2"
+  },
+  "overrides": {
+    "esbuild": "^0.25.0"
+  },
+  "devDependencies": {
+    "snyk": "^1.1303.2",
+    "vitepress": "^1.0.0-rc.45"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "templates",
+    "README.md",
+    "CHANGELOG.md"
+  ]
+}

package/templates/clean-architecture/js/src/domain/models/User.js

@@ -1,9 +1,9 @@
-class User {
-    constructor(id, name, email) {
-        this.id = id;
-        this.name = name;
-        this.email = email;
-    }
-}
-
-module.exports = User;
+class User {
+    constructor(id, name, email) {
+        this.id = id;
+        this.name = name;
+        this.email = email;
+    }
+}
+
+module.exports = User;

package/templates/clean-architecture/js/src/errors/ApiError.js

@@ -1,14 +1,14 @@
-class ApiError extends Error {
-  constructor(statusCode, message, isOperational = true, stack = '') {
-    super(message);
-    this.statusCode = statusCode;
-    this.isOperational = isOperational;
-    if (stack) {
-      this.stack = stack;
-    } else {
-      Error.captureStackTrace(this, this.constructor);
-    }
-  }
-}
-
-module.exports = { ApiError };
+class ApiError extends Error {
+  constructor(statusCode, message, isOperational = true, stack = '') {
+    super(message);
+    this.statusCode = statusCode;
+    this.isOperational = isOperational;
+    if (stack) {
+      this.stack = stack;
+    } else {
+      Error.captureStackTrace(this, this.constructor);
+    }
+  }
+}
+
+module.exports = { ApiError };

package/templates/clean-architecture/js/src/errors/BadRequestError.js

@@ -1,10 +1,11 @@
-const { ApiError } = require('./ApiError');
-const HTTP_STATUS = require('../utils/httpCodes');
-
-class BadRequestError extends ApiError {
-  constructor(message = 'Bad request') {
-    super(HTTP_STATUS.BAD_REQUEST, message);
-  }
-}
-
-module.exports = { BadRequestError };
+const { ApiError } = require('./ApiError');
+const HTTP_STATUS = require('../utils/httpCodes');
+const ERROR_MESSAGES = require('../utils/errorMessages');
+
+class BadRequestError extends ApiError {
+  constructor(message = ERROR_MESSAGES.BAD_REQUEST) {
+    super(HTTP_STATUS.BAD_REQUEST, message);
+  }
+}
+
+module.exports = { BadRequestError };

package/templates/clean-architecture/js/src/errors/BadRequestError.spec.js.ejs

@@ -1,21 +1,22 @@
-const { BadRequestError } = require('@/errors/BadRequestError');
-const { ApiError } = require('@/errors/ApiError');
-const HTTP_STATUS = require('@/utils/httpCodes');
-
-describe('BadRequestError', () => {
-    it('should extend ApiError', () => {
-        const error = new BadRequestError();
-        expect(error).toBeInstanceOf(ApiError);
-    });
-
-    it('should have default message "Bad request"', () => {
-        const error = new BadRequestError();
-        expect(error.message).toBe('Bad request');
-        expect(error.statusCode).toBe(HTTP_STATUS.BAD_REQUEST);
-    });
-
-    it('should accept a custom message', () => {
-        const error = new BadRequestError('Custom bad request');
-        expect(error.message).toBe('Custom bad request');
-    });
-});
+const { BadRequestError } = require('@/errors/BadRequestError');
+const { ApiError } = require('@/errors/ApiError');
+const HTTP_STATUS = require('@/utils/httpCodes');
+const ERROR_MESSAGES = require('@/utils/errorMessages');
+
+describe('BadRequestError', () => {
+    it('should extend ApiError', () => {
+        const error = new BadRequestError();
+        expect(error).toBeInstanceOf(ApiError);
+    });
+
+    it('should have default message "Bad Request"', () => {
+        const error = new BadRequestError();
+        expect(error.message).toBe(ERROR_MESSAGES.BAD_REQUEST);
+        expect(error.statusCode).toBe(HTTP_STATUS.BAD_REQUEST);
+    });
+
+    it('should accept a custom message', () => {
+        const error = new BadRequestError('Custom bad request');
+        expect(error.message).toBe('Custom bad request');
+    });
+});

package/templates/clean-architecture/js/src/errors/NotFoundError.js

@@ -1,10 +1,11 @@
-const { ApiError } = require('./ApiError');
-const HTTP_STATUS = require('../utils/httpCodes');
-
-class NotFoundError extends ApiError {
-  constructor(message = 'Resource not found') {
-    super(HTTP_STATUS.NOT_FOUND, message);
-  }
-}
-
-module.exports = { NotFoundError };
+const { ApiError } = require('./ApiError');
+const HTTP_STATUS = require('../utils/httpCodes');
+const ERROR_MESSAGES = require('../utils/errorMessages');
+
+class NotFoundError extends ApiError {
+  constructor(message = ERROR_MESSAGES.RESOURCE_NOT_FOUND) {
+    super(HTTP_STATUS.NOT_FOUND, message);
+  }
+}
+
+module.exports = { NotFoundError };

package/templates/clean-architecture/js/src/errors/NotFoundError.spec.js.ejs

@@ -1,21 +1,22 @@
-const { NotFoundError } = require('@/errors/NotFoundError');
-const { ApiError } = require('@/errors/ApiError');
-const HTTP_STATUS = require('@/utils/httpCodes');
-
-describe('NotFoundError', () => {
-    it('should extend ApiError', () => {
-        const error = new NotFoundError();
-        expect(error).toBeInstanceOf(ApiError);
-    });
-
-    it('should have default message "Resource not found"', () => {
-        const error = new NotFoundError();
-        expect(error.message).toBe('Resource not found');
-        expect(error.statusCode).toBe(HTTP_STATUS.NOT_FOUND);
-    });
-
-    it('should accept a custom message', () => {
-        const error = new NotFoundError('User not found');
-        expect(error.message).toBe('User not found');
-    });
-});
+const { NotFoundError } = require('@/errors/NotFoundError');
+const { ApiError } = require('@/errors/ApiError');
+const HTTP_STATUS = require('@/utils/httpCodes');
+const ERROR_MESSAGES = require('@/utils/errorMessages');
+
+describe('NotFoundError', () => {
+    it('should extend ApiError', () => {
+        const error = new NotFoundError();
+        expect(error).toBeInstanceOf(ApiError);
+    });
+
+    it('should have default message "Resource not found"', () => {
+        const error = new NotFoundError();
+        expect(error.message).toBe(ERROR_MESSAGES.RESOURCE_NOT_FOUND);
+        expect(error.statusCode).toBe(HTTP_STATUS.NOT_FOUND);
+    });
+
+    it('should accept a custom message', () => {
+        const error = new NotFoundError(ERROR_MESSAGES.USER_NOT_FOUND);
+        expect(error.message).toBe(ERROR_MESSAGES.USER_NOT_FOUND);
+    });
+});

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

@@ -1,56 +1,56 @@
-const startServer = require('./infrastructure/webserver/server');
-const logger = require('./infrastructure/log/logger');
-<% if (communication === 'Kafka') { -%>
-const { connectKafka } = require('./infrastructure/messaging/kafkaClient');
-<% } -%>
-<%_ if (database !== 'None') { -%>
-// Database Sync
-<%_ if (database !== 'None') { -%>
-<%_ if (database === 'MongoDB') { -%>
-const connectDB = require('./infrastructure/database/database');
-<%_ } else { -%>
-const sequelize = require('./infrastructure/database/database');
-<%_ } -%>
-<%_ } -%>
-
-const syncDatabase = async () => {
-    let retries = 30;
-    while (retries) {
-        try {
-            <%_ if (database === 'MongoDB') { -%>
-            await connectDB();
-            <%_ } else { -%>
-            await sequelize.sync();
-            <%_ } -%>
-            logger.info('Database synced');
-            // Start the web server after DB sync
-            startServer();
-            <%_ if (communication === 'Kafka') { -%>
-            // Connect Kafka
-            connectKafka().then(async () => {
-              logger.info('Kafka connected');
-            }).catch(err => {
-              logger.error('Failed to connect to Kafka:', err);
-            });
-            <%_ } -%>
-            break;
-        } catch (error) {
-            logger.error('Error syncing database:', error);
-            retries -= 1;
-            logger.info(`Retries left: ${retries}`);
-            await new Promise(res => setTimeout(res, 5000));
-        }
-    }
-};
-syncDatabase();
-<%_ } else { -%>
-startServer();
-<%_ if (communication === 'Kafka') { -%>
-// Connect Kafka
-connectKafka().then(async () => {
-  logger.info('Kafka connected');
-}).catch(err => {
-  logger.error('Failed to connect to Kafka:', err);
-});
-<%_ } -%>
+const startServer = require('./infrastructure/webserver/server');
+const logger = require('./infrastructure/log/logger');
+<% if (communication === 'Kafka') { -%>
+const { connectKafka } = require('./infrastructure/messaging/kafkaClient');
+<% } -%>
+<%_ if (database !== 'None') { -%>
+// Database Sync
+<%_ if (database !== 'None') { -%>
+<%_ if (database === 'MongoDB') { -%>
+const connectDB = require('./infrastructure/database/database');
+<%_ } else { -%>
+const sequelize = require('./infrastructure/database/database');
+<%_ } -%>
+<%_ } -%>
+
+const syncDatabase = async () => {
+    let retries = 30;
+    while (retries) {
+        try {
+            <%_ if (database === 'MongoDB') { -%>
+            await connectDB();
+            <%_ } else { -%>
+            await sequelize.sync();
+            <%_ } -%>
+            logger.info('Database synced');
+            // Start the web server after DB sync
+            startServer();
+            <%_ if (communication === 'Kafka') { -%>
+            // Connect Kafka
+            connectKafka().then(async () => {
+              logger.info('Kafka connected');
+            }).catch(err => {
+              logger.error('Failed to connect to Kafka:', err);
+            });
+            <%_ } -%>
+            break;
+        } catch (error) {
+            logger.error('Error syncing database:', error);
+            retries -= 1;
+            logger.info(`Retries left: ${retries}`);
+            await new Promise(res => setTimeout(res, 5000));
+        }
+    }
+};
+syncDatabase();
+<%_ } else { -%>
+startServer();
+<%_ if (communication === 'Kafka') { -%>
+// Connect Kafka
+connectKafka().then(async () => {
+  logger.info('Kafka connected');
+}).catch(err => {
+  logger.error('Failed to connect to Kafka:', err);
+});
+<%_ } -%>
 <%_ } -%>