neatnode 3.2.0 → 3.3.1

package/README.md

@@ -1,131 +1,135 @@
-<div align="center">
-  <img src="https://i.postimg.cc/9Fvw7p3q/1762540009103.png" width="120" alt="NeatNode Logo" />
-  <h1>NeatNode</h1>
-  <p><strong>Instantly scaffold production-ready Node.js backends with one command.</strong></p>
-
-  <img src="https://i.postimg.cc/59sw6LN6/1762540161048.png" alt="NeatNode Banner" />
-</div>
-
----
-
-## Overview
-
-**NeatNode** is a plug-and-play CLI that scaffolds clean, production-ready **Node.js backends** in seconds.  
-It comes with pre-built templates, optional CRUD modules, and a modern developer workflow — so you can start coding instead of configuring.
-
----
-
-## Features
-
-- Multiple templates: **Basic API**, **REST API**, and **Socket API**
-- Clean MVC folder structure
-- Optional CRUD scaffolding (User or Todo)
-- Integrated logging (Winston + Morgan)
-- Security middleware (Helmet, Rate Limiter)
-- Dynamic CLI with file removal & template customization
-- Ready for ESM, Redis, and future TypeScript support
-
----
-
-## Installation
-
-```bash
-npm install -g neatnode
-````
-
-or run directly with:
-
-```bash
-npx neatnode
-```
-
----
-
-## Usage
-
-```bash
-npx neatnode
-```
-
-* Enter your **project name**
-* Choose a **template** (Basic / REST / Socket)
-* Select whether to include **CRUD** examples
-* Install dependencies and start your project:
-
-```bash
-cd my-app
-npm install
-npm run dev
-```
-
----
-
-## Templates
-
-### Basic API
-
-Minimal Express setup with optional Todo CRUD.
-Perfect for small projects or quick prototypes.
-
-### REST API
-
-Full architecture with controllers, services, models, routes, error handling, validation, and logging.
-Ideal for scalable, production-grade APIs.
-
-### Socket API
-
-Express + Socket.io integration with logging and CORS setup.
-Best for chat apps or real-time systems.
-
----
-
-## Example Project Structure
-
-```
-src/
- ├── controllers/
- ├── models/
- ├── routes/
- ├── services/
- ├── utils/
- └── app.js
-```
-
----
-
-## Built With
-
-* Node.js & Express
-* Inquirer (CLI interaction)
-* fs-extra & path (file system automation)
-* Morgan & Winston (logging)
-* Joi (validation)
-* Helmet, Rate Limiter (security)
-
----
-
-## Project Screenshots
-
-### Frontend Website
-
-> Official landing page for NeatNode <img src="https://i.postimg.cc/85QVd7pn/Untitled-design.png" alt="NeatNode Landing Page" />
-
----
-
-### Documentation Website
-
-> Comprehensive docs built with Nextra <img src="https://i.postimg.cc/QNY0vR5r/Untitled-design-1.png" alt="NeatNode Docs" />
-
----
-
-## Author
-
-**Aakash Gupta**
-· [GitHub](https://github.com/aakash-gupta02) · [Email](mailto:aakashgupta052004@gmail.com) ·
-[Website](https://neatnode.vercel.app) · [Docs](https://neatnodee-docs.vercel.app)
-
----
-
-## License
-
-MIT © Aakash Gupta
+<div align="center">
+  <img src="https://i.postimg.cc/9Fvw7p3q/1762540009103.png" width="120" alt="NeatNode Logo" />
+  <h1>NeatNode</h1>
+  <p><strong>Instantly scaffold production-ready Node.js backends with one command.</strong></p>
+
+  <img src="https://i.postimg.cc/59sw6LN6/1762540161048.png" alt="NeatNode Banner" />
+</div>
+
+## Overview
+
+**NeatNode** is a plug-and-play **CLI tool** that scaffolds clean, production-ready **Node.js backend projects** (JavaScript & TypeScript) in seconds.  
+It comes with pre-built templates, MVC or Modular architecture choices, optional CRUD modules, and a modern developer workflow - so you can **start coding instead of configuring.**
+
+## Features
+
+-  **Instant project setup** - generate a complete Node.js project structure instantly  
+-  **JavaScript & TypeScript support** - choose your preferred language  
+-  **Pre-configured templates** - Basic Express, REST API, and Socket.IO  
+-  **Flexible Architecture** - pick between classic MVC or Modular architectures for REST APIs  
+-  **Dynamic template logic** - easily include or exclude example CRUD modules (User, Todo, Auth)
+-  **Scalable architecture** - prebuilt folder layouts  
+-  **Security-first setup** - Helmet, Rate Limiter, and CORS integrated  
+-  **Built-in error handling & logging** - Winston + Morgan setup (depending on template)  
+-  **Production-ready** - clean, validated, and deployment-ready output  
+
+## Installation
+
+```bash
+# Install globally
+npm install -g neatnode
+```
+
+or run it directly using `npx`:
+
+```bash
+npx neatnode
+```
+
+## Usage
+
+1. Run the CLI:
+
+   ```bash
+   npx neatnode
+   ```
+2. Enter project folder name (default: `my-app`).
+3. Select Language:
+   * **JavaScript**
+   * **TypeScript**
+4. Choose your template (options depend on language).
+5. (Optional) For REST API in JavaScript, choose your architecture (MVC or Modular).
+6. (Optional) Incorporate example CRUD modules, like Todo, User, or Auth.
+7. Navigate and start building:
+
+   ```bash
+   cd <project_name>
+   npm install
+   npm run dev
+   ```
+
+## Available Templates
+
+### **JavaScript**
+| Template     | Description                                                                      |
+| ------------ | -------------------------------------------------------------------------------- |
+| **Basic Express** | Minimal structure with .env, nodemon, and clean folder setup (Optional Todo CRUD) |
+| **REST API** | Express.js REST API with controllers, routes, and MongoDB config. Supports **MVC** or **Modular** architecture. (Optional User CRUD) |
+| **Socket.IO**| Socket.io server setup for real-time apps |
+
+### **TypeScript**
+| Template     | Description                                                                      |
+| ------------ | -------------------------------------------------------------------------------- |
+| **Basic Express** | Minimal TS structure for Node.js (Optional Todo CRUD) |
+| **REST API** | Express.js REST API boilerplate with TS. (Modular architectural setup with Optional Auth CRUD) |
+
+## Example CLI Output
+
+```
+$ npx neatnode
+🚀 Welcome to NeatNode CLI!
+
+? Enter project folder name: api-server
+? Select language: TypeScript
+? Choose a template: REST API (TS)
+? Include example Auth CRUD? Yes
+
+✅ Project "api-server" created successfully using "REST API (TS)".
+
+Next steps:
+  cd api-server
+  npm install
+  npm run dev
+
+🎉 Happy Coding!
+```
+
+## Previews
+
+### **Frontend Website**
+
+> Official landing page for NeatNode
+>
+> <img alt="NeatNode Landing Page" src="https://raw.githubusercontent.com/aakash-gupta02/NeatNode/refs/heads/main/assets/images/landingPage.png" />
+
+### **Documentation Website**
+
+> Comprehensive docs built with Nextra
+>
+> <img alt="NeatNode Docs" src="https://raw.githubusercontent.com/aakash-gupta02/NeatNode/refs/heads/main/assets/images/docs.png" />
+
+## Build With
+
+* Node.js
+* Inquirer (CLI prompts)
+* Degit (repository fetching)
+* Chalk & Ora
+
+## Learn More
+
+* 📄 [Documentation](https://docs.neatnode.codes)
+* 💻 [Website](https://neatnode.codes)
+* 🧰 [NPM Package](https://www.npmjs.com/package/neatnode)
+
+## Author
+
+**Aakash Gupta**  
+[GitHub](https://github.com/aakash-gupta02) • [Portfolio](https://aakashgupta.app)
+
+## License
+
+This project is licensed under the **MIT License** — feel free to use, modify, and distribute.
+
+<div align="center">
+  <sub>Built with ❤️ by Aakash Gupta | NeatNode © 2026</sub>
+</div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neatnode",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "Plug & Play Node.js backend starter templates — build REST APIs, socket servers, and more in seconds.",
   "bin": {
     "neatnode": "bin/index.js"

package/src/actions/addEnv.js

@@ -0,0 +1,20 @@
+import fs from "fs";
+import path from "path";
+
+export async function addEnv({ targetPath }) {
+  try {
+    const envExamplePath = path.join(targetPath, ".env.example");
+    const envPath = path.join(targetPath, ".env");
+
+    if (
+      fs.existsSync(envExamplePath) &&
+      !fs.existsSync(envPath)
+    ) {
+      const envContent = fs.readFileSync(envExamplePath, "utf8");
+
+      fs.writeFileSync(envPath, envContent, "utf8");
+    }
+  } catch (error) {
+    console.error("Error adding .env file:", error);
+  }
+}

package/src/actions/createProject.js

@@ -3,8 +3,9 @@ import path from "path";
 import os from "os";
 import { fileURLToPath } from "url";
 import { copyTemplate } from "../utils/copyTemplate.js";
-import { removeCrud, removeCrudModule, removeCrudReferences } from "./removeCRUD.js";
+import { cleanupTemplateMarkers, removeCrud, removeCrudModule, removeCrudReferences } from "./removeCRUD.js";
 import { downloadTemplate } from "../utils/downloadRepoTemplateByVersionTags.js";
+import { addEnv } from "./addEnv.js";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -33,17 +34,35 @@ export async function createProject({ projectName, repoPath, includeCrud, crudNa
       "author": os.userInfo().username || "author",
     });
 
+    await addEnv({ targetPath });
+
     if (!includeCrud && crudName) {
       console.log("🗑 Removing CRUD files...");
 
       if (isModular) {
         removeCrudModule(targetPath, crudName);
-        removeCrudReferences(path.join(targetPath, "src", `routes/index.route.${langKey}`));
 
+        removeCrudReferences(
+          path.join(targetPath, "src", `routes/index.route.${langKey}`)
+        );
       }
 
       removeCrud(targetPath, crudName, langKey);
-      removeCrudReferences(path.join(targetPath, "src", `app.${langKey}`));
+
+      removeCrudReferences(
+        path.join(targetPath, "src", `app.${langKey}`)
+      );
+    }
+
+    // ALWAYS CLEANUP MARKERS
+    cleanupTemplateMarkers(
+      path.join(targetPath, "src", `app.${langKey}`)
+    );
+
+    if (isModular) {
+      cleanupTemplateMarkers(
+        path.join(targetPath, "src", `routes/index.route.${langKey}`)
+      );
     }
 
     console.log(`\n✅ Project "${projectName}" created successfully!\n`);

package/src/actions/removeCRUD.js

@@ -26,29 +26,52 @@ export function removeCrud(targetPath, name, langKey) {
   } catch (err) {
     console.error("❌ Error while removing CRUD files:", err.message);
   }
-}
+};
+
+export function cleanupTemplateMarkers(filePath) {
+  if (!fs.existsSync(filePath)) {
+    return false;
+  }
+
+  let content = fs.readFileSync(filePath, "utf8");
+
+  content = content
+    .replace(/^\s*\/\/ ROUTE_IMPORTS_START\s*$/gm, "")
+    .replace(/^\s*\/\/ ROUTE_IMPORTS_END\s*$/gm, "")
+    .replace(/^\s*\/\/ ROUTE_USES_START\s*$/gm, "")
+    .replace(/^\s*\/\/ ROUTE_USES_END\s*$/gm, "");
+
+  // Remove excessive blank lines
+  content = content.replace(/\n{3,}/g, "\n\n");
+
+  fs.writeFileSync(filePath, content, "utf8");
+
+  return true;
+};
 
 export function removeCrudReferences(appJsPath) {
   if (!fs.existsSync(appJsPath)) {
     return false;
   }
+
   let content = fs.readFileSync(appJsPath, "utf8");
 
-  // Remove imports block
+  // Remove imports block + surrounding blank lines
   content = content.replace(
-    /\/\/ ROUTE_IMPORTS_START[\s\S]*?\/\/ ROUTE_IMPORTS_END/,
-    "",
+    /\s*\/\/ ROUTE_IMPORTS_START[\s\S]*?\/\/ ROUTE_IMPORTS_END\s*/g,
+    "\n",
   );
 
-  // Remove route usage block
+  // Remove route usage block + surrounding blank lines
   content = content.replace(
-    /\/\/ ROUTE_USES_START[\s\S]*?\/\/ ROUTE_USES_END/,
-    "",
+    /\s*\/\/ ROUTE_USES_START[\s\S]*?\/\/ ROUTE_USES_END\s*/g,
+    "\n",
   );
 
   fs.writeFileSync(appJsPath, content, "utf8");
+
   return true;
-}
+};
 
 export function removeCrudModule(targetPath, name) {
   try {
@@ -62,4 +85,4 @@ export function removeCrudModule(targetPath, name) {
   } catch (err) {
     console.error("❌ Error while removing CRUD module:", err.message);
   }
-}
+};

package/src/cli.js

@@ -1,128 +1,147 @@
-#!/usr/bin/env node
-import inquirer from "inquirer";
-import templates from "./config/templates.js";
-import { createProject } from "./actions/createProject.js";
-
-async function main() {
-  console.log("\n🚀 Welcome to NeatNode CLI!\n");
-
-  // STEP 1 — Project Name
-  const { projectName } = await inquirer.prompt([
-    {
-      type: "input",
-      name: "projectName",
-      message: "Enter project folder name:",
-      default: "my-app",
-      validate: (v) => v.trim() !== "" || "Project name cannot be empty.",
-    },
-  ]);
-
-  // STEP 2 — Choose Language
-  const { language } = await inquirer.prompt([
-    {
-      type: "list",
-      name: "language",
-      message: "Select language:",
-      choices: ["JavaScript", "TypeScript"],
-    },
-  ]);
-
-  const langKey = language === "JavaScript" ? "js" : "ts";
-  const templateList = templates[langKey];
-
-  // STEP 3 — Choose Template
-  const { template } = await inquirer.prompt([
-    {
-      type: "list",
-      name: "template",
-      message: "Choose a template:",
-      choices: templateList.map((t) => t.name),
-    },
-  ]);
-
-  const chosen = templateList.find((t) => t.name === template);
-
-  // STEP 4 — CRUD Optional (only for some templates)
-  let includeCrud = false;
-  let isModular = chosen.isModular || false;
-  let crudName = "";
-
-  if (chosen.name === "Basic Express") {
-    const { includeCrud: answer } = await inquirer.prompt([
-      {
-        type: "confirm",
-        name: "includeCrud",
-        message: "Include example Todo CRUD?",
-        default: true,
-      },
-    ]);
-    includeCrud = answer;
-    crudName = "todo";
-  }
-
-  if (chosen.name === "REST API") {
-    const { includeCrud: answer } = await inquirer.prompt([
-      {
-        type: "confirm",
-        name: "includeCrud",
-        message: "Include example User CRUD?",
-        default: true,
-      },
-    ]);
-    includeCrud = answer;
-    crudName = "user";
-  }
-
-  if (chosen.name === "Basic Express (TS)") {
-    const { includeCrud: answer } = await inquirer.prompt([
-      {
-        type: "confirm",
-        name: "includeCrud",
-        message: "Include example Todo CRUD?",
-        default: true,
-      },
-    ]);
-    includeCrud = answer;
-    crudName = "todo";
-  }
-  if (chosen.name === "REST API (TS)") {
-    const { includeCrud: answer } = await inquirer.prompt([
-      {
-        type: "confirm",
-        name: "includeCrud",
-        message: "Include example Auth CRUD?",
-        default: true,
-      },
-    ]);
-    includeCrud = answer;
-    crudName = "auth";
-    isModular = chosen.isModular;
-  }
-
-  // STEP 5 — Create Project (Remote download logic inside)
-  await createProject({
-    projectName,
-    repoPath: chosen.repoPath,
-    includeCrud,
-    crudName,
-    langKey,
-    isModular,
-  });
-
-  
-  console.log(`\n✅ Project "${projectName}" created successfully using "${chosen.name}".\n`);
-
-  console.log("Next steps:");
-  console.log(`  cd ${projectName}`);
-  console.log("  npm install");
-  console.log("  npm run dev\n");
-
-  console.log("🎉 Happy Coding!\n");
-
-
-
-}
-
-main().catch((err) => {
-  console.error("❌ Error:", err.message || err);
-});
+#!/usr/bin/env node
+import inquirer from "inquirer";
+import templates from "./config/templates.js";
+import { createProject } from "./actions/createProject.js";
+
+async function main() {
+  console.log("\n🚀 Welcome to NeatNode CLI!\n");
+
+  // STEP 1 — Project Name
+  const { projectName } = await inquirer.prompt([
+    {
+      type: "input",
+      name: "projectName",
+      message: "Enter project folder name:",
+      default: "my-app",
+      validate: (v) => v.trim() !== "" || "Project name cannot be empty.",
+    },
+  ]);
+
+  // STEP 2 — Choose Language
+  const { language } = await inquirer.prompt([
+    {
+      type: "list",
+      name: "language",
+      message: "Select language:",
+      choices: ["JavaScript", "TypeScript"],
+    },
+  ]);
+
+  const langKey = language === "JavaScript" ? "js" : "ts";
+  const templateList = templates[langKey];
+
+  // STEP 3 — Choose Template
+  const { template } = await inquirer.prompt([
+    {
+      type: "list",
+      name: "template",
+      message: "Choose a template:",
+      choices: templateList.map((t) => t.name),
+    },
+  ]);
+
+  const chosen = templateList.find((t) => t.name === template);
+
+  let isModular = chosen.isModular || false;
+  let architecture = null;
+
+  if (chosen.architecture) {
+    const answer = await inquirer.prompt([
+      {
+        type: "list",
+        name: "architecture",
+        message: "Select architecture:",
+        choices: ["mvc", "modular"],
+      },
+    ]);
+
+    architecture = answer.architecture;
+    isModular = architecture === "modular";
+
+    chosen.repoPath = chosen.architecture[architecture];
+
+  }
+
+  // STEP 4 — CRUD Optional (only for some templates)
+  let includeCrud = false;
+  let crudName = "";
+
+  if (chosen.name === "Basic Express") {
+    const { includeCrud: answer } = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "includeCrud",
+        message: "Include example Todo CRUD?",
+        default: true,
+      },
+    ]);
+    includeCrud = answer;
+    crudName = "todo";
+  }
+
+  if (chosen.name === "REST API") {
+    const { includeCrud: answer } = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "includeCrud",
+        message: "Include example User CRUD?",
+        default: true,
+      },
+    ]);
+    includeCrud = answer;
+    crudName = "user";
+  }
+
+  if (chosen.name === "Basic Express (TS)") {
+    const { includeCrud: answer } = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "includeCrud",
+        message: "Include example Todo CRUD?",
+        default: true,
+      },
+    ]);
+    includeCrud = answer;
+    crudName = "todo";
+  }
+  if (chosen.name === "REST API (TS)") {
+    const { includeCrud: answer } = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "includeCrud",
+        message: "Include example Auth CRUD?",
+        default: true,
+      },
+    ]);
+    includeCrud = answer;
+    crudName = "auth";
+    isModular = chosen.isModular;
+  }
+
+  // STEP 5 — Create Project (Remote download logic inside)
+  await createProject({
+    projectName,
+    repoPath: chosen.repoPath,
+    includeCrud,
+    crudName,
+    langKey,
+    isModular,
+  });
+
+
+  console.log(`\n✅ Project "${projectName}" created successfully using "${chosen.name}".\n`);
+
+  console.log("Next steps:");
+  console.log(`  cd ${projectName}`);
+  console.log("  npm install");
+  console.log("  npm run dev\n");
+
+  console.log("🎉 Happy Coding!\n");
+
+
+
+}
+
+main().catch((err) => {
+  console.error("❌ Error:", err.message || err);
+});

package/src/config/templates.js

@@ -1,13 +1,19 @@
-export default {
-  js: [
-    { name: "Basic Express", repoPath: "templates/js/express-basic" },
-    { name: "REST API", repoPath: "templates/js/express-rest-api" },
-    { name: "Socket.IO", repoPath: "templates/js/express-socket" },
-  ],
-
-  ts: [
-    { name: "Basic Express (TS)", repoPath: "templates/ts/basic-express" },
-    { name: "REST API (TS)", repoPath: "templates/ts/express-rest-api", isModular: true },
-    // { name: "Socket.IO (TS)", repoPath: "templates/ts/express-socket" },
-  ],
-};
+export default {
+  js: [
+    { name: "Basic Express", repoPath: "templates/js/express-basic" },
+    {
+      name: "REST API",
+      architecture: {
+        mvc: "templates/js/express-rest-api",
+        modular: "templates/js/express-modular-rest-api"
+      }
+    },
+    { name: "Socket.IO", repoPath: "templates/js/express-socket" },
+  ],
+
+  ts: [
+    { name: "Basic Express (TS)", repoPath: "templates/ts/basic-express" },
+    { name: "REST API (TS)", repoPath: "templates/ts/express-rest-api", isModular: true },
+    // { name: "Socket.IO (TS)", repoPath: "templates/ts/express-socket" },
+  ],
+};

package/src/utils/downloadRepoTemplateByVersionTags.js

@@ -114,9 +114,6 @@ export async function downloadTemplate(repoPath) {
         refType: candidate.refType,
       });
 
-      console.log(
-        `Template downloaded and extracted from ${candidate.refType} "${candidate.ref}"`,
-      );
       return templatePath;
     } catch (error) {
       const message = error instanceof Error ? error.message : String(error);

package/src/utils/downloadRepoTemplate.js

@@ -1,51 +0,0 @@
-import axios from "axios";
-import extract from "extract-zip";
-import fs from "fs";
-import path from "path";
-import os from "os";
-import { fileURLToPath } from "url";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const owner = "aakash-gupta02";
-const repo = "NeatNode";
-
-const zipUrl = `https://codeload.github.com/${owner}/${repo}/zip/refs/heads/main`;
-
-export async function downloadTemplate(repoPath) {
-  // SAFE TEMP DIRECTORY
-  const tmpBase = fs.mkdtempSync(path.join(os.tmpdir(), "neatnode-"));
-
-  const tempZip = path.join(tmpBase, "repo.zip");
-  const tempExtractDir = path.join(tmpBase, "repo-extract");
-  const tempFinalDir = path.join(tmpBase, "template-final");
-
-  // download zip
-  const response = await axios({
-    url: zipUrl,
-    responseType: "arraybuffer",
-  });
-
-  fs.writeFileSync(tempZip, response.data);
-
-  // unzip
-  await extract(tempZip, { dir: tempExtractDir });
-
-  const extractedRoot = path.join(tempExtractDir, `${repo}-main`);
-  const srcTemplatePath = path.join(extractedRoot, repoPath);
-
-  if (!fs.existsSync(srcTemplatePath)) {
-    throw new Error(
-      `Template path not found in downloaded archive: ${repoPath}`,
-    );
-  }
-
-  // copy template
-  fs.mkdirSync(tempFinalDir, { recursive: true });
-  fs.cpSync(srcTemplatePath, tempFinalDir, { recursive: true });
-
-  console.log("✔ Template downloaded & extracted");
-
-  return tempFinalDir;
-}