@ifecodes/backend-template 1.1.5 → 1.1.6

package/bin/lib/microservice-config.js

@@ -4,7 +4,7 @@ import { fileURLToPath } from "url";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-export const generateDockerCompose = (target, allServices) => {
+export const generateDockerCompose = (target, allServices, projectname) => {
   const dockerCompose = {
     services: {},
   };
@@ -35,7 +35,7 @@ export const generateDockerCompose = (target, allServices) => {
         dockerfile: "Dockerfile"
       },
       image: `${serviceName}:latest`,
-      container_name: serviceName,
+      container_name: projectname + "_" + serviceName,
       ports: [
         `\${${envVarName}:-${port}}:\${${envVarName}:-${port}}`,
       ],
@@ -67,6 +67,16 @@ export const generateDockerCompose = (target, allServices) => {
             config.volumes.map((v) => `      - ${v}`).join("\n")
         )
         .join("\n")
+      +
+      "\n\n" +
+      // Add x-watch section to help file watchers map service src and shared folders
+      `x-watch:\n` +
+      allServices
+        .map(
+          (name) =>
+            `  ${name}:\n    - ./services/${name}/src\n    - ./shared`
+        )
+        .join("\n")
   );
 };
 

package/bin/lib/prompts.js

@@ -215,6 +215,11 @@ export const getProjectConfig = async () => {
     mode = res.mode;
   }
 
+  // If adding to an existing microservice project, normalize the provided service name
+  if (isInMicroserviceProject && res.serviceName) {
+    res.serviceName = normalizeServiceName(res.serviceName);
+  }
+
   return {
     ...res,
     sanitizedName,
@@ -224,3 +229,13 @@ export const getProjectConfig = async () => {
     isInMicroserviceProject,
   };
 };
+
+// Normalize serviceName for existing microservice projects: ensure it ends with '-service'
+// and is kebab-cased/lowercase for consistency.
+function normalizeServiceName(name) {
+  if (!name) return name;
+  let svc = String(name).trim().toLowerCase();
+  svc = svc.replace(/\s+/g, "-").replace(/[^a-z0-9\-]/g, "");
+  if (!svc.endsWith("-service")) svc = `${svc}-service`;
+  return svc;
+}

package/bin/lib/readme-generator.js

@@ -3,7 +3,6 @@ import path from "path";
 
 export const generateReadme = (config, serviceName = null) => {
   const { projectType, mode, features = [], auth, sanitizedName } = config;
-  const isMonolith = projectType === "monolith";
   const isMicroservice = projectType === "microservice";
   
   let readme = `# ${serviceName || sanitizedName}\n\n`;
@@ -24,9 +23,20 @@ export const generateReadme = (config, serviceName = null) => {
     readme += `- **Deployment**: ${mode === "docker" ? "Docker" : "PM2"}\n`;
     readme += `- **Gateway**: Port 4000 (main entry point)\n`;
     readme += `- **Services**:\n`;
-    readme += `  - Gateway (port 4000)\n`;
-    readme += `  - Health Service (port 4001)\n`;
-    if (auth) readme += `  - Auth Service (port 4002)\n`;
+    const servicesList = (config.allServices && config.allServices.length)
+      ? config.allServices
+      : ["gateway", "health-service", ...(auth ? ["auth-service"] : [])];
+    servicesList.forEach((service, idx) => {
+      const isGateway = service === "gateway";
+      const port = isGateway
+        ? 4000
+        : 4001 + servicesList.filter((s) => s !== "gateway" && servicesList.indexOf(s) < idx).length;
+      const pretty = service
+        .split("-")
+        .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
+        .join(" ");
+      readme += `  - ${pretty} (port ${port})\n`;
+    });
     readme += `\n`;
   } else {
     readme += `- **Type**: Monolith API\n`;
@@ -108,11 +118,11 @@ export const generateReadme = (config, serviceName = null) => {
     readme += `### With Docker\n\n`;
     readme += `\`\`\`bash\n`;
     readme += `# Start all services\n`;
-    readme += `docker-compose up\n\n`;
+    readme += `npm run dev\n\n`;
     readme += `# Start in detached mode\n`;
-    readme += `docker-compose up -d\n\n`;
+    readme += `npm run dev -d\n\n`;
     readme += `# Stop all services\n`;
-    readme += `docker-compose down\n`;
+    readme += `npm stop\n`;
     readme += `\`\`\`\n\n`;
   } else if (isMicroservice && mode === "nodocker") {
     readme += `### With PM2\n\n`;
@@ -159,9 +169,18 @@ export const generateReadme = (config, serviceName = null) => {
     }
     
     readme += `### Direct Service Access (Development Only)\n`;
-    readme += `- **Gateway**: \`http://localhost:4000\`\n`;
-    readme += `- **Health Service**: \`http://localhost:4001/api/v1/health\`\n\n`;
-    if (auth) readme  += `- **Auth Service**: \`http://localhost:4002/api/v1/auth\`\n\n`;
+    const directServices = (config.allServices && config.allServices.length)
+      ? config.allServices
+      : ["gateway", "health-service", ...(auth ? ["auth-service"] : [])];
+    directServices.forEach((service) => {
+      const isGateway = service === "gateway";
+      const port = isGateway
+        ? 4000
+        : 4001 + directServices.filter((s) => s !== "gateway" && directServices.indexOf(s) < directServices.indexOf(service)).length;
+      const basePath = isGateway ? `` : `/api/v1`;
+      readme += `- **${service}**: \`http://localhost:${port}${basePath}\`\n`;
+    });
+    readme += `\n`;
 
     readme += "### Example Requests\n";
     readme += "```bash\n";
@@ -169,28 +188,28 @@ export const generateReadme = (config, serviceName = null) => {
     readme += "curl http://localhost:4000/\n\n";
     readme += "# Gateway health\n";
     readme += "curl http://localhost:4000/health\n\n";
-    readme += "# Health service (through gateway)\n";
-    readme += "curl http://localhost:4000/api/v1/health\n\n";
-    readme += "# Health service (direct access)\n";
-    readme += "curl http://localhost:4001/api/v1/health\n";
-    if (auth) {
-      readme += "\n# Register user (through gateway)\n";
-      readme += `curl -X POST http://localhost:4000/api/v1/auth/register \\\n`;
-      readme += `  -H "Content-Type: application/json" \\\n`;
-      readme += `  -d '{"username":"testuser","password":"password123"}'\n\n`;
-      readme += "# Login user (through gateway)\n";
-      readme += `curl -X POST http://localhost:4000/api/v1/auth/login \\\n`;
-      readme += `  -H "Content-Type: application/json" \\\n`;
-      readme += `  -d '{"username":"testuser","password":"password123"}'\n\n`;
-      readme += "# Register user (direct access)\n";
-      readme += `curl -X POST http://localhost:4002/api/v1/auth/register \\\n`;
-      readme += `  -H "Content-Type: application/json" \\\n`;
-      readme += `  -d '{"username":"testuser","password":"password123"}'\n\n`;
-      readme += "# Login user (direct access)\n";
-      readme += `curl -X POST http://localhost:4002/api/v1/auth/login \\\n`;
-      readme += `  -H "Content-Type: application/json" \\\n`;
-      readme += `  -d '{"username":"testuser","password":"password123"}'\n`;
+
+    // Direct access examples for non-gateway services
+    const exampleServices = (config.allServices && config.allServices.length)
+      ? config.allServices
+      : ["gateway", "health-service", ...(auth ? ["auth-service"] : [])];
+    exampleServices.forEach((service) => {
+      if (service === "gateway") return; // gateway already covered
+      const port = service === "gateway" ? 4000 : 4001 + exampleServices.filter((s) => s !== "gateway" && exampleServices.indexOf(s) < exampleServices.indexOf(service)).length;
+      readme += `# ${service} (direct access)\n`;
+      readme += `curl http://localhost:${port}/api/v1/health\n\n`;
+    });
+
+    if (auth && exampleServices.includes("auth-service")) {
+      const authPort = 4001 + exampleServices.filter((s) => s !== "gateway" && exampleServices.indexOf(s) < exampleServices.indexOf("auth-service")).length;
+      readme += "# Auth requests (through gateway)\n";
+      readme += `curl -X POST http://localhost:4000/api/v1/auth/register \\\n+  -H "Content-Type: application/json" \\\n+  -d '{"username":"testuser","password":"password123"}'\n\n`;
+      readme += `curl -X POST http://localhost:4000/api/v1/auth/login \\\n+  -H "Content-Type: application/json" \\\n+  -d '{"username":"testuser","password":"password123"}'\n\n`;
+      readme += `# Auth requests (direct access)\n`;
+      readme += `curl -X POST http://localhost:${authPort}/api/v1/auth/register \\\n+  -H "Content-Type: application/json" \\\n+  -d '{"username":"testuser","password":"password123"}'\n\n`;
+      readme += `curl -X POST http://localhost:${authPort}/api/v1/auth/login \\\n+  -H "Content-Type: application/json" \\\n+  -d '{"username":"testuser","password":"password123"}'\n\n`;
     }
+
     readme += "```\n\n";
     
   } else {
@@ -234,10 +253,12 @@ export const generateReadme = (config, serviceName = null) => {
     readme += `│   ├── config/         # Database, environment configs\n`;
     readme += `│   └── utils/          # Logger, error handlers\n`;
     readme += `├── services/\n`;
-    readme += `│   ├── gateway/        # API Gateway (port 4000)\n`;
-    readme += `│   ├── health-service/ # Health checks (port 4001)\n`;
-    if (auth) readme += `│   └── auth-service/   # Authentication (port 4002)\n`;
-    else readme += `│   └── ...\n`;
+    const projectServices = (config.allServices && config.allServices.length)
+      ? config.allServices
+      : ["gateway", "health-service", ...(auth ? ["auth-service"] : [])];
+    projectServices.forEach((service) => {
+      readme += `│   ├── ${service}/\n`;
+    });
     readme += `├── ${mode === "docker" ? "docker-compose.yml" : "pm2.config.js"}\n`;
     readme += `├── .husky/             # Git hooks\n`;
     readme += `└── package.json        # Root package.json\n`;
@@ -265,8 +286,8 @@ export const generateReadme = (config, serviceName = null) => {
   readme += `## Available Scripts\n\n`;
   if (isMicroservice) {
     if (mode === "docker") {
-      readme += `- \`docker-compose up\` - Start all services\n`;
-      readme += `- \`docker-compose down\` - Stop all services\n`;
+      readme += `- \`npm run dev\` - Start all services\n`;
+      readme += `- \`npm stop\` - Stop all services\n`;
       readme += `- \`docker-compose logs -f [service-name]\` - View service logs\n`;
     } else {
       readme += `- \`pm2 start pm2.config.js\` - Start all services\n`;
@@ -298,9 +319,17 @@ export const generateReadme = (config, serviceName = null) => {
   }
   readme += `\n`;
   
+  // Scaffold attribution
+  readme += `\n`;
+  readme += `## About this Scaffold\n\n`;
+  readme += `This project was generated using the @ifecodes/backend-template scaffold. `;
+  readme += `You can recreate or customize this scaffold using the CLI: \n\n`;
+  readme += `- Run without installing (recommended): \`npx ifecodes-template\`\n`;
+  readme += `- Install globally: \`npm i -g @ifecodes/backend-template\` and run \`ifecodes-template\`\n\n`;
+
   // License
   readme += `## License\n\n`;
   readme += `MIT\n`;
-  
+
   return readme;
 };

package/bin/lib/service-setup.js

@@ -36,11 +36,36 @@ export const setupService = async (
   // Detect file extension (ts or js)
   const ext = getFileExtension(serviceRoot);
 
+  // Remove workspace-level config files from service (they should live at root)
+  try {
+    const serviceConfigFiles = [
+      ".prettierrc",
+      ".prettierignore",
+      ".eslintrc.json",
+      "eslint.config.js",
+      "husky",
+    ];
+    for (const f of serviceConfigFiles) {
+      const p = path.join(serviceRoot, f);
+      if (fs.existsSync(p)) {
+        // Remove file or directory
+        const stat = fs.statSync(p);
+        if (stat.isDirectory()) fs.rmSync(p, { recursive: true, force: true });
+        else fs.rmSync(p, { force: true });
+      }
+    }
+  } catch (err) {
+    // Non-fatal
+  }
+
   // Ensure service-level gitignore is renamed immediately after template copy
   try {
     const serviceGitignore = path.join(serviceRoot, "gitignore");
     const serviceDotGitignore = path.join(serviceRoot, ".gitignore");
-    if (fs.existsSync(serviceGitignore) && !fs.existsSync(serviceDotGitignore)) {
+    if (
+      fs.existsSync(serviceGitignore) &&
+      !fs.existsSync(serviceDotGitignore)
+    ) {
       fs.renameSync(serviceGitignore, serviceDotGitignore);
     }
   } catch (err) {
@@ -49,9 +74,11 @@ export const setupService = async (
 
   // Special handling for gateway service
   if (serviceName === "gateway") {
+    const tmplLang = res.language === "javascript" ? "js" : "ts";
     const gatewayModule = await import(
-      `../../template/gateway/${res.language}/inject.js`
+      `../../template/gateway/${tmplLang}/inject.js`
     );
+
     deps.push(...gatewayModule.gatewayDeps);
 
     // Copy gateway-specific files
@@ -63,7 +90,7 @@ export const setupService = async (
     const templateExt = res.language === "javascript" ? ".js" : ".ts";
     const templateDir = path.join(
       __dirname,
-      `../../template/gateway/${res.language}`,
+      `../../template/gateway/${tmplLang}`,
     );
     const gatewayAppContent = fs.readFileSync(
       path.join(templateDir, `app${templateExt}`),
@@ -86,9 +113,13 @@ export const setupService = async (
     const routesPath = path.join(serviceRoot, `src/routes.${ext}`);
     const modulesPath = path.join(serviceRoot, "src/modules");
     const middlewaresPath = path.join(serviceRoot, "src/middlewares");
+    const configPath = path.join(serviceRoot, `src/config`);
+    const utilPath = path.join(serviceRoot, `src/utils`);
 
     if (fs.existsSync(routesPath)) fs.rmSync(routesPath);
     if (fs.existsSync(modulesPath)) fs.rmSync(modulesPath, { recursive: true });
+    if (fs.existsSync(configPath)) fs.rmSync(configPath, { recursive: true });
+    if (fs.existsSync(utilPath)) fs.rmSync(utilPath, { recursive: true });
     if (fs.existsSync(middlewaresPath))
       fs.rmSync(middlewaresPath, { recursive: true });
   } else {
@@ -279,7 +310,7 @@ export const setupService = async (
         envContent = envContent.replace("/*__ALLOWED_ORIGIN__*/", "");
       }
 
-      // Add MONGO_URI if auth is enabled
+      // Add MONGO_URI and JWT_SECRET if auth is enabled
       if (shouldIncludeAuth && res.auth) {
         const assertion = res.language === "javascript" ? "" : "!";
         envContent = envContent.replace(
@@ -374,7 +405,8 @@ export const setupService = async (
   } // End of else block for non-gateway services
 
   // Update tsconfig.json for microservices to support @/ alias with shared folder
-  if (res.projectType === "microservice") {
+  // Also run when adding a service into an existing microservice project
+  if (res.projectType === "microservice" || res.isInMicroserviceProject) {
     const tsconfigPath = path.join(serviceRoot, "tsconfig.json");
     let tsconfigContent = fs.readFileSync(tsconfigPath, "utf8");
 
@@ -421,17 +453,67 @@ export const setupService = async (
       // Update server.ts to use shared imports
       const serverPath = path.join(serviceRoot, `src/server.${ext}`);
       if (fs.existsSync(serverPath)) {
+        // Determine a single port string for this specific service.
+        // Gateway should use 4000; other services use 4001, 4002, ...
+        let serverPort = "3000";
+        if (Array.isArray(allServices) && allServices.length) {
+          if (serviceName === "gateway") {
+            serverPort = "4000";
+          } else {
+            const idx = allServices.indexOf(serviceName);
+            if (idx !== -1) {
+              // Count non-gateway services before this one to compute offset
+              const nonGatewayBefore = allServices
+                .slice(0, idx)
+                .filter((s) => s !== "gateway").length;
+              serverPort = `${4001 + nonGatewayBefore}`;
+            } else {
+              // Fallback: assign next available port after 4000
+              serverPort = `${4001 + allServices.length - 1}`;
+            }
+          }
+        }
+
         let serverContent = fs.readFileSync(serverPath, "utf8");
+
+        // Normalize imports: accept @/ or relative imports and rewrite to shared imports
         serverContent = serverContent
-          .replace('from "@/utils"', 'from "@/shared/utils"')
-          .replace('from "@/config"', 'from "@/shared/config"');
+          .replace(
+            /from\s+["'](?:@\/utils|\.\/utils|\.\.\/utils)["']/g,
+            'from "@/shared/utils"',
+          )
+          .replace(
+            /from\s+["'](?:@\/config|\.\/config|\.\.\/config)["']/g,
+            'from "@/shared/config"',
+          );
 
-        // Update PORT to use service-specific environment variable
+        // Update PORT to use service-specific environment variable and a correct default port.
         const portEnvVar = `${serviceName.toUpperCase().replace(/-/g, "_")}_PORT`;
-        serverContent = serverContent.replace(
-          /const PORT = ENV\.PORT \|\| (\d+);/,
-          `const PORT = ENV.${portEnvVar} || $1;`,
-        );
+        const portRegex = /const\s+PORT\s*=\s*ENV\.PORT\s*\|\|\s*(\d+)\s*;/;
+        if (portRegex.test(serverContent)) {
+          serverContent = serverContent.replace(
+            portRegex,
+            `const PORT = ENV.${portEnvVar} || ${serverPort};`,
+          );
+        } else {
+          // Fallback: replace a simple numeric default or a bare PORT assignment
+          const simplePortRegex = /const\s+PORT\s*=\s*(\d+)\s*;/;
+          if (simplePortRegex.test(serverContent)) {
+            serverContent = serverContent.replace(
+              simplePortRegex,
+              `const PORT = ENV.${portEnvVar} || ${serverPort};`,
+            );
+          } else {
+            // Last resort: append a PORT assignment near the top after imports
+            const importEnd = serverContent.indexOf("\n\n");
+            const insertPos = importEnd === -1 ? 0 : importEnd + 2;
+            const portLine = `const PORT = ENV.${portEnvVar} || ${serverPort};\n\n`;
+            serverContent =
+              serverContent.slice(0, insertPos) +
+              portLine +
+              serverContent.slice(insertPos);
+          }
+        }
 
         fs.writeFileSync(serverPath, serverContent);
       }
@@ -476,14 +558,6 @@ export const setupService = async (
       .filter(Boolean);
   }
 
-  // Add Node.js native path aliasing for JavaScript projects
-  // This replaces TypeScript's tsconfig paths with Node's native imports field
-  if (res.language === "javascript") {
-    finalPackageJson.imports = {
-      "#/*": "./src/*",
-    };
-  }
-
   // Add --poll flag to dev script for Docker mode (fixes watch mode in Docker on Windows)
   if (res.projectType === "microservice" && res.mode === "docker") {
     if (finalPackageJson.scripts && finalPackageJson.scripts.dev) {
@@ -494,6 +568,55 @@ export const setupService = async (
     }
   }
 
+  // If creating microservices, do not install workspace-level devDependencies per service
+  if (res.projectType === "microservice") {
+    if (finalPackageJson.devDependencies) {
+      const toRemove = [
+        "prettier",
+        "eslint",
+        "eslint-config-prettier",
+        "@typescript-eslint/eslint-plugin",
+        "@typescript-eslint/parser",
+        "husky",
+      ];
+      for (const dep of toRemove) {
+        if (finalPackageJson.devDependencies[dep]) {
+          delete finalPackageJson.devDependencies[dep];
+        }
+      }
+
+      // Remove @types/* from JavaScript services; keep for TypeScript
+      if (res.language === "javascript") {
+        for (const key of Object.keys(finalPackageJson.devDependencies)) {
+          if (key.startsWith("@types/"))
+            delete finalPackageJson.devDependencies[key];
+        }
+      }
+
+      // If devDependencies becomes empty, remove the field
+      if (Object.keys(finalPackageJson.devDependencies).length === 0) {
+        delete finalPackageJson.devDependencies;
+      }
+    }
+  }
+
+  // Remove per-service prepare script (which runs husky) for microservice workspaces
+  if (res.projectType === "microservice" || res.isInMicroserviceProject) {
+    if (finalPackageJson.scripts && finalPackageJson.scripts.prepare) {
+      delete finalPackageJson.scripts.prepare;
+    }
+    // Also remove per-service lint/format/check-format scripts (workspace-level tooling lives at root)
+    if (finalPackageJson.scripts) {
+      delete finalPackageJson.scripts.lint;
+      delete finalPackageJson.scripts.format;
+      delete finalPackageJson.scripts["check-format"];
+      // If scripts becomes empty, remove the field
+      if (Object.keys(finalPackageJson.scripts).length === 0) {
+        delete finalPackageJson.scripts;
+      }
+    }
+  }
+
   fs.writeFileSync(
     packageJsonPath,
     JSON.stringify(finalPackageJson, null, 2) + "\n",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ifecodes/backend-template",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Production-ready Express + TypeScript/JavaScript backend generator with optional features and microservice support",
   "bin": {
     "ifecodes-template": "bin/cli.js"
@@ -20,7 +20,7 @@
   "bugs": {
     "url": "https://github.com/ALADETAN-IFE/backend-template/issues"
   },
-  "homepage": "https://github.com/ALADETAN-IFE/backend-template#readme",
+  "homepage": "https://backend-template-generator.vercel.app",
   "publishConfig": {
     "access": "public"
   },

package/template/base/ts/src/utils/logger.ts

@@ -28,7 +28,7 @@ console.log(
 const requiredKeys = ENV && Object.keys(ENV).length ? Object.keys(ENV) : [];
 
 const missing = requiredKeys.filter(
-  (k) => ENV == null || (ENV as Record<string, undefined>)[k] === undefined || (ENV as Record<string, undefined>)[k] === "",
+  (k) => ENV == null || (ENV as Record<string, string | undefined>)[k] === undefined || (ENV as Record<string, string | undefined>)[k] === "",
 );
 
 if (missing.length === requiredKeys.length) {

package/template/gateway/ts/app.ts

@@ -1,5 +1,6 @@
 import express, { Request, Response, NextFunction } from "express";
 import { createProxyMiddleware } from "http-proxy-middleware";
+import { ENV } from "@/shared/config";
 import { logger } from "@/shared/utils";
 
 const app = express();

package/template/gateway/ts/inject.js

@@ -4,18 +4,19 @@ export const generateGatewayRoutes = (services, mode = "docker") => {
   const routes = services
     .filter((s) => s !== "gateway")
     .map((service, index) => {
+      const servicePort = `${service.toUpperCase().replace(/-/g, "_")}_PORT`;
       const port = 4001 + index; // Host port mapping: gateway=4000, services start at 4001
-      const routePath = service.replace("-service", "");
 
       // Docker: use container name with internal port 4000
       // Non-docker: use localhost with mapped host port
       const host = mode === "docker" ? service : "localhost";
-      const targetPort = mode === "docker" ? 4000 : port;
+      const servicePortEnv = `${servicePort}`
 
       return `
 // Proxy to ${service}
+const ${servicePort} = ENV.${servicePort} || ${port}
 app.use("/api", createProxyMiddleware({
-  target: "http://${host}:${targetPort}/api",
+  target: \`http://${host}:${servicePortEnv}/api\`,
   changeOrigin: true,
   on: {
     error: (err, req, res) => {