neatnode 3.1.7 → 3.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neatnode",
-  "version": "3.1.7",
+  "version": "3.2.0",
   "description": "Plug & Play Node.js backend starter templates — build REST APIs, socket servers, and more in seconds.",
   "bin": {
     "neatnode": "bin/index.js"
@@ -38,10 +38,20 @@
   "homepage": "https://github.com/aakash-gupta02/NeatNode#readme",
   "license": "ISC",
   "type": "module",
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "node --test"
+  },
   "dependencies": {
     "axios": "^1.13.2",
     "extract-zip": "^2.0.1",
     "fs-extra": "^11.3.2",
     "inquirer": "^12.10.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.0.0",
+    "eslint": "^9.0.0",
+    "globals": "^15.0.0"
   }
-}
+}

package/src/actions/createProject.js

@@ -1,57 +1,57 @@
-import fs from "fs";
-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 { downloadTemplate } from "../utils/downloadRepoTemplate.js";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export async function createProject({ projectName, repoPath, includeCrud, crudName, langKey, isModular }) {
-  try {
-    const targetPath = projectName === "."
-      ? process.cwd()
-      : path.join(process.cwd(), projectName);
-
-    if (fs.existsSync(targetPath) && projectName !== ".") {
-      console.error(`❌ Folder "${projectName}" already exists.`);
-      process.exit(1);
-    }
-
-    if (projectName !== ".") {
-      console.log("Creating project folder...");
-      fs.mkdirSync(targetPath);
-    }
-
-    console.log("Downloading template...");
-    const localTemplatePath = await downloadTemplate(repoPath);
-
-    await copyTemplate(localTemplatePath, targetPath, {
-      "project-name": projectName === "." ? path.basename(process.cwd()) : projectName,
-      "author": os.userInfo().username || "author",
-    });
-
-    if (!includeCrud && crudName) {
-      console.log("🗑 Removing CRUD files...");
-
-      if (isModular) {
-        removeCrudModule(targetPath, crudName);
-        removeCrudReferences(path.join(targetPath, "src", `routes/index.route.${langKey}`));
-
-      }
-
-      removeCrud(targetPath, crudName, langKey);
-      removeCrudReferences(path.join(targetPath, "src", `app.${langKey}`));
-    }
-
-    console.log(`\n✅ Project "${projectName}" created successfully!\n`);
-
-  } catch (err) {
-    console.error("❌ Failed to create project:", err);
-    process.exit(1);
-  }
-}
-
-
+import fs from "fs";
+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 { downloadTemplate } from "../utils/downloadRepoTemplateByVersionTags.js";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export async function createProject({ projectName, repoPath, includeCrud, crudName, langKey, isModular }) {
+  try {
+    const targetPath = projectName === "."
+      ? process.cwd()
+      : path.join(process.cwd(), projectName);
+
+    if (fs.existsSync(targetPath) && projectName !== ".") {
+      console.error(`❌ Folder "${projectName}" already exists.`);
+      process.exit(1);
+    }
+
+    if (projectName !== ".") {
+      console.log("Creating project folder...");
+      fs.mkdirSync(targetPath);
+    }
+
+    console.log("Downloading template...");
+    const localTemplatePath = await downloadTemplate(repoPath);
+
+    await copyTemplate(localTemplatePath, targetPath, {
+      "project-name": projectName === "." ? path.basename(process.cwd()) : projectName,
+      "author": os.userInfo().username || "author",
+    });
+
+    if (!includeCrud && crudName) {
+      console.log("🗑 Removing CRUD files...");
+
+      if (isModular) {
+        removeCrudModule(targetPath, crudName);
+        removeCrudReferences(path.join(targetPath, "src", `routes/index.route.${langKey}`));
+
+      }
+
+      removeCrud(targetPath, crudName, langKey);
+      removeCrudReferences(path.join(targetPath, "src", `app.${langKey}`));
+    }
+
+    console.log(`\n✅ Project "${projectName}" created successfully!\n`);
+
+  } catch (err) {
+    console.error("❌ Failed to create project:", err);
+    process.exit(1);
+  }
+}
+
+

package/src/actions/removeCRUD.js

@@ -1,62 +1,65 @@
-import fs from "fs";
-import path from "path";
-
-
-export function removeCrud(targetPath, name, langKey) {
-  try {
-    const crudPaths = [
-      `src/models/${name}.model.${langKey}`,
-      `src/controllers/${name}.controller.${langKey}`,
-      `src/routes/${name}.route.${langKey}`,
-      `src/services/${name}.service.${langKey}`,
-      `src/validations/${name}.validation.${langKey}`,
-      `src/middlewares/auth.middleware.${langKey}`,
-      `src/schemas/${name}.schema.${langKey}`
-    ];
-
-    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");
-}
-
-export function removeCrudModule(targetPath, name) {
-  try {
-    const modulePath = path.join(targetPath, `src/modules/${name}`);
-    if (fs.existsSync(modulePath)) {
-      fs.rmSync(modulePath, { recursive: true, force: true });
-      console.log(`✔ Removed module: ${name}`);
-    } else {
-      console.log(`Skipped module (not found): ${name}`);
-    }
-  } catch (err) {
-    console.error("❌ Error while removing CRUD module:", err.message);
-  }
-}
+import fs from "fs";
+import path from "path";
+
+export function removeCrud(targetPath, name, langKey) {
+  try {
+    const crudPaths = [
+      `src/models/${name}.model.${langKey}`,
+      `src/controllers/${name}.controller.${langKey}`,
+      `src/routes/${name}.route.${langKey}`,
+      `src/services/${name}.service.${langKey}`,
+      `src/validations/${name}.validation.${langKey}`,
+      `src/middlewares/auth.middleware.${langKey}`,
+      `src/schemas/${name}.schema.${langKey}`,
+    ];
+
+    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) {
+  if (!fs.existsSync(appJsPath)) {
+    return false;
+  }
+  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");
+  return true;
+}
+
+export function removeCrudModule(targetPath, name) {
+  try {
+    const modulePath = path.join(targetPath, `src/modules/${name}`);
+    if (fs.existsSync(modulePath)) {
+      fs.rmSync(modulePath, { recursive: true, force: true });
+      console.log(`✔ Removed module: ${name}`);
+    } else {
+      console.log(`Skipped module (not found): ${name}`);
+    }
+  } catch (err) {
+    console.error("❌ Error while removing CRUD module:", err.message);
+  }
+}

package/src/utils/copyTemplate.js

@@ -1,40 +1,48 @@
-import fs from "fs";
-import path from "path";
-
-export async function copyTemplate(srcDir, destDir, replacements = {}, ) {
-  const ignoreList = ["node_modules", ".git", ".env", "package-lock.json", ".npmignore", "logs"];
-
-  if (!fs.existsSync(destDir)) {
-    fs.mkdirSync(destDir, { recursive: true });
-  }
-
-  const items = fs.readdirSync(srcDir, { withFileTypes: true });
-
-  for (const item of items) {
-    if (ignoreList.includes(item.name)) continue;
-
-    const srcPath = path.join(srcDir, item.name);
-    const destPath = path.join(destDir, item.name);
-
-    if (item.isDirectory()) {
-      // recursively copy folders
-      await copyTemplate(srcPath, destPath, replacements);
-    } else {
-      // 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);
-      }
-    }
-  }
-}
+import fs from "fs";
+import path from "path";
+
+export async function copyTemplate(srcDir, destDir, replacements = {}) {
+  const ignoreList = [
+    "node_modules",
+    ".git",
+    ".env",
+    "package-lock.json",
+    ".npmignore",
+    "logs",
+  ];
+
+  if (!fs.existsSync(destDir)) {
+    fs.mkdirSync(destDir, { recursive: true });
+  }
+
+  const items = fs.readdirSync(srcDir, { withFileTypes: true });
+
+  for (const item of items) {
+    if (ignoreList.includes(item.name)) continue;
+
+    const srcPath = path.join(srcDir, item.name);
+    const destPath = path.join(destDir, item.name);
+
+    if (item.isDirectory()) {
+      // recursively copy folders
+      await copyTemplate(srcPath, destPath, replacements);
+    } else {
+      // for certain files, replace placeholders
+      if (["package.json"].includes(item.name)) {
+        let content = fs.readFileSync(srcPath, "utf-8");
+
+        // Replace all configured {{key}} placeholders with their values.
+        for (const [key, value] of Object.entries(replacements)) {
+          const escapedKey = key.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+          const regex = new RegExp(`\\{\\{\\s*${escapedKey}\\s*\\}\\}`, "g");
+          content = content.replace(regex, String(value));
+        }
+
+        fs.writeFileSync(destPath, content, "utf-8");
+      } else {
+        // just copy normal files
+        fs.copyFileSync(srcPath, destPath);
+      }
+    }
+  }
+}

package/src/utils/downloadRepoTemplate.js

@@ -1,45 +1,51 @@
-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);
-
-  // copy template
-  fs.mkdirSync(tempFinalDir, { recursive: true });
-  fs.cpSync(srcTemplatePath, tempFinalDir, { recursive: true });
-
-  console.log("✔ Template downloaded & extracted");
-
-  return tempFinalDir;
-}
+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;
+}

package/src/utils/downloadRepoTemplateByVersionTags.js

@@ -0,0 +1,130 @@
+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 getPackageVersion = () => {
+  try {
+    const pkgPath = path.resolve(__dirname, "../../package.json");
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+    return pkg.version;
+  } catch {
+    return null;
+  }
+};
+
+const getTemplateRef = () => {
+  if (process.env.NEATNODE_TEMPLATE_REF) {
+    return process.env.NEATNODE_TEMPLATE_REF;
+  }
+
+  const version = getPackageVersion();
+
+  if (!version) {
+    return "main";
+  }
+
+  return `v${version}`;
+};
+
+const getZipUrl = (ref, refType = "tag") => {
+  if (refType === "branch") {
+    return `https://codeload.github.com/${owner}/${repo}/zip/refs/heads/${ref}`;
+  }
+  return `https://codeload.github.com/${owner}/${repo}/zip/refs/tags/${ref}`;
+};
+
+const downloadFromRef = async ({ repoPath, ref, refType }) => {
+  const zipUrl = getZipUrl(ref, refType);
+
+  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");
+
+  const response = await axios({
+    url: zipUrl,
+    responseType: "arraybuffer",
+  });
+
+  fs.writeFileSync(tempZip, response.data);
+  await extract(tempZip, { dir: tempExtractDir });
+
+  const extractedRootDir = fs
+    .readdirSync(tempExtractDir, { withFileTypes: true })
+    .find((entry) => entry.isDirectory());
+
+  if (!extractedRootDir) {
+    throw new Error(
+      `Could not locate extracted template root directory for ${refType} "${ref}".`,
+    );
+  }
+
+  const extractedRoot = path.join(tempExtractDir, extractedRootDir.name);
+  const srcTemplatePath = path.join(extractedRoot, repoPath);
+
+  if (!fs.existsSync(srcTemplatePath)) {
+    throw new Error(
+      `Template path "${repoPath}" not found in ${refType} "${ref}" archive.`,
+    );
+  }
+
+  fs.mkdirSync(tempFinalDir, { recursive: true });
+  fs.cpSync(srcTemplatePath, tempFinalDir, { recursive: true });
+  return tempFinalDir;
+};
+
+export async function downloadTemplate(repoPath) {
+  const packageRoot = path.resolve(__dirname, "../..");
+  const packagedTemplatePath = path.join(packageRoot, repoPath);
+
+  if (fs.existsSync(packagedTemplatePath)) {
+    return packagedTemplatePath;
+  }
+
+  const preferredRef = getTemplateRef();
+  const candidates = [
+    { ref: preferredRef, refType: "tag" },
+    { ref: "main", refType: "branch" },
+  ];
+
+  const uniqueCandidates = candidates.filter(
+    (candidate, index, arr) =>
+      arr.findIndex(
+        (item) =>
+          item.ref === candidate.ref && item.refType === candidate.refType,
+      ) === index,
+  );
+
+  const errors = [];
+
+  for (const candidate of uniqueCandidates) {
+    try {
+      const templatePath = await downloadFromRef({
+        repoPath,
+        ref: candidate.ref,
+        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);
+      errors.push(`${candidate.refType}:${candidate.ref} -> ${message}`);
+    }
+  }
+
+  throw new Error(
+    `Failed to download template from all sources. ${errors.join(" | ")}`,
+  );
+}