nodejs-quickstart-structure 1.18.1 → 1.19.1

package/LICENSE

@@ -1,15 +1,15 @@
-ISC License
-
-Copyright (c) 2026, Pau Dang
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ISC License
+
+Copyright (c) 2026, Pau Dang
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -20,7 +20,7 @@ A powerful CLI tool to scaffold production-ready Node.js microservices with buil
 - [⚙️ Configuration Options](#-configuration-options)
 - [🏗️ Generated Project Structure](#-generated-project-structure)
 - [📖 Documentation](#-documentation)
-- [🗺️ Roadmap & Support](#️-roadmap--support)
+- [🗺️ Support & Roadmap](#️-roadmap--support)
 
 ---
 
@@ -53,6 +53,7 @@ nodejs-quickstart init
 - **Communication Patterns**: Supports **REST**, **GraphQL** (Apollo), and **Kafka** (Event-driven).
 - **Multi-layer Caching**: Integrated **Redis** or built-in **Memory Cache**.
 - **AI-Native Optimized**: specifically designed for **Cursor** and AI agents, including built-in `.cursorrules` and Agent Skill prompts. 🚀
+- **Next Gen Web UI**: (Coming Soon) A modern, browser-based project selector featuring real-time virtualization — set for release in v2.0.0!
 
 ---
 

package/lib/generator.js

@@ -1,139 +1,139 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { setupProjectDirectory, copyBaseStructure, copyCommonFiles } from './modules/project-setup.js';
-import { renderPackageJson, renderDockerCompose, renderReadme, renderDockerfile, renderProfessionalConfig, setupCiCd, renderTestSample, renderEnvExample, renderPm2Config, renderAiNativeFiles } from './modules/config-files.js';
-import { renderIndexFile, renderEnvConfig, renderErrorMiddleware, renderDynamicComponents, renderSwaggerConfig, setupViews as setupSrcViews, processAllTests } from './modules/app-setup.js';
-import { setupDatabase } from './modules/database-setup.js';
-import { setupKafka, setupViews } from './modules/kafka-setup.js';
-import { setupCaching } from './modules/caching-setup.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export const generateProject = async (config) => {
-    // 0. Normalize configuration with defaults
-    config = {
-        viewEngine: 'None',
-        caching: 'None',
-        dbName: 'demo',
-        ciProvider: 'GitHub Actions',
-        communication: 'REST APIs',
-        database: 'None',
-        includeSecurity: false,
-        ...config
-    };
-
-    const { projectName, architecture, language } = config;
-    const targetDir = path.resolve(process.cwd(), projectName);
-    const templatesDir = path.join(__dirname, '../templates');
-
-    // 1. Create project directory
-    await setupProjectDirectory(targetDir, projectName);
-
-    // 2. Select & Copy Base Structure
-    const { templatePath } = await copyBaseStructure(templatesDir, targetDir, architecture, language);
-
-    // 3. Render package.json
-    await renderPackageJson(templatesDir, targetDir, config);
-
-    // 4. Render docker-compose.yml
-    await renderDockerCompose(templatesDir, targetDir, config);
-
-    // 5. Render README.md
-    await renderReadme(templatesDir, targetDir, config);
-
-    // 6. Render index file (ts/js)
-    await renderIndexFile(templatePath, targetDir, config);
-
-    // 6a. Render Environment Configuration
-    await renderEnvConfig(templatePath, targetDir, config);
-
-    // 6a. Render error middleware
-    await renderErrorMiddleware(templatePath, targetDir, config);
-
-    // 7. Render Dynamic Components (Controllers/Repos/Server)
-    await renderDynamicComponents(templatePath, targetDir, config);
-
-    // 8. Kafka Setup
-    await setupKafka(templatesDir, targetDir, config);
-
-    // 9. Common Files (.gitignore, Dockerfile, tsconfig)
-    await copyCommonFiles(templatesDir, targetDir, language);
-    await renderDockerfile(templatesDir, targetDir, config);
-
-    // 10. Database Setup (Migrations, Config, Models)
-    // Note: logic for detailed view copying is also handled nicely if we ensure setupDatabase checks correctly,
-    // or we can move strict view logic to setupViews. 
-    // In strict refactor, database-setup handles the content that was in the DB block.
-    await setupDatabase(templatesDir, targetDir, config);
-
-    // 10a. Caching Setup
-    await setupCaching(templatesDir, targetDir, config);
-
-    // 11. View Engine Public Assets (MVC)
-    await setupViews(templatesDir, targetDir, config);
-    // Copy src/views (MVC)
-    await setupSrcViews(templatesDir, targetDir, config);
-
-    // 12. Swagger Config
-    await renderSwaggerConfig(templatesDir, targetDir, config);
-
-    // 13. Professional Config & Tests
-    await renderProfessionalConfig(templatesDir, targetDir, config);
-    await renderTestSample(templatesDir, targetDir, config);
-
-    // 13.5 AI-Native Scaffolding
-    await renderAiNativeFiles(templatesDir, targetDir, config);
-
-    // 14. CI/CD
-    await setupCiCd(templatesDir, targetDir, config);
-
-    // 15. Env Example
-    await renderEnvExample(templatesDir, targetDir, config);
-
-    // 16. PM2 Configuration
-    await renderPm2Config(templatesDir, targetDir, config);
-
-    // 17. Process All Tests
-    await processAllTests(targetDir, config);
-
-    console.log(`
-      ====================================================
-             Node.js Project Created Successfully!
-      ====================================================
-
-      Project: ${projectName}
-      Architecture: ${architecture}
-      Language: ${language}
-      Database: ${config.database}
-      Communication: ${config.communication}${config.caching && config.caching === 'Redis' ? `\n      Caching: ${config.caching}` : ''}
-
-      ----------------------------------------------------
-      ✨  High-Quality Standards Applied:
-      ----------------------------------------------------
-      ✅  Linting & Formatting: Eslint + Prettier configured
-      ✅  Git Hooks: Husky + Lint-Staged ready
-      ✅  Security: Helmet, CORS, Rate-Limiting added${config.includeSecurity ? '\n      ✅  Enterprise Security: Snyk (SCA) & SonarCloud (SAST) integration' : ''}
-      ✅  Testing: Jest setup for Unit/Integration tests
-      ✅  Docker: Production-ready multi-stage build
-      ${config.ciProvider !== 'None' ? `✅  CI/CD: ${config.ciProvider} Workflow ready` : '❌  CI/CD: Skipped (User preferred)'}
-
-      ----------------------------------------------------
-      🚀  Project is AI-Ready!
-      ----------------------------------------------------
-      🤖  We detected you are using AI tools. 
-      📍  Use Cursor? We've configured '.cursorrules' for you.
-      📍  Use ChatGPT/Gemini? Check the 'prompts/' folder for Agent Skills.
-
-      ----------------------------------------------------
-      👉  Next Steps:
-      ----------------------------------------------------
-      1. cd ${projectName}
-      2. git init
-      3. npm install
-      4. npm run prepare      (To setup Husky hooks)
-      5. docker-compose up -d${config.database !== 'None' ? ' db' : ''}${config.caching === 'Redis' ? ' redis' : ''}${config.communication === 'Kafka' ? ' kafka' : ''} (To start DB/Infrastructure)
-      6. npm run dev          (To start development server)
-      7. npm test             (To run tests)
-    `);
-};
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { setupProjectDirectory, copyBaseStructure, copyCommonFiles } from './modules/project-setup.js';
+import { renderPackageJson, renderDockerCompose, renderReadme, renderDockerfile, renderProfessionalConfig, setupCiCd, renderTestSample, renderEnvExample, renderPm2Config, renderAiNativeFiles } from './modules/config-files.js';
+import { renderIndexFile, renderEnvConfig, renderErrorMiddleware, renderDynamicComponents, renderSwaggerConfig, setupViews as setupSrcViews, processAllTests } from './modules/app-setup.js';
+import { setupDatabase } from './modules/database-setup.js';
+import { setupKafka, setupViews } from './modules/kafka-setup.js';
+import { setupCaching } from './modules/caching-setup.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export const generateProject = async (config) => {
+    // 0. Normalize configuration with defaults
+    config = {
+        viewEngine: 'None',
+        caching: 'None',
+        dbName: 'demo',
+        ciProvider: 'GitHub Actions',
+        communication: 'REST APIs',
+        database: 'None',
+        includeSecurity: false,
+        ...config
+    };
+
+    const { projectName, architecture, language } = config;
+    const targetDir = path.resolve(process.cwd(), projectName);
+    const templatesDir = path.join(__dirname, '../templates');
+
+    // 1. Create project directory
+    await setupProjectDirectory(targetDir, projectName);
+
+    // 2. Select & Copy Base Structure
+    const { templatePath } = await copyBaseStructure(templatesDir, targetDir, architecture, language);
+
+    // 3. Render package.json
+    await renderPackageJson(templatesDir, targetDir, config);
+
+    // 4. Render docker-compose.yml
+    await renderDockerCompose(templatesDir, targetDir, config);
+
+    // 5. Render README.md
+    await renderReadme(templatesDir, targetDir, config);
+
+    // 6. Render index file (ts/js)
+    await renderIndexFile(templatePath, targetDir, config);
+
+    // 6a. Render Environment Configuration
+    await renderEnvConfig(templatePath, targetDir, config);
+
+    // 6a. Render error middleware
+    await renderErrorMiddleware(templatePath, targetDir, config);
+
+    // 7. Render Dynamic Components (Controllers/Repos/Server)
+    await renderDynamicComponents(templatePath, targetDir, config);
+
+    // 8. Kafka Setup
+    await setupKafka(templatesDir, targetDir, config);
+
+    // 9. Common Files (.gitignore, Dockerfile, tsconfig)
+    await copyCommonFiles(templatesDir, targetDir, language);
+    await renderDockerfile(templatesDir, targetDir, config);
+
+    // 10. Database Setup (Migrations, Config, Models)
+    // Note: logic for detailed view copying is also handled nicely if we ensure setupDatabase checks correctly,
+    // or we can move strict view logic to setupViews. 
+    // In strict refactor, database-setup handles the content that was in the DB block.
+    await setupDatabase(templatesDir, targetDir, config);
+
+    // 10a. Caching Setup
+    await setupCaching(templatesDir, targetDir, config);
+
+    // 11. View Engine Public Assets (MVC)
+    await setupViews(templatesDir, targetDir, config);
+    // Copy src/views (MVC)
+    await setupSrcViews(templatesDir, targetDir, config);
+
+    // 12. Swagger Config
+    await renderSwaggerConfig(templatesDir, targetDir, config);
+
+    // 13. Professional Config & Tests
+    await renderProfessionalConfig(templatesDir, targetDir, config);
+    await renderTestSample(templatesDir, targetDir, config);
+
+    // 13.5 AI-Native Scaffolding
+    await renderAiNativeFiles(templatesDir, targetDir, config);
+
+    // 14. CI/CD
+    await setupCiCd(templatesDir, targetDir, config);
+
+    // 15. Env Example
+    await renderEnvExample(templatesDir, targetDir, config);
+
+    // 16. PM2 Configuration
+    await renderPm2Config(templatesDir, targetDir, config);
+
+    // 17. Process All Tests
+    await processAllTests(targetDir, config);
+
+    console.log(`
+      ====================================================
+             Node.js Project Created Successfully!
+      ====================================================
+
+      Project: ${projectName}
+      Architecture: ${architecture}
+      Language: ${language}
+      Database: ${config.database}
+      Communication: ${config.communication}${config.caching && config.caching === 'Redis' ? `\n      Caching: ${config.caching}` : ''}
+
+      ----------------------------------------------------
+      ✨  High-Quality Standards Applied:
+      ----------------------------------------------------
+      ✅  Linting & Formatting: Eslint + Prettier configured
+      ✅  Git Hooks: Husky + Lint-Staged ready
+      ✅  Security: Helmet, CORS, Rate-Limiting added${config.includeSecurity ? '\n      ✅  Enterprise Security: Snyk (SCA) & SonarCloud (SAST) integration' : ''}
+      ✅  Testing: Jest setup for Unit/Integration tests
+      ✅  Docker: Production-ready multi-stage build
+      ${config.ciProvider !== 'None' ? `✅  CI/CD: ${config.ciProvider} Workflow ready` : '❌  CI/CD: Skipped (User preferred)'}
+
+      ----------------------------------------------------
+      🚀  Project is AI-Ready!
+      ----------------------------------------------------
+      🤖  We detected you are using AI tools. 
+      📍  Use Cursor? We've configured '.cursorrules' for you.
+      📍  Use ChatGPT/Gemini? Check the 'prompts/' folder for Agent Skills.
+
+      ----------------------------------------------------
+      👉  Next Steps:
+      ----------------------------------------------------
+      1. cd ${projectName}
+      2. git init
+      3. npm install
+      4. npm run prepare      (To setup Husky hooks)
+      5. docker-compose up -d${config.database !== 'None' ? ' db' : ''}${config.caching === 'Redis' ? ' redis' : ''}${config.communication === 'Kafka' ? ' kafka' : ''} (To start DB/Infrastructure)
+      6. npm run dev          (To start development server)
+      7. npm test             (To run tests)
+    `);
+};