nodejs-structure-cli 1.0.0

package/README.md

@@ -0,0 +1,32 @@
+# nodejs-structure-cli
+
+[![npm version](https://img.shields.io/npm/v/nodejs-structure-cli.svg?style=flat-square)](https://www.npmjs.com/package/nodejs-structure-cli)
+[![npm total downloads](https://img.shields.io/npm/dt/nodejs-structure-cli?style=flat-square&color=emerald&label=Downloads)](https://www.npmjs.com/package/nodejs-structure-cli)
+[![npm monthly downloads](https://img.shields.io/npm/dm/nodejs-structure-cli.svg?style=flat-square)](https://www.npmjs.com/package/nodejs-structure-cli)
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg?style=flat-square)](https://opensource.org/licenses/ISC)
+
+A powerful CLI tool to scaffold production-ready Node.js microservices with built-in best practices. Choose between **MVC** or **Clean Architecture**, **JavaScript** or **TypeScript**, and your preferred tech stack in seconds.
+
+---
+
+---
+
+## 🚀 Quick Start
+
+Generate your professional Node.js project in seconds without installing anything globally:
+
+```bash
+npx nodejs-structure-cli@latest init
+```
+
+### Installation (Optional)
+
+If you prefer to install it globally:
+
+```bash
+npm install -g nodejs-structure-cli
+# Then run:
+nodejs-structure-cli init
+```
+
+---

package/bin/index.js

@@ -0,0 +1,143 @@
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import chalk from "chalk";
+import { getProjectDetails } from "../lib/prompts.js";
+import { generateProject } from "../lib/generator.js";
+import { readFileSync } from "fs";
+import { join, dirname } from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const pkg = JSON.parse(
+  readFileSync(join(__dirname, "../package.json"), "utf-8"),
+);
+
+const program = new Command();
+
+program
+  .name("nodejs-structure-cli")
+  .description(
+    "🚀 CLI to scaffold production-ready Node.js microservices.\n\nGenerates projects with:\n- MVC or Clean Architecture\n- REST or Kafka\n- MySQL, PostgreSQL, or MongoDB\n- Docker, Flyway & Mongoose support",
+  )
+  .version(pkg.version, "-v, --version", "Output the current version")
+  .addHelpText(
+    "after",
+    `\n${chalk.yellow("Example:")}\n  $ nodejs-structure-cli init   ${chalk.gray("# Start the interactive setup")}\n`,
+  );
+
+program
+  .command("init")
+  .description("Initialize a new Node.js project")
+  .option("-n, --project-name <name>", "Project name")
+  .option("-l, --language <language>", "Language (JavaScript, TypeScript)")
+  .option(
+    "-a, --architecture <architecture>",
+    "Architecture (MVC, Clean Architecture)",
+  )
+  .option("--view-engine <view>", "View Engine (None, EJS, Pug) - MVC only")
+  .option("-d, --database <database>", "Database (MySQL, PostgreSQL)")
+  .option("--db-name <name>", "Database name")
+  .option(
+    "-c, --communication <communication>",
+    "Communication (REST APIs, GraphQL, Kafka)",
+  )
+  .option(
+    "--ci-provider <provider>",
+    "CI/CD Provider (None, GitHub Actions, Jenkins, GitLab CI)",
+  )
+  .option("--include-security", "Include Enterprise Security Hardening")
+  .option("--no-include-security", "Exclude Enterprise Security Hardening")
+  .option("--caching <type>", "Caching Layer (None/Redis)")
+  .action(async (options) => {
+    // Fix for Commander camelCase conversion
+    if (options.ciProvider) {
+      options.ciProvider = options.ciProvider;
+    }
+
+    console.log(chalk.blue("Welcome to the Node.js Quickstart Generator!"));
+
+    try {
+      const answers = await getProjectDetails(options);
+      console.log(
+        chalk.blue(
+          `\n🚀 Preparing to generate ${chalk.bold(answers.projectName)} (${answers.architecture})...`,
+        ),
+      );
+
+      console.log(chalk.yellow("\nGenerating project files..."));
+      await generateProject(answers);
+
+      console.log(chalk.green("\n✔ Project generated successfully!"));
+
+      console.log(chalk.magenta("\n🚀 Project is AI-Ready!"));
+      console.log(chalk.magenta("-----------------------------------------"));
+      console.log(chalk.magenta("🤖 We detected you are using AI tools."));
+      console.log(
+        chalk.magenta(
+          `📍 Use Cursor? We've configured '.cursorrules' for you.`,
+        ),
+      );
+      console.log(
+        chalk.magenta(
+          `📍 Use ChatGPT/Gemini? Check the 'prompts/' folder for Agent Skills.`,
+        ),
+      );
+      console.log(chalk.magenta("-----------------------------------------"));
+
+      let manualStartInstructions = `\n${chalk.yellow("Development:")}\n  cd ${answers.projectName}\n  npm install`;
+
+      const needsInfrastructure =
+        answers.database !== "None" ||
+        answers.caching === "Redis" ||
+        answers.communication === "Kafka";
+
+      if (needsInfrastructure) {
+        let servicesToStart = "";
+        if (answers.database === "MongoDB") servicesToStart += " db";
+        else if (answers.database !== "None") servicesToStart += " db flyway";
+        if (answers.caching === "Redis") servicesToStart += " redis";
+        if (answers.communication === "Kafka") servicesToStart += " kafka";
+
+        manualStartInstructions += `\n  docker-compose up -d${servicesToStart}  # Start infrastructure first\n  npm run dev`;
+      } else {
+        manualStartInstructions += `\n  npm run dev`;
+      }
+
+      console.log(
+        chalk.cyan(
+          `\nNext steps:\n  cd ${answers.projectName}\n  npm install\n  docker-compose up\n-----------------------${manualStartInstructions}\n\n${chalk.yellow("Production (PM2):")}\n  npm run build\n  npm run deploy\n  npx pm2 logs`,
+        ),
+      );
+
+      console.log(chalk.magenta("\n" + "★".repeat(50)));
+      console.log(
+        chalk.white.bold("  Enjoying the Node.js Quickstart Generator?"),
+      );
+      console.log(
+        chalk.white(`  If this tool saved you 4+ hours of architecture setup,`),
+      );
+      console.log(
+        chalk.white(`  please help us grow by giving us a ⭐ on GitHub!`),
+      );
+      console.log(
+        chalk.white(
+          `\n  👉 ${chalk.underline.bold("https://github.com/Jaysoni2709")}`,
+        ),
+      );
+      console.log(chalk.magenta("★".repeat(50) + "\n"));
+    } catch (error) {
+      if (error.name === "ExitPromptError") {
+        console.log(chalk.yellow("\n\n👋 Goodbye! Setup cancelled."));
+        process.exit(0);
+      }
+      console.error(chalk.red("Error generating project:"), error);
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);
+
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}

package/lib/generator.js

@@ -0,0 +1,145 @@
+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, renderAuthAndUploadComponents } 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,
+        auth: 'None',
+        googleLogin: 'None',
+        includeMulter: 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);
+
+    // 13.6 Auth & Upload Components
+    await renderAuthAndUploadComponents(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}` : ''}${config.auth && config.auth !== 'None' ? `\n      Authentication: ${config.auth}` : ''}${config.googleLogin && config.googleLogin !== 'None' ? `\n      Social Login: ${config.googleLogin}` : ''}${config.includeMulter ? `\n      Image Upload: Multer` : ''}
+
+      ----------------------------------------------------
+      ✨  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)
+    `);
+};