@ifecodes/backend-template 1.1.7 → 1.1.9

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 FORTUNE IFELOJU ALADETAN
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -346,20 +346,38 @@ npm link
 
 ## 📄 License
 
-MIT
+Apache License 2.0
+
+Copyright © 2026 Aladetan Fortune Ifeloju (IfeCodes)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this project except in compliance with the License.
+You may obtain a copy of the License at:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 ---
 
 ## ✨ Author
 
 **Aladetan Fortune Ifeloju (IfeCodes)**  
-Full Stack Developer & TechPreneur
+Full-Stack Developer & TechPreneur  
 
-- GitHub: [@ALADETAN-IFE](https://github.com/ALADETAN-IFE)
-- Twitter: [@IfeCodes](https://twitter.com/IfeCodes_)
+- GitHub: [@ALADETAN-IFE](https://github.com/ALADETAN-IFE)  
+- Portfolio: [IFECODES](https://ifecodes.xyz)
+- Twitter/X: [@IfeCodes](https://twitter.com/IfeCodes_)
+- LinkedIn: [Aladetan Fortune Ife](https://www.linkedin.com/in/fortune-ife-aladetan-458ab136a?utm_source=share&utm_campaign=share_via&utm_content=profile&utm_medium=android_app)
 
 ---
 
 ## 🙏 Acknowledgments
 
 Built with ❤️ for the developer community to accelerate backend development.
+
+Special thanks to contributors and organizations who adopt, extend, and support this project while respecting its license and attribution.

package/bin/cli.js

@@ -5,6 +5,7 @@ import { execSync } from "child_process";
 import { fileURLToPath } from "url";
 import pc from "picocolors";
 import { getProjectConfig } from "./lib/prompts.js";
+import prompts from "prompts";
 import { setupService } from "./lib/service-setup.js";
 import { generateReadme } from "./lib/readme-generator.js";
 // No TS->JS transform: templates contain language-specific folders (base/js, base/ts)
@@ -35,6 +36,7 @@ const base = baseRoot;
 
 // Determine which services to create
 const servicesToCreate = [];
+const servicesToSetup = [];
 if (isInMicroserviceProject) {
   const newServiceName = config.serviceName.replace(/\s+/g, "-");
   servicesToCreate.push(newServiceName);
@@ -259,13 +261,56 @@ if (isInMicroserviceProject || config.projectType === "microservice") {
   for (const serviceName of servicesToCreate) {
     const serviceRoot = path.join(target, "services", serviceName);
 
-    if (fs.existsSync(serviceRoot)) {
-      console.error(`\n❌ Error: Service '${serviceName}' already exists!`);
-      process.exit(1);
+    // Check for exact or alternate folder conflicts (e.g., 'order' vs 'order-service')
+    const altName = serviceName.endsWith("-service")
+      ? serviceName.replace(/-service$/, "")
+      : `${serviceName}-service`;
+    const altPath = path.join(target, "services", altName);
+    let conflictPath = null;
+    if (fs.existsSync(serviceRoot)) conflictPath = serviceRoot;
+    else if (fs.existsSync(altPath)) conflictPath = altPath;
+
+    if (conflictPath) {
+      const rel = path.relative(target, conflictPath);
+      const resp = await prompts({
+        type: "select",
+        name: "action",
+        message: `Service directory '${rel}' already exists and conflicts with requested '${serviceName}'. Choose action:`,
+        choices: [
+          { title: "Abort generation", value: "abort" },
+          { title: `Skip creating '${serviceName}'`, value: "skip" },
+          {
+            title: `Overwrite '${rel}' with '${serviceName}'`,
+            value: "overwrite",
+          },
+        ],
+        initial: 0,
+      });
+
+      if (!resp.action || resp.action === "abort") {
+        console.log(pc.red("Aborting."));
+        process.exit(1);
+      }
+      if (resp.action === "skip") {
+        console.log(pc.yellow(`Skipping ${serviceName}`));
+        continue;
+      }
+      if (resp.action === "overwrite") {
+        try {
+          fs.rmSync(conflictPath, { recursive: true, force: true });
+        } catch (e) {
+          console.error(
+            pc.red(`Failed to remove existing path: ${conflictPath}`),
+          );
+          process.exit(1);
+        }
+      }
     }
 
     console.log(`\n🔨 Setting up ${serviceName}...`);
     fs.cpSync(base, serviceRoot, { recursive: true });
+    // track which services we actually created/overwrote so we can run setupService for them
+    servicesToSetup.push(serviceName);
 
     // Remove .env and .env.example from microservices (environment variables come from docker-compose/pm2)
     const envPath = path.join(serviceRoot, ".env");
@@ -294,14 +339,14 @@ if (isInMicroserviceProject || config.projectType === "microservice") {
   // Include services we're about to create so port computation and gateway routing
   // are aware of newly added services when setting up files.
   const allServices = Array.from(
-    new Set([...existingServices, ...servicesToCreate]),
+    new Set([...existingServices, ...servicesToSetup]),
   );
 
   // Step 1: Setup all service files first (without installing dependencies)
   console.log(pc.cyan("\n⚙️  Setting up service files...\n"));
   const serviceConfigs = [];
 
-  for (const serviceName of servicesToCreate) {
+  for (const serviceName of servicesToSetup) {
     const serviceRoot = path.join(target, "services", serviceName);
     const shouldIncludeAuth = isInMicroserviceProject
       ? config.auth
@@ -347,7 +392,9 @@ if (isInMicroserviceProject || config.projectType === "microservice") {
       fs.mkdirSync(rootHuskyDir, { recursive: true });
     const preCommitPath = path.join(rootHuskyDir, "pre-commit");
     const preCommitContent =
-      'set -e\n\necho "Checking format (prettier)..."\nnpm run check-format\n\necho "Running TypeScript type-check..."\nnpx tsc --noEmit\n\necho "Checking lint..."\nnpm run lint -- --max-warnings=0\n';
+      config.language === "typescript"
+        ? 'set -e\n\necho "Checking format (prettier)..."\nnpm run check-format\n\necho "Running TypeScript type-check..."\nnpx tsc --noEmit\n\necho "Checking lint..."\nnpm run lint -- --max-warnings=0\n'
+        : 'set -e\n\necho "Checking format (prettier)..."\nnpm run check-format\n\necho "Checking lint..."\nnpm run lint -- --max-warnings=0\n';
     fs.writeFileSync(preCommitPath, preCommitContent);
   } catch (err) {
     // Non-fatal; continue setup even if husky files couldn't be created/removed
@@ -356,8 +403,8 @@ if (isInMicroserviceProject || config.projectType === "microservice") {
   // Step 2: Generate docker-compose/pm2 config and root files
   if (mode === "docker") {
     generateDockerCompose(target, allServices, config.sanitizedName);
-    copyDockerfile(target, servicesToCreate);
-    copyDockerignore(target, servicesToCreate);
+    copyDockerfile(target, servicesToSetup);
+    copyDockerignore(target, servicesToSetup);
   } else {
     generatePm2Config(target, allServices);
   }
@@ -571,24 +618,28 @@ if (isInMicroserviceProject || config.projectType === "microservice") {
 
         // Attempt several fallback strategies to inject port variables:
         // 1. Replace explicit placeholder if present in template
-        // 2. Insert right after the first object opening brace
-        // 3. Append to the end as a last resort
+        // 2. Insert right after the first object opening brace (or replace placeholder)
         if (envContent.includes("/*__PORTS__*/")) {
-          envContent = envContent.replace("/*__PORTS__*/", portEnvVars);
+          envContent = envContent.replace(
+            "/*__PORTS__*/",
+            "/*__PORTS__*/\n" + portEnvVars,
+          );
         } else {
           // Fallback: find the opening brace of the exported ENV object and insert after it
           const braceIndex = envContent.indexOf("{");
           if (braceIndex !== -1) {
             const insertPos =
               envContent.indexOf("\n", braceIndex) + 1 || braceIndex + 1;
+            // insert a stable placeholder comment followed by the ports block
             envContent =
               envContent.slice(0, insertPos) +
+              "  /*__PORTS__*/\n" +
               portEnvVars +
               "\n" +
               envContent.slice(insertPos);
           } else {
-            // Final fallback: append to the end
-            envContent = envContent + "\n" + portEnvVars;
+            // Final fallback: append a placeholder and the ports to the end
+            envContent = envContent + "\n/*__PORTS__*/\n" + portEnvVars;
           }
         }
 
@@ -620,23 +671,85 @@ if (isInMicroserviceProject || config.projectType === "microservice") {
               )
           : allServices;
 
-        let rootENVContent = `# Environment Configuration\nNODE_ENV=development\n\n`;
-        svcList.forEach((service, index) => {
-          const isGateway = service === "gateway";
-          const port = isGateway
-            ? 4000
-            : 4001 +
-              svcList.filter((s, i) => s !== "gateway" && i < index).length;
-          const envVarName = `${service.toUpperCase().replace(/-/g, "_")}_PORT`;
-          const serviceNamePretty = service
-            .split("-")
-            .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
-            .join(" ");
-          rootENVContent += `# ${serviceNamePretty}\n${envVarName}=${port}\n\n`;
-        });
+        // Update only .env.example: preserve runtime .env (don't overwrite user changes)
+        try {
+          const envExamplePath = path.join(target, ".env.example");
+          const servicesPorts = svcList.map((service, index) => {
+            const isGateway = service === "gateway";
+            const port = isGateway
+              ? 4000
+              : 4001 +
+                svcList.filter((s, i) => s !== "gateway" && i < index).length;
+            const envVarName = `${service.toUpperCase().replace(/-/g, "_")}_PORT`;
+            const serviceNamePretty = service
+              .split("-")
+              .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+              .join(" ");
+            return `# ${serviceNamePretty}\n${envVarName}=${port}\n`;
+          });
+
+          const portsBlock = servicesPorts.join("\n");
+
+          let exampleContent = "";
+          if (fs.existsSync(envExamplePath)) {
+            exampleContent = fs.readFileSync(envExamplePath, "utf8");
+
+            // Remove existing *_PORT lines and any immediate preceding single-line comment
+            const lines = exampleContent.split(/\r?\n/);
+            const filtered = [];
+            for (let i = 0; i < lines.length; i++) {
+              const line = lines[i];
+              const next = lines[i + 1];
+              if (next && /^[A-Z0-9_]+_PORT=/.test(next.trim())) {
+                // skip this line if it's a comment immediately preceding a _PORT assignment
+                i++; // skip next as well
+                continue;
+              }
+              if (/^[A-Z0-9_]+_PORT=/.test(line.trim())) {
+                // skip existing port assignment
+                continue;
+              }
+              filtered.push(line);
+            }
+
+            exampleContent = filtered.join("\n");
+          } else {
+            // create minimal header if example file doesn't exist
+            exampleContent = `# Environment Configuration\nNODE_ENV=development\n\n`;
+          }
+
+          // Ensure NODE_ENV line exists and insert portsBlock after it
+          const nodeEnvRegex = /^NODE_ENV=.*$/m;
+          if (nodeEnvRegex.test(exampleContent)) {
+            exampleContent = exampleContent.replace(
+              nodeEnvRegex,
+              (m) => `${m}\n\n${portsBlock}\n`,
+            );
+          } else {
+            // Prepend header and ports
+            exampleContent =
+              `# Environment Configuration\nNODE_ENV=development\n\n${portsBlock}\n` +
+              exampleContent;
+          }
 
-        fs.writeFileSync(path.join(target, ".env"), rootENVContent);
-        fs.writeFileSync(path.join(target, ".env.example"), rootENVContent);
+          fs.writeFileSync(envExamplePath, exampleContent);
+          // Inform the user about the new ports and remind them to update their runtime .env if needed
+          try {
+            console.log(
+              pc.cyan("\n🔧 Updated .env.example with service port entries:\n"),
+            );
+            console.log(pc.green(portsBlock));
+            console.log(
+              pc.dim(
+                "If you keep a runtime .env with custom overrides, do NOT overwrite it.\nPlease copy any new *_PORT entries from .env.example into .env as appropriate.",
+              ),
+            );
+          } catch (e) {
+            // non-fatal if logging fails
+          }
+        } catch (e) {
+          // non-fatal
+        }
       } catch (e) {
         // non-fatal
       }
@@ -684,6 +797,17 @@ if (isInMicroserviceProject || config.projectType === "microservice") {
 } else {
   const result = await setupService(config, null, target, true);
   config.installSucceeded = result.installSucceeded;
+
+  // Safety net: ensure eslint.config.js exists in generated monolith projects
+  const templateEslintConfig = path.join(base, "eslint.config.js");
+  const generatedEslintConfig = path.join(target, "eslint.config.js");
+  if (
+    config.projectType === "monolith" &&
+    fs.existsSync(templateEslintConfig) &&
+    !fs.existsSync(generatedEslintConfig)
+  ) {
+    fs.copyFileSync(templateEslintConfig, generatedEslintConfig);
+  }
 }
 
 // Generate README.md for monolith (microservices already done above)
@@ -781,16 +905,16 @@ if (isInMicroserviceProject) {
 }
 
 if (isInMicroserviceProject) {
-  console.log(
-    `\n${pc.green("✅ Service")} ${pc.bold(servicesToCreate[0])} ${pc.green("added successfully!")}`,
-  );
+  if (servicesToSetup.length > 0) {
+    console.log(
+      `\n${pc.green("✅ Service")} ${pc.bold(servicesToSetup[0])} ${pc.green("added successfully!")}`,
+    );
+  } else {
+    console.log(pc.yellow("\n⚠️  No new service was created (skipped by your selection)."));
+  }
   console.log(`\n${pc.cyan("📦 All services:")} ${allServices.join(", ")}`);
   console.log(`\n${pc.blue("💡 Next steps:")}`);
-  console.log(
-    mode === "docker"
-      ? `   ${pc.dim("1.")} Start services: ${pc.bold("npm run dev")}`
-      : `   ${pc.dim("1.")} Start services: ${pc.bold("pm2 start pm2.config.js")}`,
-  );
+  console.log(`   ${pc.dim("1.")} Start services: ${pc.bold("npm run dev")}`);
 } else if (config.projectType === "microservice") {
   console.log(`\n${pc.green("✅ Microservice Backend created successfully!")}`);
   console.log(
@@ -798,11 +922,7 @@ if (isInMicroserviceProject) {
   );
   console.log(`\n${pc.blue("💡 Next steps:")}`);
   console.log(`   ${pc.dim("1.")} cd ${pc.bold(sanitizedName)}`);
-  console.log(
-    mode === "docker"
-      ? `   ${pc.dim("2.")} Start services: ${pc.bold("npm run dev")}`
-      : `   ${pc.dim("2.")} Start services: ${pc.bold("pm2 start pm2.config.js")}`,
-  );
+  console.log(`   ${pc.dim("2.")} Start services: ${pc.bold("npm run dev")}`);
 } else {
   console.log(`\n${pc.green("✅ Monolith Backend created successfully!")}`);
   console.log(`\n${pc.blue("💡 Next steps:")}`);