nodejs-quickstart-structure 1.7.5 → 1.8.1

package/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.8.1] - 2026-02-22
+### Security
+- Resolved all high-severity npm vulnerabilities (0 vulnerabilities detected on install).
+- Upgraded ESLint to v9 and `typescript-eslint` to v8, migrating generated templates from `.eslintrc.json` to Flat Config (`eslint.config.mjs`) to eliminate deprecated `eslint@8` transitive dependencies.
+- Upgraded `supertest` to v7, `rimraf` to v6, and `ejs` to v3.1.10.
+- Replaced vulnerable `copyfiles` dependency with `cpx2` for view template orchestration.
+- Configured npm `overrides` for `minimatch@^10.2.1` to patch outdated `jest` sub-dependencies without breaking the test runner.
+
+### Fixed
+- Fixed `npm install` crashing due to `husky install` expecting an initialized `.git` directory by adding a graceful fallback wrapper.
+
+## [1.8.0] - 2026-02-18
+### Added
+- Introduced **GitLab CI/CD pipeline support**:
+  - Preconfigured `.gitlab-ci.yml` for automated build, test, and deploy steps.
+  - End-to-end (e2e) test job included to ensure project reliability.
+  - Aligns with existing GitHub Actions and Jenkins workflows for consistent CI/CD coverage.
+
+### Improved
+- Documentation updated to highlight GitLab CI/CD as a supported option.
+- Enhanced CI/CD setup instructions in `README.md` for multi-platform pipelines.
+
 ## [1.7.5] - 2026-02-17
 > Happy Lunar New Year! This release coincides with Tet Vietnam. 🎆
 ### Fixed

package/README.md

@@ -25,7 +25,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**: Choice between **GitHub Actions** and **Jenkins**.
+-   **🔄 CI/CD Integration**: Pre-configured workflows for **GitHub Actions**, **Jenkins**, and **GitLab CI**.
 -   **⚓ 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.
 
@@ -68,7 +68,7 @@ The CLI will guide you through the following steps:
 5.  **Database Name**: The name of the initial database.
 6.  **Communication**: `REST APIs` (default) or `Kafka`.
 7.  **Caching**: `Redis` or `None`.
-8.  **CI/CD**: `GitHub Actions`, `Jenkins`, or `None`.
+8.  **CI/CD**: `GitHub Actions`, `Jenkins`, `GitLab CI` or `None`.
 
 ## Generated Project Structure
 

package/docs/generateCase.md

@@ -3,6 +3,7 @@
 This document lists the **112 possible project combinations** supported by the `nodejs-quickstart` CLI. These combinations cover all supported languages, architectures, databases, communication patterns, and caching options.
 
 ## Summary
+- **CI Providers**: `None`, `GitHub Actions`, `Jenkins`, `GitLab CI`
 - **MVC Architecture**: 84 Combinations
   - **With Database (36)**: 2 Lang × 3 View × 3 DB × 2 Comm = 36 * 2 (Caching: None/Redis) = 72
   - **No Database (12)**: 2 Lang × 3 View × 1 DB × 2 Comm = 12 * 1 (Caching: None) = 12

package/docs/generatorFlow.md

@@ -90,7 +90,11 @@ The `generateProject` function in `lib/generator.js` executes the following step
 16. **Test Setup**:
     *   Generates `jest.config.js` and a sample `health.test.{js|ts}`.
 17. **CI/CD Setup**:
-    *   Copies GitHub Actions workflow or renders `Jenkinsfile` if selected.
+    *   Helper: `setupCiCd`
+    *   Checks `config.ciProvider`:
+        *   **GitHub Actions**: Copies `.github/workflows/ci.yml`.
+        *   **Jenkins**: Renders `Jenkinsfile`.
+        *   **GitLab CI**: Renders `.gitlab-ci.yml` if selected.
 
 ## 4. TypeScript vs JavaScript Generation Steps
 

package/docs/ruleDevelop.md

@@ -0,0 +1,25 @@
+# Development Rules & Conventions
+
+## General Standards
+
+### File Naming
+- **Controllers**: Use camelCase (e.g., `kafkaController.ts`, `userController.ts`).
+- **Services**: Use camelCase (e.g., `kafkaService.ts`, `userService.ts`) or PascalCase depending on export type. Class-based services should generally match class name.
+- **Routes**: Use camelCase (e.g., `userRoutes.ts`, `kafkaRoutes.ts`).
+- **Utilities**: Use camelCase (e.g., `httpCodes.ts`).
+
+### Code Style
+- **Status Codes**: ALWAYS use `HTTP_STATUS` constants from `@/utils/httpCodes` (TS) or `../../utils/httpCodes.js` (JS) instead of hardcoded numbers.
+  - Good: `res.status(HTTP_STATUS.OK).json(...)`
+  - Bad: `res.status(200).json(...)`
+- **Imports**: 
+  - **TypeScript**: Use path aliases (e.g., `@/services/...`, `@/utils/...`) instead of relative paths (e.g., `../../utils/...`).
+  - **JavaScript**: Use relative paths as configured by the project structure.
+
+### API Response Structure
+- Success: `{ status: string, data: any }` or direct JSON object.
+- Error: `{ error: string }`
+
+## Git Workflow
+- Commit messages should be descriptive.
+- Ensure all tests pass before pushing.

package/lib/modules/config-files.js

@@ -60,9 +60,9 @@ export const renderDockerfile = async (templatesDir, targetDir, config) => {
 };
 
 export const renderProfessionalConfig = async (templatesDir, targetDir, language) => {
-    const eslintTemplate = await fs.readFile(path.join(templatesDir, 'common', '.eslintrc.json.ejs'), 'utf-8');
+    const eslintTemplate = await fs.readFile(path.join(templatesDir, 'common', 'eslint.config.mjs.ejs'), 'utf-8');
     const eslintContent = ejs.render(eslintTemplate, { language });
-    await fs.writeFile(path.join(targetDir, '.eslintrc.json'), eslintContent);
+    await fs.writeFile(path.join(targetDir, 'eslint.config.mjs'), eslintContent);
 
     await fs.copy(path.join(templatesDir, 'common', '.prettierrc'), path.join(targetDir, '.prettierrc'));
     await fs.copy(path.join(templatesDir, 'common', '.lintstagedrc'), path.join(targetDir, '.lintstagedrc'));
@@ -81,6 +81,10 @@ export const setupCiCd = async (templatesDir, targetDir, config) => {
         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);
+    } else if (ciProvider === 'GitLab CI') {
+        const gitlabTemplate = await fs.readFile(path.join(templatesDir, 'common', '.gitlab-ci.yml.ejs'), 'utf-8');
+        const gitlabContent = ejs.render(gitlabTemplate, { projectName });
+        await fs.writeFile(path.join(targetDir, '.gitlab-ci.yml'), gitlabContent);
     }
 };
 

package/lib/prompts.js

@@ -74,7 +74,7 @@ export const getProjectDetails = async (options = {}) => {
             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.7.5",
+  "version": "1.8.1",
   "type": "module",
   "description": "A CLI to scaffold Node.js microservices with MVC or Clean Architecture",
   "main": "bin/index.js",

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/README.md.ejs

@@ -17,12 +17,20 @@ This project comes pre-configured with industry-standard tooling for **Code Qual
 -   **DevOps**: Multi-stage Docker build, CI/CD ready.
 
 ## 🔄 CI/CD Pipeline
-<% if (ciProvider === 'GitHub Actions') { -%>
+<%_ 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:

package/templates/common/eslint.config.mjs.ejs

@@ -0,0 +1,41 @@
+import eslint from '@eslint/js';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import globals from 'globals';
+<% if (language === 'TypeScript') { %>import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  eslintConfigPrettier,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+    },
+    rules: {
+      "no-console": "warn",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": "warn"
+    }
+  }
+);<% } else { %>
+export default [
+  eslint.configs.recommended,
+  eslintConfigPrettier,
+  {
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+    },
+    rules: {
+      "no-console": "warn",
+      "no-unused-vars": "warn"
+    }
+  }
+];<% } %>

package/templates/common/package.json.ejs

@@ -6,11 +6,11 @@
   "scripts": {
     "start": "<% if (language === 'TypeScript') { %>node dist/index.js<% } else { %>node src/index.js<% } %>",
     "dev": "<% if (language === 'TypeScript') { %>nodemon --exec ts-node -r tsconfig-paths/register src/index.ts<% } else { %>nodemon src/index.js<% } %>"<% if (language === 'TypeScript') { %>,
-    "build": "rimraf dist && tsc && tsc-alias<% if (viewEngine && viewEngine !== 'None') { %> && copyfiles -u 1 \"src/views/**/*\" dist/<% } %>"<% } %>,
-    "lint": "eslint . --ext .ts,.js",
-    "lint:fix": "eslint . --ext .ts,.js --fix",
+    "build": "rimraf dist && tsc && tsc-alias<% if (viewEngine && viewEngine !== 'None') { %> && cpx2 \"src/views/**/*\" dist/views<% } %>"<% } %>,
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "format": "prettier --write .",
-    "prepare": "husky install",
+    "prepare": "node -e \"try { require('child_process').execSync('husky install'); } catch (e) { console.log('Not a git repository, skipping husky install'); }\"",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage"
@@ -34,7 +34,7 @@
 <% } -%>
 <% if (caching === 'Redis') { %>    "ioredis": "^5.3.2",
 <% } -%>
-<% if (viewEngine === 'EJS') { %>    "ejs": "^3.1.9",
+<% if (viewEngine === 'EJS') { %>    "ejs": "^3.1.10",
 <% } -%>
 <% if (viewEngine === 'Pug') { %>    "pug": "^3.0.2",
 <% } -%>
@@ -55,7 +55,6 @@
     "@types/node": "^20.10.5",
     "@types/express": "^4.17.21",
     "@types/cors": "^2.8.17",
-    "@types/dotenv": "^8.2.0",
     "@types/hpp": "^0.2.3",
 <% if (caching === 'Redis') { %>    "@types/ioredis": "^5.0.0",
 <% } -%>
@@ -65,26 +64,30 @@
     "@types/sequelize": "^4.28.19",
 <%_ } -%>
     "@types/morgan": "^1.9.9",
-    "rimraf": "^5.0.5"<% if (viewEngine && viewEngine !== 'None') { %>,
-    "copyfiles": "^2.4.1"<% } %><% } %>,
-    "eslint": "^8.56.0",
-    "prettier": "^3.1.1",
-    "eslint-config-prettier": "^9.1.0",
+    "rimraf": "^6.0.1"<% if (viewEngine && viewEngine !== 'None') { %>,
+    "cpx2": "^8.0.0"<% } %><% } %>,
+    "eslint": "^9.20.1",
+    "@eslint/js": "^9.20.0",
+    "globals": "^15.14.0",
+    "prettier": "^3.5.1",
+    "eslint-config-prettier": "^10.0.1",
     "husky": "^8.0.3",
-    "lint-staged": "^15.2.0"<% if (language === 'TypeScript') { %>,
-    "@typescript-eslint/eslint-plugin": "^6.18.1",
-    "@typescript-eslint/parser": "^6.18.1",
+    "lint-staged": "^15.4.3"<% if (language === 'TypeScript') { %>,
+    "typescript-eslint": "^8.24.1",
 <% if (communication === 'REST APIs') { %>    "@types/swagger-ui-express": "^4.1.6",
     "@types/swagger-jsdoc": "^6.0.4",<% } -%>
     "jest": "^29.7.0",
-    "ts-jest": "^29.1.1",
-    "@types/jest": "^29.5.11",
-    "supertest": "^6.3.3",
+    "ts-jest": "^29.2.5",
+    "@types/jest": "^29.5.14",
+    "supertest": "^7.1.3",
     "tsconfig-paths": "^4.2.0",
-    "tsc-alias": "^1.8.8",
+    "tsc-alias": "^1.8.10",
     "@types/supertest": "^6.0.2"<% } else { %>,
     "jest": "^29.7.0",
-    "supertest": "^6.3.3"<% } %>
+    "supertest": "^7.1.3"<% } %>
+  },
+  "overrides": {
+    "minimatch": "^10.2.1"
   },
   "lint-staged": {
     "*.{js,ts}": [

package/templates/common/.eslintrc.json.ejs

@@ -1,26 +0,0 @@
-{
-  "env": {
-    "node": true,
-    "es2021": true,
-    "jest": true
-  },
-  "extends": [
-    "eslint:recommended",
-    "prettier"<% if (language === 'TypeScript') { %>,
-    "plugin:@typescript-eslint/recommended"<% } %>
-  ],
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module"
-  }<% if (language === 'TypeScript') { %>,
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint"]<% } %>,
-  "rules": {
-    "no-console": "warn",
-    <% if (language === 'TypeScript') { %>
-    "no-unused-vars": "off",
-    "@typescript-eslint/no-unused-vars": "warn"
-    <% } else { %>
-    "no-unused-vars": "warn"<% } %>
-  }
-}