kaelum 1.3.3 → 1.3.4

package/README.md

@@ -1,16 +1,22 @@
-# Kaelum
+<div align="center">
+
+<h1>Kaelum</h1>
 
 [![npm version](https://img.shields.io/npm/v/kaelum)](https://www.npmjs.com/package/kaelum)
 [![Build Status](https://github.com/MatheusCampagnolo/kaelum/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/MatheusCampagnolo/kaelum/actions)
 [![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
 [![Docs](https://img.shields.io/badge/docs-online-blue)](https://matheuscampagnolo.github.io/kaelum/)
 
-**Kaelum.JS** — Minimalist Node.js framework to simplify creation of web pages and REST APIs.  
+**Kaelum.js** — Minimalist Node.js framework to simplify creation of web pages and REST APIs.  
 Designed for students and developers who want a fast, opinionated project scaffold and a small, friendly API that encapsulates common Express.js boilerplate.
 
 👉 [**Read the full documentation here**](https://matheuscampagnolo.github.io/kaelum/)
 
----
+**If Kaelum helps you, consider supporting its development:**
+
+<a href='https://ko-fi.com/Z8Z51NK4KT' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi6.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
+
+</div>
 
 ## 🚀 Quick start
 

package/cli/create.js

@@ -3,12 +3,42 @@ const inq = inquirer.default || inquirer;
 const path = require("path");
 const fs = require("fs-extra");
 const { copyTemplate } = require("./utils");
+const { spawn } = require("child_process");
 
 const templatesDir = path.resolve(__dirname, "templates");
 
+/**
+ * runInstall - runs `npm ci` if package-lock exists, otherwise `npm install`
+ * @param {string} cwd - target directory where install runs
+ * @returns {Promise<void>}
+ */
+function runInstall(cwd) {
+  return new Promise((resolve, reject) => {
+    const lockExists = fs.existsSync(path.join(cwd, "package-lock.json"));
+    const cmd = "npm";
+    const args = lockExists ? ["ci"] : ["install"];
+
+    // Spawn child process and inherit stdio so user sees progress
+    const child = spawn(cmd, args, {
+      cwd,
+      stdio: "inherit",
+      shell: process.platform === "win32", // improves compatibility on Windows
+    });
+
+    child.on("error", (err) => {
+      reject(err);
+    });
+
+    child.on("exit", (code) => {
+      if (code === 0) return resolve();
+      reject(new Error(`${cmd} ${args.join(" ")} exited with code ${code}`));
+    });
+  });
+}
+
 /**
  * createProject - create project from template
- * @param {Object} defaults - optional { projectName, template }
+ * @param {Object} defaults - optional { projectName, template, autoInstall }
  */
 async function createProject(defaults = {}) {
   console.log("🚀 Bem-vindo ao Kaelum CLI!");
@@ -47,9 +77,19 @@ async function createProject(defaults = {}) {
         },
         default: defaults.template || "web",
       },
+      {
+        type: "confirm",
+        name: "autoInstall",
+        message:
+          "Deseja que eu execute 'npm install' agora (recomendado)?",
+        default:
+          typeof defaults.autoInstall === "boolean"
+            ? defaults.autoInstall
+            : true,
+      },
     ]);
 
-    const { projectName, template } = answers;
+    const { projectName, template, autoInstall } = answers;
     const targetDir = path.resolve(process.cwd(), projectName);
     const templateDir = path.join(templatesDir, template);
 
@@ -76,10 +116,26 @@ async function createProject(defaults = {}) {
 
     console.log(`\n✅ Projeto "${projectName}" criado com sucesso!`);
     console.log(`➡️  Acesse a pasta: cd ${projectName}`);
-    console.log(`➡️  Inicie o projeto com: npm install && npm start\n`);
+
+    if (autoInstall) {
+      console.log("⬇️  Instalando dependências (npm)... (isso pode levar alguns minutos)");
+      try {
+        await runInstall(targetDir);
+        console.log("\n✅ Dependências instaladas com sucesso!");
+        console.log("➡️  Para iniciar o projeto, execute: npm start\n");
+      } catch (installErr) {
+        console.error(
+          "\n❌ Falha ao instalar dependências automaticamente:",
+          installErr.message || installErr
+        );
+        console.log(`➡️  Tente manualmente: cd ${projectName} && npm install`);
+      }
+    } else {
+      console.log(`➡️  Inicie o projeto com: cd ${projectName} && npm install && npm start\n`);
+    }
   } catch (err) {
     console.error("❌ Erro inesperado:", err.message || err);
   }
 }
 
-module.exports = { createProject };
+module.exports = { createProject };

package/cli/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const { createProject } = require("./create");
 const argv = process.argv.slice(2);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kaelum",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "A minimalist Node.js framework for building web pages and APIs with simplicity and speed.",
   "main": "index.js",
   "exports": {