neatnode 1.0.1 → 3.0.1

package/README.md

@@ -0,0 +1,107 @@
+# NeatNode
+
+**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.
+
+---
+
+## 🚀 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:
+
+```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 Structure
+
+```
+src/
+ ├── controllers/
+ ├── models/
+ ├── routes/
+ ├── services/
+ ├── utils/
+ └── app.js
+```
+
+---
+
+## 🛠️ Built With
+
+* Node.js & Express
+* Inquirer (CLI)
+* fs-extra & path (File system automation)
+* Morgan & Winston (Logging)
+* Joi (Validation)
+* Helmet, Rate Limiter (Security)
+
+---
+
+## 🧑‍💻 Author
+
+**Aakash Gupta**
+[GitHub](https://github.com/aakash-gupta02) · [Email](mailto:aakashgupta052004@gmail.com)
+
+---
+
+## 🪪 License
+
+MIT © Aakash Gupta
+

package/bin/index.js

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 import("../src/cli.js");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neatnode",
-  "version": "1.0.1",
+  "version": "3.0.1",
   "description": "Plug & Play Node.js backend starter templates — build REST APIs, socket servers, and more in seconds.",
   "bin": {
     "neatnode": "./bin/index.js"
@@ -15,6 +15,14 @@
     "template",
     "neatnode"
   ],
+  "files": [
+    "bin/",
+    "src/",
+    "templates/",
+    "utils/",
+    "package.json",
+    "README.md"
+  ],
   "author": {
     "name": "Aakash Gupta",
     "email": "aakashgupta052004@gmail.com",

package/src/actions/createProject.js

@@ -1,32 +1,49 @@
 import fs from "fs";
 import path from "path";
+import os from "os";
 import { fileURLToPath } from "url";
 import { copyTemplate } from "../utils/copyTemplate.js";
+import { removeCrud, removeCrudReferences } from "./removeCRUD.js";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
-export async function createProject({ projectName, templatePath }) {
+export async function createProject({ projectName, templatePath, includeCrud, crudName }) {
   try {
-    const targetPath = path.join(process.cwd(), projectName);
+    // If user wants to create in current dir (.)
+    const targetPath = projectName === "." ? process.cwd() : path.join(process.cwd(), projectName);
 
-    // Prevent overwriting existing folder
-    if (fs.existsSync(targetPath)) {
+    if (fs.existsSync(targetPath) && projectName !== ".") {
       console.error(`❌ Folder "${projectName}" already exists.`);
       process.exit(1);
     }
 
-    // Copy template
-    console.log("📁 Creating project folder...");
-    fs.mkdirSync(targetPath);
-    await copyTemplate(templatePath, targetPath);
+    if (projectName !== ".") {
+      console.log("Creating project folder...");
+      fs.mkdirSync(targetPath);
+    }
+
+    await copyTemplate(templatePath, targetPath, {
+      "project-name": projectName === "." ? path.basename(process.cwd()) : projectName,
+      "author": os.userInfo().username || "author",
+    });
+
+    if (!includeCrud) {
+      console.log("🗑️ Removing CRUD files...");
+      removeCrud(targetPath, crudName);
+      removeCrudReferences(path.join(targetPath, "src", "app.js"));
+    } else {
+      console.log("✅ Including CRUD functionality...");
+    }
 
     console.log(`✅ Project "${projectName}" created successfully!`);
-    console.log(`\ncd ${projectName}`);
+    console.log(`\ncd ${projectName === "." ? "" : projectName}`);
     console.log("npm install");
     console.log("npm run dev (or npm start)\n");
+
   } catch (err) {
     console.error("Failed to create project:", err);
     process.exit(1);
   }
 }
+

package/src/actions/removeCRUD.js

@@ -0,0 +1,49 @@
+import fs from "fs";
+import path from "path";
+
+
+export function removeCrud(targetPath, name) {
+  try {
+    const crudPaths = [
+      `src/models/${name}.model.js`,
+      `src/controllers/${name}.controller.js`,
+      `src/routes/${name}.route.js`,
+      `src/services/${name}.service.js`,
+      `src/validations/${name}.validation.js`,
+      "src/middlewares/auth.middleware.js",
+      `src/schemas/${name}.schema.js`
+    ];
+
+    crudPaths.forEach(relPath => {
+      const absPath = path.join(targetPath, relPath);
+
+      if (fs.existsSync(absPath)) {
+        fs.rmSync(absPath, { force: true });
+        console.log(`✔ Removed: ${relPath}`);
+      } // else {
+      //   console.log(`Skipped (not found): ${relPath}`);
+      // }
+    });
+  } catch (err) {
+    console.error("❌ Error while removing CRUD files:", err.message);
+  }
+}
+
+
+export function removeCrudReferences(appJsPath) {
+  let content = fs.readFileSync(appJsPath, "utf8");
+
+  // Remove imports block
+  content = content.replace(
+    /\/\/ ROUTE_IMPORTS_START[\s\S]*?\/\/ ROUTE_IMPORTS_END/,
+    ""
+  );
+
+  // Remove route usage block
+  content = content.replace(
+    /\/\/ ROUTE_USES_START[\s\S]*?\/\/ ROUTE_USES_END/,
+    ""
+  );
+
+  fs.writeFileSync(appJsPath, content, "utf8");
+}

package/src/cli.js

@@ -1,34 +1,74 @@
+#!/usr/bin/env node
 import inquirer from "inquirer";
 import { createProject } from "./actions/createProject.js";
 import templates from "./config/templates.js";
 
 async function main() {
-  console.log("Welcome to NodeNeat CLI!");
+  console.log("\n🚀 Welcome to NodeNeat CLI!\n");
 
-    const { projectName } = await inquirer.prompt([
+  // Step 1: Ask for project name
+  const { projectName } = await inquirer.prompt([
     {
       name: "projectName",
       type: "input",
       message: "Enter your project folder name:",
-      default: "my-app"
+      default: "my-app",
+      validate: (input) => input.trim() !== "" || "Project name cannot be empty."
     }
   ]);
 
-
+  // Step 2: Choose template
   const { template } = await inquirer.prompt([
     {
       name: "template",
       type: "list",
       message: "Choose a template:",
-      choices: templates.map(t => t.name)
+      choices: templates.map((t) => t.name)
     }
   ]);
 
-  const chosen = templates.find(t => t.name === template);
+  const chosen = templates.find((t) => t.name === template);
+
+  // Step 3: Optional prompt if REST API
+  let includeCrud = false;
+  let crudName = "";
+  if (chosen.name === "Basic Express") {
+    const answer = await inquirer.prompt([
+      {
+        name: "includeCrud",
+        type: "confirm",
+        message: "Include example Todo CRUD setup?",
+        default: true
+      }
+    ]);
+    includeCrud = answer.includeCrud;
+    crudName = "todo";
+  }
+
+  if (chosen.name === "REST API") {
+    const answer = await inquirer.prompt([
+      {
+        name: "includeCrud",
+        type: "confirm",
+        message: "Include example User CRUD setup?",
+        default: true
+      }
+    ]);
+    includeCrud = answer.includeCrud;
+    crudName = "user";
+  }
+
+  // Step 4: Create the project
   await createProject({
     projectName,
-    templatePath: chosen.path
+    templatePath: chosen.path,
+    includeCrud,
+    crudName
   });
+
+  console.log(`\n✅ Project "${projectName}" created successfully using "${chosen.name}" template.\n`);
 }
 
-main();
+main().catch((err) => {
+  console.error("❌ Error:", err.message);
+});

package/src/utils/copyTemplate.js

@@ -1,31 +1,40 @@
 import fs from "fs";
 import path from "path";
 
-export async function copyTemplate(srcDir, destDir) {
-  
-  const ignoreList = ["node_modules", ".git", ".env"];
+export async function copyTemplate(srcDir, destDir, replacements = {}, ) {
+  const ignoreList = ["node_modules", ".git", ".env", "package-lock.json"];
 
-  // make sure destination exists
   if (!fs.existsSync(destDir)) {
     fs.mkdirSync(destDir, { recursive: true });
   }
 
-  // read all files/folders in template
   const items = fs.readdirSync(srcDir, { withFileTypes: true });
 
   for (const item of items) {
-    // skip ignored ones
     if (ignoreList.includes(item.name)) continue;
 
     const srcPath = path.join(srcDir, item.name);
     const destPath = path.join(destDir, item.name);
 
     if (item.isDirectory()) {
-      // recurse for folders
-      await copyTemplate(srcPath, destPath);
+      // recursively copy folders
+      await copyTemplate(srcPath, destPath, replacements);
     } else {
-      // copy individual files
-      fs.copyFileSync(srcPath, destPath);
+      // for certain files, replace placeholders
+      if (["package.json"].includes(item.name)) {
+        let content = fs.readFileSync(srcPath, "utf-8");
+
+        // replace all {{key}} with provided replacements
+        for (const [key, value] of Object.entries(replacements)) {
+          const regex = new RegExp(`project-name`, "g");
+          content = content.replace(regex, value);
+        }
+
+        fs.writeFileSync(destPath, content, "utf-8");
+      } else {
+        // just copy normal files
+        fs.copyFileSync(srcPath, destPath);
+      }
     }
   }
 }

package/templates/express-basic/.env.example

@@ -0,0 +1,3 @@
+PORT=3000
+MONGODB_URI=mongodb://localhost:27017/mydatabase
+CLIENT_URL=http://localhost:5137 # Frontend URL