nodejs-quickstart-structure 1.12.0 → 1.14.0

package/docs/generateCase.md

@@ -1,265 +0,0 @@
-# NodeJS Quickstart Generator - Test Cases
-
-This document lists the **240 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**: 180 Combinations
-- **Clean Architecture**: 60 Combinations
-
-**Total Core Combinations: 240**
-
-> **Note on CI/CD**: Each combination can be generated with or without CI/CD (`--ci-provider`), effectively doubling the state space.
-
----
-
-## 1. MVC Architecture (180 Cases)
-
-| # | Language | Architecture | View Engine | Database | Communication | Caching |
-| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
-| 1 | TypeScript | MVC | EJS | None | REST APIs | None |
-| 2 | TypeScript | MVC | EJS | None | GraphQL | None |
-| 3 | TypeScript | MVC | EJS | None | Kafka | None |
-| 4 | TypeScript | MVC | EJS | MySQL | REST APIs | None |
-| 5 | TypeScript | MVC | EJS | MySQL | REST APIs | Redis |
-| 6 | TypeScript | MVC | EJS | MySQL | REST APIs | Memory Cache |
-| 7 | TypeScript | MVC | EJS | MySQL | GraphQL | None |
-| 8 | TypeScript | MVC | EJS | MySQL | GraphQL | Redis |
-| 9 | TypeScript | MVC | EJS | MySQL | GraphQL | Memory Cache |
-| 10 | TypeScript | MVC | EJS | MySQL | Kafka | None |
-| 11 | TypeScript | MVC | EJS | MySQL | Kafka | Redis |
-| 12 | TypeScript | MVC | EJS | MySQL | Kafka | Memory Cache |
-| 13 | TypeScript | MVC | EJS | PostgreSQL | REST APIs | None |
-| 14 | TypeScript | MVC | EJS | PostgreSQL | REST APIs | Redis |
-| 15 | TypeScript | MVC | EJS | PostgreSQL | REST APIs | Memory Cache |
-| 16 | TypeScript | MVC | EJS | PostgreSQL | GraphQL | None |
-| 17 | TypeScript | MVC | EJS | PostgreSQL | GraphQL | Redis |
-| 18 | TypeScript | MVC | EJS | PostgreSQL | GraphQL | Memory Cache |
-| 19 | TypeScript | MVC | EJS | PostgreSQL | Kafka | None |
-| 20 | TypeScript | MVC | EJS | PostgreSQL | Kafka | Redis |
-| 21 | TypeScript | MVC | EJS | PostgreSQL | Kafka | Memory Cache |
-| 22 | TypeScript | MVC | EJS | MongoDB | REST APIs | None |
-| 23 | TypeScript | MVC | EJS | MongoDB | REST APIs | Redis |
-| 24 | TypeScript | MVC | EJS | MongoDB | REST APIs | Memory Cache |
-| 25 | TypeScript | MVC | EJS | MongoDB | GraphQL | None |
-| 26 | TypeScript | MVC | EJS | MongoDB | GraphQL | Redis |
-| 27 | TypeScript | MVC | EJS | MongoDB | GraphQL | Memory Cache |
-| 28 | TypeScript | MVC | EJS | MongoDB | Kafka | None |
-| 29 | TypeScript | MVC | EJS | MongoDB | Kafka | Redis |
-| 30 | TypeScript | MVC | EJS | MongoDB | Kafka | Memory Cache |
-| 31 | TypeScript | MVC | Pug | None | REST APIs | None |
-| 32 | TypeScript | MVC | Pug | None | GraphQL | None |
-| 33 | TypeScript | MVC | Pug | None | Kafka | None |
-| 34 | TypeScript | MVC | Pug | MySQL | REST APIs | None |
-| 35 | TypeScript | MVC | Pug | MySQL | REST APIs | Redis |
-| 36 | TypeScript | MVC | Pug | MySQL | REST APIs | Memory Cache |
-| 37 | TypeScript | MVC | Pug | MySQL | GraphQL | None |
-| 38 | TypeScript | MVC | Pug | MySQL | GraphQL | Redis |
-| 39 | TypeScript | MVC | Pug | MySQL | GraphQL | Memory Cache |
-| 40 | TypeScript | MVC | Pug | MySQL | Kafka | None |
-| 41 | TypeScript | MVC | Pug | MySQL | Kafka | Redis |
-| 42 | TypeScript | MVC | Pug | MySQL | Kafka | Memory Cache |
-| 43 | TypeScript | MVC | Pug | PostgreSQL | REST APIs | None |
-| 44 | TypeScript | MVC | Pug | PostgreSQL | REST APIs | Redis |
-| 45 | TypeScript | MVC | Pug | PostgreSQL | REST APIs | Memory Cache |
-| 46 | TypeScript | MVC | Pug | PostgreSQL | GraphQL | None |
-| 47 | TypeScript | MVC | Pug | PostgreSQL | GraphQL | Redis |
-| 48 | TypeScript | MVC | Pug | PostgreSQL | GraphQL | Memory Cache |
-| 49 | TypeScript | MVC | Pug | PostgreSQL | Kafka | None |
-| 50 | TypeScript | MVC | Pug | PostgreSQL | Kafka | Redis |
-| 51 | TypeScript | MVC | Pug | PostgreSQL | Kafka | Memory Cache |
-| 52 | TypeScript | MVC | Pug | MongoDB | REST APIs | None |
-| 53 | TypeScript | MVC | Pug | MongoDB | REST APIs | Redis |
-| 54 | TypeScript | MVC | Pug | MongoDB | REST APIs | Memory Cache |
-| 55 | TypeScript | MVC | Pug | MongoDB | GraphQL | None |
-| 56 | TypeScript | MVC | Pug | MongoDB | GraphQL | Redis |
-| 57 | TypeScript | MVC | Pug | MongoDB | GraphQL | Memory Cache |
-| 58 | TypeScript | MVC | Pug | MongoDB | Kafka | None |
-| 59 | TypeScript | MVC | Pug | MongoDB | Kafka | Redis |
-| 60 | TypeScript | MVC | Pug | MongoDB | Kafka | Memory Cache |
-| 61 | TypeScript | MVC | None | None | REST APIs | None |
-| 62 | TypeScript | MVC | None | None | GraphQL | None |
-| 63 | TypeScript | MVC | None | None | Kafka | None |
-| 64 | TypeScript | MVC | None | MySQL | REST APIs | None |
-| 65 | TypeScript | MVC | None | MySQL | REST APIs | Redis |
-| 66 | TypeScript | MVC | None | MySQL | REST APIs | Memory Cache |
-| 67 | TypeScript | MVC | None | MySQL | GraphQL | None |
-| 68 | TypeScript | MVC | None | MySQL | GraphQL | Redis |
-| 69 | TypeScript | MVC | None | MySQL | GraphQL | Memory Cache |
-| 70 | TypeScript | MVC | None | MySQL | Kafka | None |
-| 71 | TypeScript | MVC | None | MySQL | Kafka | Redis |
-| 72 | TypeScript | MVC | None | MySQL | Kafka | Memory Cache |
-| 73 | TypeScript | MVC | None | PostgreSQL | REST APIs | None |
-| 74 | TypeScript | MVC | None | PostgreSQL | REST APIs | Redis |
-| 75 | TypeScript | MVC | None | PostgreSQL | REST APIs | Memory Cache |
-| 76 | TypeScript | MVC | None | PostgreSQL | GraphQL | None |
-| 77 | TypeScript | MVC | None | PostgreSQL | GraphQL | Redis |
-| 78 | TypeScript | MVC | None | PostgreSQL | GraphQL | Memory Cache |
-| 79 | TypeScript | MVC | None | PostgreSQL | Kafka | None |
-| 80 | TypeScript | MVC | None | PostgreSQL | Kafka | Redis |
-| 81 | TypeScript | MVC | None | PostgreSQL | Kafka | Memory Cache |
-| 82 | TypeScript | MVC | None | MongoDB | REST APIs | None |
-| 83 | TypeScript | MVC | None | MongoDB | REST APIs | Redis |
-| 84 | TypeScript | MVC | None | MongoDB | REST APIs | Memory Cache |
-| 85 | TypeScript | MVC | None | MongoDB | GraphQL | None |
-| 86 | TypeScript | MVC | None | MongoDB | GraphQL | Redis |
-| 87 | TypeScript | MVC | None | MongoDB | GraphQL | Memory Cache |
-| 88 | TypeScript | MVC | None | MongoDB | Kafka | None |
-| 89 | TypeScript | MVC | None | MongoDB | Kafka | Redis |
-| 90 | TypeScript | MVC | None | MongoDB | Kafka | Memory Cache |
-| 91 | JavaScript | MVC | EJS | None | REST APIs | None |
-| 92 | JavaScript | MVC | EJS | None | GraphQL | None |
-| 93 | JavaScript | MVC | EJS | None | Kafka | None |
-| 94 | JavaScript | MVC | EJS | MySQL | REST APIs | None |
-| 95 | JavaScript | MVC | EJS | MySQL | REST APIs | Redis |
-| 96 | JavaScript | MVC | EJS | MySQL | REST APIs | Memory Cache |
-| 97 | JavaScript | MVC | EJS | MySQL | GraphQL | None |
-| 98 | JavaScript | MVC | EJS | MySQL | GraphQL | Redis |
-| 99 | JavaScript | MVC | EJS | MySQL | GraphQL | Memory Cache |
-| 100 | JavaScript | MVC | EJS | MySQL | Kafka | None |
-| 101 | JavaScript | MVC | EJS | MySQL | Kafka | Redis |
-| 102 | JavaScript | MVC | EJS | MySQL | Kafka | Memory Cache |
-| 103 | JavaScript | MVC | EJS | PostgreSQL | REST APIs | None |
-| 104 | JavaScript | MVC | EJS | PostgreSQL | REST APIs | Redis |
-| 105 | JavaScript | MVC | EJS | PostgreSQL | REST APIs | Memory Cache |
-| 106 | JavaScript | MVC | EJS | PostgreSQL | GraphQL | None |
-| 107 | JavaScript | MVC | EJS | PostgreSQL | GraphQL | Redis |
-| 108 | JavaScript | MVC | EJS | PostgreSQL | GraphQL | Memory Cache |
-| 109 | JavaScript | MVC | EJS | PostgreSQL | Kafka | None |
-| 110 | JavaScript | MVC | EJS | PostgreSQL | Kafka | Redis |
-| 111 | JavaScript | MVC | EJS | PostgreSQL | Kafka | Memory Cache |
-| 112 | JavaScript | MVC | EJS | MongoDB | REST APIs | None |
-| 113 | JavaScript | MVC | EJS | MongoDB | REST APIs | Redis |
-| 114 | JavaScript | MVC | EJS | MongoDB | REST APIs | Memory Cache |
-| 115 | JavaScript | MVC | EJS | MongoDB | GraphQL | None |
-| 116 | JavaScript | MVC | EJS | MongoDB | GraphQL | Redis |
-| 117 | JavaScript | MVC | EJS | MongoDB | GraphQL | Memory Cache |
-| 118 | JavaScript | MVC | EJS | MongoDB | Kafka | None |
-| 119 | JavaScript | MVC | EJS | MongoDB | Kafka | Redis |
-| 120 | JavaScript | MVC | EJS | MongoDB | Kafka | Memory Cache |
-| 121 | JavaScript | MVC | Pug | None | REST APIs | None |
-| 122 | JavaScript | MVC | Pug | None | GraphQL | None |
-| 123 | JavaScript | MVC | Pug | None | Kafka | None |
-| 124 | JavaScript | MVC | Pug | MySQL | REST APIs | None |
-| 125 | JavaScript | MVC | Pug | MySQL | REST APIs | Redis |
-| 126 | JavaScript | MVC | Pug | MySQL | REST APIs | Memory Cache |
-| 127 | JavaScript | MVC | Pug | MySQL | GraphQL | None |
-| 128 | JavaScript | MVC | Pug | MySQL | GraphQL | Redis |
-| 129 | JavaScript | MVC | Pug | MySQL | GraphQL | Memory Cache |
-| 130 | JavaScript | MVC | Pug | MySQL | Kafka | None |
-| 131 | JavaScript | MVC | Pug | MySQL | Kafka | Redis |
-| 132 | JavaScript | MVC | Pug | MySQL | Kafka | Memory Cache |
-| 133 | JavaScript | MVC | Pug | PostgreSQL | REST APIs | None |
-| 134 | JavaScript | MVC | Pug | PostgreSQL | REST APIs | Redis |
-| 135 | JavaScript | MVC | Pug | PostgreSQL | REST APIs | Memory Cache |
-| 136 | JavaScript | MVC | Pug | PostgreSQL | GraphQL | None |
-| 137 | JavaScript | MVC | Pug | PostgreSQL | GraphQL | Redis |
-| 138 | JavaScript | MVC | Pug | PostgreSQL | GraphQL | Memory Cache |
-| 139 | JavaScript | MVC | Pug | PostgreSQL | Kafka | None |
-| 140 | JavaScript | MVC | Pug | PostgreSQL | Kafka | Redis |
-| 141 | JavaScript | MVC | Pug | PostgreSQL | Kafka | Memory Cache |
-| 142 | JavaScript | MVC | Pug | MongoDB | REST APIs | None |
-| 143 | JavaScript | MVC | Pug | MongoDB | REST APIs | Redis |
-| 144 | JavaScript | MVC | Pug | MongoDB | REST APIs | Memory Cache |
-| 145 | JavaScript | MVC | Pug | MongoDB | GraphQL | None |
-| 146 | JavaScript | MVC | Pug | MongoDB | GraphQL | Redis |
-| 147 | JavaScript | MVC | Pug | MongoDB | GraphQL | Memory Cache |
-| 148 | JavaScript | MVC | Pug | MongoDB | Kafka | None |
-| 149 | JavaScript | MVC | Pug | MongoDB | Kafka | Redis |
-| 150 | JavaScript | MVC | Pug | MongoDB | Kafka | Memory Cache |
-| 151 | JavaScript | MVC | None | None | REST APIs | None |
-| 152 | JavaScript | MVC | None | None | GraphQL | None |
-| 153 | JavaScript | MVC | None | None | Kafka | None |
-| 154 | JavaScript | MVC | None | MySQL | REST APIs | None |
-| 155 | JavaScript | MVC | None | MySQL | REST APIs | Redis |
-| 156 | JavaScript | MVC | None | MySQL | REST APIs | Memory Cache |
-| 157 | JavaScript | MVC | None | MySQL | GraphQL | None |
-| 158 | JavaScript | MVC | None | MySQL | GraphQL | Redis |
-| 159 | JavaScript | MVC | None | MySQL | GraphQL | Memory Cache |
-| 160 | JavaScript | MVC | None | MySQL | Kafka | None |
-| 161 | JavaScript | MVC | None | MySQL | Kafka | Redis |
-| 162 | JavaScript | MVC | None | MySQL | Kafka | Memory Cache |
-| 163 | JavaScript | MVC | None | PostgreSQL | REST APIs | None |
-| 164 | JavaScript | MVC | None | PostgreSQL | REST APIs | Redis |
-| 165 | JavaScript | MVC | None | PostgreSQL | REST APIs | Memory Cache |
-| 166 | JavaScript | MVC | None | PostgreSQL | GraphQL | None |
-| 167 | JavaScript | MVC | None | PostgreSQL | GraphQL | Redis |
-| 168 | JavaScript | MVC | None | PostgreSQL | GraphQL | Memory Cache |
-| 169 | JavaScript | MVC | None | PostgreSQL | Kafka | None |
-| 170 | JavaScript | MVC | None | PostgreSQL | Kafka | Redis |
-| 171 | JavaScript | MVC | None | PostgreSQL | Kafka | Memory Cache |
-| 172 | JavaScript | MVC | None | MongoDB | REST APIs | None |
-| 173 | JavaScript | MVC | None | MongoDB | REST APIs | Redis |
-| 174 | JavaScript | MVC | None | MongoDB | REST APIs | Memory Cache |
-| 175 | JavaScript | MVC | None | MongoDB | GraphQL | None |
-| 176 | JavaScript | MVC | None | MongoDB | GraphQL | Redis |
-| 177 | JavaScript | MVC | None | MongoDB | GraphQL | Memory Cache |
-| 178 | JavaScript | MVC | None | MongoDB | Kafka | None |
-| 179 | JavaScript | MVC | None | MongoDB | Kafka | Redis |
-| 180 | JavaScript | MVC | None | MongoDB | Kafka | Memory Cache |
-
-## 2. Clean Architecture (60 Cases)
-*Note: Clean Architecture does not use server-side view engines (EJS/Pug).*
-
-| # | Language | Architecture | View Engine | Database | Communication | Caching |
-| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
-| 181 | TypeScript | Clean Architecture | N/A | None | REST APIs | None |
-| 182 | TypeScript | Clean Architecture | N/A | None | GraphQL | None |
-| 183 | TypeScript | Clean Architecture | N/A | None | Kafka | None |
-| 184 | TypeScript | Clean Architecture | N/A | MySQL | REST APIs | None |
-| 185 | TypeScript | Clean Architecture | N/A | MySQL | REST APIs | Redis |
-| 186 | TypeScript | Clean Architecture | N/A | MySQL | REST APIs | Memory Cache |
-| 187 | TypeScript | Clean Architecture | N/A | MySQL | GraphQL | None |
-| 188 | TypeScript | Clean Architecture | N/A | MySQL | GraphQL | Redis |
-| 189 | TypeScript | Clean Architecture | N/A | MySQL | GraphQL | Memory Cache |
-| 190 | TypeScript | Clean Architecture | N/A | MySQL | Kafka | None |
-| 191 | TypeScript | Clean Architecture | N/A | MySQL | Kafka | Redis |
-| 192 | TypeScript | Clean Architecture | N/A | MySQL | Kafka | Memory Cache |
-| 193 | TypeScript | Clean Architecture | N/A | PostgreSQL | REST APIs | None |
-| 194 | TypeScript | Clean Architecture | N/A | PostgreSQL | REST APIs | Redis |
-| 195 | TypeScript | Clean Architecture | N/A | PostgreSQL | REST APIs | Memory Cache |
-| 196 | TypeScript | Clean Architecture | N/A | PostgreSQL | GraphQL | None |
-| 197 | TypeScript | Clean Architecture | N/A | PostgreSQL | GraphQL | Redis |
-| 198 | TypeScript | Clean Architecture | N/A | PostgreSQL | GraphQL | Memory Cache |
-| 199 | TypeScript | Clean Architecture | N/A | PostgreSQL | Kafka | None |
-| 200 | TypeScript | Clean Architecture | N/A | PostgreSQL | Kafka | Redis |
-| 201 | TypeScript | Clean Architecture | N/A | PostgreSQL | Kafka | Memory Cache |
-| 202 | TypeScript | Clean Architecture | N/A | MongoDB | REST APIs | None |
-| 203 | TypeScript | Clean Architecture | N/A | MongoDB | REST APIs | Redis |
-| 204 | TypeScript | Clean Architecture | N/A | MongoDB | REST APIs | Memory Cache |
-| 205 | TypeScript | Clean Architecture | N/A | MongoDB | GraphQL | None |
-| 206 | TypeScript | Clean Architecture | N/A | MongoDB | GraphQL | Redis |
-| 207 | TypeScript | Clean Architecture | N/A | MongoDB | GraphQL | Memory Cache |
-| 208 | TypeScript | Clean Architecture | N/A | MongoDB | Kafka | None |
-| 209 | TypeScript | Clean Architecture | N/A | MongoDB | Kafka | Redis |
-| 210 | TypeScript | Clean Architecture | N/A | MongoDB | Kafka | Memory Cache |
-| 211 | JavaScript | Clean Architecture | N/A | None | REST APIs | None |
-| 212 | JavaScript | Clean Architecture | N/A | None | GraphQL | None |
-| 213 | JavaScript | Clean Architecture | N/A | None | Kafka | None |
-| 214 | JavaScript | Clean Architecture | N/A | MySQL | REST APIs | None |
-| 215 | JavaScript | Clean Architecture | N/A | MySQL | REST APIs | Redis |
-| 216 | JavaScript | Clean Architecture | N/A | MySQL | REST APIs | Memory Cache |
-| 217 | JavaScript | Clean Architecture | N/A | MySQL | GraphQL | None |
-| 218 | JavaScript | Clean Architecture | N/A | MySQL | GraphQL | Redis |
-| 219 | JavaScript | Clean Architecture | N/A | MySQL | GraphQL | Memory Cache |
-| 220 | JavaScript | Clean Architecture | N/A | MySQL | Kafka | None |
-| 221 | JavaScript | Clean Architecture | N/A | MySQL | Kafka | Redis |
-| 222 | JavaScript | Clean Architecture | N/A | MySQL | Kafka | Memory Cache |
-| 223 | JavaScript | Clean Architecture | N/A | PostgreSQL | REST APIs | None |
-| 224 | JavaScript | Clean Architecture | N/A | PostgreSQL | REST APIs | Redis |
-| 225 | JavaScript | Clean Architecture | N/A | PostgreSQL | REST APIs | Memory Cache |
-| 226 | JavaScript | Clean Architecture | N/A | PostgreSQL | GraphQL | None |
-| 227 | JavaScript | Clean Architecture | N/A | PostgreSQL | GraphQL | Redis |
-| 228 | JavaScript | Clean Architecture | N/A | PostgreSQL | GraphQL | Memory Cache |
-| 229 | JavaScript | Clean Architecture | N/A | PostgreSQL | Kafka | None |
-| 230 | JavaScript | Clean Architecture | N/A | PostgreSQL | Kafka | Redis |
-| 231 | JavaScript | Clean Architecture | N/A | PostgreSQL | Kafka | Memory Cache |
-| 232 | JavaScript | Clean Architecture | N/A | MongoDB | REST APIs | None |
-| 233 | JavaScript | Clean Architecture | N/A | MongoDB | REST APIs | Redis |
-| 234 | JavaScript | Clean Architecture | N/A | MongoDB | REST APIs | Memory Cache |
-| 235 | JavaScript | Clean Architecture | N/A | MongoDB | GraphQL | None |
-| 236 | JavaScript | Clean Architecture | N/A | MongoDB | GraphQL | Redis |
-| 237 | JavaScript | Clean Architecture | N/A | MongoDB | GraphQL | Memory Cache |
-| 238 | JavaScript | Clean Architecture | N/A | MongoDB | Kafka | None |
-| 239 | JavaScript | Clean Architecture | N/A | MongoDB | Kafka | Redis |
-| 240 | JavaScript | Clean Architecture | N/A | MongoDB | Kafka | Memory Cache |

package/docs/generatorFlow.md

@@ -1,233 +0,0 @@
-# Generator Flow Documentation
-
-This document outlines the internal flow of the `nodejs-quickstart-structure` generator, including user options, the step-by-step generation process, and the resulting codebase structures.
-
-## 1. Technologies Used
-
-The `nodejs-quickstart-structure` CLI is built using the following key technologies:
-
-*   **[Node.js](https://nodejs.org/)**: The runtime environment.
-*   **[Commander.js](https://github.com/tj/commander.js)** (`^13.1.0`): For parsing command-line arguments and options.
-*   **[Inquirer.js](https://github.com/SBoudrias/Inquirer.js)** (`^12.4.1`): For interactive command-line user interface (prompts).
-*   **[Chalk](https://github.com/chalk/chalk)** (`^5.4.1`): For terminal string styling (color output).
-*   **[EJS (Embedded JavaScript templates)](https://github.com/mde/ejs)** (`^3.1.10`): For templating files (dynamic content generation).
-*   **[fs-extra](https://github.com/jprichardson/node-fs-extra)** (`^11.3.0`): For enhanced file system methods (copy, ensureDir, etc.).
-
-## 2. User Choices (Cases)
-
-The generator prompts the user for the following configurations. These determine the logic and structure of the generated project.
-
-| Option | Choices | Default | Description |
-| :--- | :--- | :--- | :--- |
-| **Project Name** | Input String | `nodejs-service` | Name of the project directory. |
-| **Language** | `JavaScript`, `TypeScript` | `TypeScript` | The programming language to use. |
-| **Architecture** | `MVC`, `Clean Architecture` | `MVC` | The architectural pattern. |
-| **View Engine** | `None`, `EJS`, `Pug` | `None` | (MVC Only) Template engine for server-side rendering. |
-| **Database** | `None`, `MySQL`, `PostgreSQL`, `MongoDB` | `None` | The primary database. |
-| **Database Name** | Input String | `demo` | The name of the database to use/create. |
-| **Communication**| `REST APIs`, `GraphQL`, `Kafka` | `REST APIs` | The primary communication method. |
-| **Caching Layer**| `None`, `Redis`, `Memory Cache` | `None` | (If DB selected) Caching solution. |
-| **CI/CD Provider**| `None`, `GitHub Actions`, `Jenkins`| `None` | Setup for Continuous Integration/Deployment. |
-
-## 3. Main Generator Flow
-
-The `generateProject` function in `lib/generator.js` executes the following steps:
-
-1.  **Create Project Directory**: Ensures the directory does not already exist and creates it.
-2.  **Select & Copy Base Structure**:
-    *   Based on **Architecture** (`mvc`/`clean-architecture`) and **Language** (`js`/`ts`), it selects the appropriate template from `templates/{arch}/{lang}`.
-    *   Copies the entire base template to the target directory.
-3.  **Render `package.json`**:
-    *   Uses `templates/common/package.json.ejs`.
-    *   Injects dependencies based on User Choices (DB drivers, view engines, etc.).
-4.  **Render `docker-compose.yml`**:
-    *   Uses `templates/common/docker-compose.yml.ejs`.
-    *   Configures services (DB, Zookeeper/Kafka) based on selection.
-    *   **Note**: If Database is `None`, DB services are excluded.
-5.  **Render `README.md`**:
-    *   Generates custom documentation specific to the selected stack.
-6.  **Render `src/index.{js|ts}`**:
-    *   Processes the entry point file to wire up the selected DB, Architecture, and Communication type.
-    *   **GraphQL**: Wires up Apollo Server middleware with `formatError` hook for centralized error handling.
-    *   **REST APIs / Kafka**: Registers `app.use(errorMiddleware)` at the end of the Express chain.
-7.  **Render Error Middleware** (`renderErrorMiddleware`):
-    *   Processes `error.middleware.{ts|js}.ejs` template from the target directory's `src/utils/` path.
-    *   Renders to `src/utils/error.middleware.{ts|js}` in the generated project.
-    *   **Clean Architecture**: Also handles `src/infrastructure/webserver/middlewares/error.middleware.{js}` path.
-8.  **Dynamic Component Generation**:
-    *   **MVC**: Generates `userController` (imports specific DB service, uses `next(error)`).
-    *   **Clean Architecture**: Generates `UserRepository` (infrastructure layer implementation).
-    *   **Clean Architecture (JS only)**: Generates `server.js` (webserver setup).
-9.  **Communication Setup**:
-    *   **GraphQL**:
-        *   Generates Apollo Server v4 schema (`typeDefs`) and resolvers.
-        *   Configures `formatError` hook with `unwrapResolverError` for structured error mapping.
-        *   Automatically embeds Apollo Sandbox with local CSP headers (no CDN dependency).
-    *   **Kafka**:
-        *   Copies Kafka client/service templates.
-        *   **Clean Architecture Restructuring**:
-            *   Moves service to `src/infrastructure/messaging`.
-            *   Moves config to `src/infrastructure/config`.
-            *   Removes REST-specific folders (`interfaces/routes`, `interfaces/controllers`).
-        *   **MVC Cleanup**:
-            *   If no View Engine is selected, removes `src/controllers` and `src/routes` (assumes pure worker).
-10. **Common Configuration**:
-    *   Copies `.gitignore`, `.dockerignore`, `Dockerfile`.
-    *   Copies `tsconfig.json` (if TypeScript).
-11. **Database Setup**:
-    *   **MongoDB**: Sets up `migrate-mongo-config.js` and initial migration script.
-    *   **SQL (MySQL/Postgres)**: Sets up `flyway/sql` directory and copies initial SQL migration files.
-    *   **None**: Skips migration setup.
-12. **Caching Setup**:
-    *   **Redis**:
-        *   Injects `ioredis` dependency into `package.json`.
-        *   Generates `redisClient.{js|ts}` config.
-        *   **MVC**: Injects generic caching logic into `userController`.
-        *   **Clean Architecture**: Overwrites UseCases with caching-enabled versions.
-    *   **Memory Cache**:
-        *   Injects `node-cache` dependency.
-        *   Generates `memoryCache.{js|ts}` config.
-        *   **MVC/Clean**: Consumes the generic abstraction injected above.
-13. **Database Connection Config**:
-    *   Renders `database.{js|ts}` or `mongoose.{js|ts}` based on DB selection.
-    *   Places it in `src/config` (MVC) or `src/infrastructure/database` (Clean Arch).
-    *   **None**: Skips this step.
-14. **Model Generation**:
-    *   Renders `User` model (Mongoose schema or Sequelize/TypeORM model) in the appropriate directory.
-    *   **None**: Generates a simple Mock Entity/Model class with in-memory data for testing.
-15. **View Engine Setup (MVC)**:
-    *   If selected, copies views (`views/ejs` or `views/pug`) and `public` assets.
-16. **Swagger Config** (`renderSwaggerConfig`):
-    *   If **REST APIs** is selected, generates `swagger.yml` and `swagger.{ts|js}` config.
-    *   Cleans up `.ejs` template copies for non-REST configs (GraphQL, Kafka).
-17. **Code Quality Setup**:
-    *   Generates `.eslintrc.json`, `.prettierrc`, `.lintstagedrc`.
-18. **Test Setup**:
-    *   Generates `jest.config.js` and a sample `health.test.{js|ts}`.
-19. **CI/CD Setup**:
-    *   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
-
-The logic handles language differences via conditional checks and file extensions (`langExt` variable).
-
-| Step | JavaScript (`js`) | TypeScript (`ts`) |
-| :--- | :--- | :--- |
-| **Base Template** | `templates/{arch}/js` | `templates/{arch}/ts` |
-| **Entry Point** | `src/index.js` | `src/index.ts` |
-| **tsconfig.json** | Skipped | Copied from `templates/common/tsconfig.json` |
-| **Linting** | Standard JS config | TS-specific parser and plugins in `.eslintrc` |
-| **Database Config** | `mongoose.js` / `database.js` | `mongoose.ts` / `database.ts` |
-| **Models/Controllers**| `.js` extension | `.ts` extension |
-| **Build Step** | No compilation needed | Compilation typically handled by `tsc` or `ts-node` in dev |
-
-## 5. Possible Codebase Structures
-
-The final structure depends heavily on **Architecture**, **Communication**, and **View Engine**.
-
-### Case A: MVC (REST API)
-Standard architecture for web APIs.
-
-```text
-project-name/
-├── src/
-│   ├── config/         # Database, Redis, Swagger, etc.
-│   ├── controllers/    # Request handlers (use next(error))
-│   ├── errors/         # ApiError, NotFoundError, BadRequestError
-│   ├── models/         # Database models
-│   ├── routes/         # Express routes
-│   ├── utils/
-│   │   ├── error.middleware.{ts|js}  # Global error handler
-│   │   ├── logger.{ts|js}
-│   │   └── httpCodes.{ts|js}
-│   └── index.js|ts     # Entry point (registers errorMiddleware last)
-├── tests/              # Jest tests
-├── package.json
-├── Dockerfile
-└── docker-compose.yml
-```
-
-### Case A2: MVC (GraphQL)
-Apollo Server v4 mounted as Express middleware.
-
-```text
-project-name/
-├── src/
-│   ├── config/         # Database, Redis config
-│   ├── controllers/    # GraphQL resolver backing logic (throws errors)
-│   ├── errors/         # ApiError, NotFoundError, BadRequestError
-│   ├── graphql/
-│   │   ├── schema/     # typeDefs
-│   │   └── resolvers/  # user.resolvers (calls controllers, throws errors)
-│   ├── models/
-│   ├── utils/
-│   │   ├── error.middleware.{ts|js}  # Express-level fallback error handler
-│   │   └── logger.{ts|js}
-│   └── index.js|ts     # Apollo Server + formatError hook
-└── ...
-```
-
-### Case B: MVC (Web App with Views)
-Includes frontend views rendered on the server.
-
-```text
-project-name/
-├── public/             # CSS, JS, Images
-├── src/
-│   ├── config/
-│   ├── controllers/
-│   ├── models/
-│   ├── routes/
-│   ├── views/          # EJS or Pug templates
-│   └── index.js|ts
-└── ...
-```
-
-### Case C: Clean Architecture (REST API)
-Separation of concerns with Domain, Use Cases, and Infrastructure.
-
-```text
-project-name/
-├── src/
-│   ├── domain/                 # Entities (Enterprise rules)
-│   ├── errors/                 # ApiError, NotFoundError, BadRequestError
-│   ├── use_cases/              # Application business rules
-│   ├── interfaces/             # Adapters
-│   │   ├── controllers/        # Use next(error) for error propagation
-│   │   └── routes/             # Pass NextFunction through handlers
-│   ├── infrastructure/         # Frameworks & Drivers
-│   │   ├── config/             # Environment config
-│   │   ├── caching/            # Redis Client
-│   │   ├── database/           # DB connection & models
-│   │   ├── repositories/       # Data access implementation
-│   │   └── webserver/
-│   │       ├── middlewares/
-│   │       │   └── error.middleware.js  # JS only — Express error handler
-│   │       └── server.js       # Express app setup
-│   ├── utils/
-│   │   └── error.middleware.ts  # TS — global error handler
-│   └── index.js|ts              # Registers errorMiddleware after Apollo/Express
-└── ...
-```
-
-### Case D: Clean Architecture (Kafka Worker)
-Optimized for event-driven microservices. HTTP routes are removed.
-
-```text
-project-name/
-├── src/
-│   ├── domain/
-│   ├── use_cases/
-│   ├── infrastructure/
-│   │   ├── config/             # Includes Kafka config
-│   │   ├── database/
-│   │   ├── messaging/          # Kafka Client/Consumer
-│   │   ├── repositories/
-│   │   └── webserver/          # (Optional/Minimal)
-│   └── index.js|ts
-└── ...
-```

package/docs/releaseNoteRule.md

@@ -1,42 +0,0 @@
-# Release Process
-
-This document outlines the steps to release a new version of `nodejs-quickstart-structure`.
-
-## 1. Update Changelog
-
-Before releasing, update `CHANGELOG.md`:
-1.  Create a new header for the new version (e.g., `## [1.4.6] - 2026-02-12`).
-2.  Document new features, bug fixes, and changes.
-3.  Save the file.
-
-## 2. Commit Changelog
-
-Stage the `CHANGELOG.md` changes but **do not commit yet** if you want to include it in the version bump commit.
-```bash
-git add CHANGELOG.md
-```
-
-## 3. Bump Version & Tag
-
-Run the appropriate `npm version` command. This will assume you have a clean working directory (after staging `CHANGELOG.md`).
-```bash
-npm version patch   # For bug fixes (1.4.5 -> 1.4.6)
-npm version minor   # For new features (1.4.5 -> 1.5.0)
-npm version major   # For breaking changes (1.4.5 -> 2.0.0)
-```
-*Note: This command automatically updates `package.json`, creates a git commit with the new version number, and creates a git tag (e.g., `v1.4.6`).*
-
-## 4. Push Changes & Tags
-
-Push the new commit and the new tag to GitHub:
-```bash
-git push origin main
-git push origin --follow-tags
-```
-
-## 5. Publish to NPM (Optional)
-
-If you are publishing this package to the npm registry:
-```bash
-npm publish
-```

package/docs/ruleDevelop.md

@@ -1,30 +0,0 @@
-# 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.
-
-## Verify function before commit
-- npm run test:e2e
-
-## Verify case sensitivity before commit

package/templates/common/tests/health.test.ts.ejs

@@ -1,14 +0,0 @@
-<% if (language === 'TypeScript') { %>import request from 'supertest';
-import express from 'express';<% } else { %>const request = require('supertest');
-const express = require('express');<% } %>
-
-const app = express();
-app.get('/health', (req, res) => res.json({ status: 'UP' }));
-
-describe('Health Check', () => {
-  it('should return 200 OK', async () => {
-    const res = await request(app).get('/health');
-    expect(res.status).toBe(200);
-    expect(res.body).toEqual({ status: 'UP' });
-  });
-});