@batistafull/deploy-server 1.0.0 → 2.0.0

package/README.md

@@ -0,0 +1,120 @@
+# @batistafull/deploy-server
+
+Herramienta CLI de despliegue dirigida por configuración. Ejecuta los comandos de build de tu proyecto y copia las carpetas `dist` y `server` a la carpeta destino que indiques, con opción de subir el resultado por FTP/FTPS.
+
+## Instalación
+
+Global:
+
+```bash
+npm install -g @batistafull/deploy-server
+```
+
+O como dependencia de desarrollo del proyecto:
+
+```bash
+npm install --save-dev @batistafull/deploy-server
+```
+
+## Uso
+
+Desde la raíz de tu proyecto, crea un archivo `deploy.config.json` (ver formato abajo) y ejecuta:
+
+```bash
+deploy-server
+```
+
+### Opciones
+
+| Opción            | Descripción                                    | Por defecto          |
+| ----------------- | ---------------------------------------------- | -------------------- |
+| `--config <path>` | Ruta al archivo de configuración               | `deploy.config.json` |
+| `--clean`         | Limpia la carpeta de salida antes de desplegar | (desactivado)        |
+| `-h, --help`      | Muestra la ayuda                               |                      |
+
+Ejemplos:
+
+```bash
+# Deploy con la config por defecto
+deploy-server
+
+# Limpiar la salida antes de copiar
+deploy-server --clean
+
+# Usar otro archivo de config
+deploy-server --config configs/prod.json
+```
+
+## Configuración
+
+Crea `deploy.config.json` en la raíz de tu proyecto. **Este archivo lo creas tú**, no viene incluido en el paquete.
+
+```json
+{
+  "output": "C:/inetpub/app.host",
+  "dist": "dist",
+  "server": "api",
+  "buildCommand": ["npm install", "npm run build"],
+  "exclude": ["node_modules", ".git", ".env"],
+  "ftp": {
+    "enabled": false,
+    "host": "ftp.example.com",
+    "secure": true,
+    "remotePath": "/public_html"
+  }
+}
+```
+
+### Campos
+
+| Campo          | Tipo                  | Descripción                                                   |
+| -------------- | --------------------- | ------------------------------------------------------------- |
+| `output`       | `string`              | Ruta destino del deploy (ver nota abajo).                     |
+| `dist`         | `string`              | Ruta (relativa al proyecto) de la carpeta compilada a copiar. |
+| `server`       | `string`              | Ruta (relativa al proyecto) de la carpeta del servidor/API.   |
+| `buildCommand` | `string` o `string[]` | Comando(s) de build. Si es un array, se ejecutan en orden.    |
+| `exclude`      | `string[]`            | Nombres de archivos o carpetas a excluir al copiar.           |
+| `ftp`          | `object`              | (Opcional) Configuración de subida por FTP/FTPS. Ver abajo.   |
+
+> **`output`:** si es una ruta **absoluta** se usa tal cual (ej: `C:/inetpub/app.host`);
+> si es **relativa** se resuelve desde la raíz del proyecto (ej: `../deploy/app.host`).
+
+### FTP / FTPS
+
+La subida por FTP está desactivada salvo que pongas `ftp.enabled: true`.
+
+| Campo            | Descripción                                                                |
+| ---------------- | -------------------------------------------------------------------------- |
+| `ftp.enabled`    | `true` para activar la subida.                                             |
+| `ftp.host`       | Host del servidor FTP (fallback de `FTP_HOST`).                            |
+| `ftp.secure`     | `true` (por defecto) usa FTPS con TLS. Pon `false` solo si no hay soporte. |
+| `ftp.remotePath` | Carpeta remota destino.                                                    |
+
+> **Seguridad:** las credenciales se leen preferentemente de variables de entorno.
+> **No pongas la contraseña en el JSON.**
+
+```bash
+# Linux / macOS
+FTP_HOST=ftp.tuservidor.com FTP_USER=usuario FTP_PASSWORD=secreto deploy-server
+```
+
+```powershell
+# Windows (PowerShell)
+$env:FTP_HOST="ftp.tuservidor.com"; $env:FTP_USER="usuario"; $env:FTP_PASSWORD="secreto"
+deploy-server
+```
+
+Si el FTP está habilitado y faltan `FTP_HOST`, `FTP_USER` o `FTP_PASSWORD` (y tampoco están en el config), el deploy falla con un error claro.
+
+## Qué hace, paso a paso
+
+1. Carga el `deploy.config.json`.
+2. Si se pasa `--clean`, borra la carpeta de salida.
+3. Ejecuta el/los `buildCommand`.
+4. Copia `dist` → `<output>` (aplicando `exclude`).
+5. Copia `server` → `<output>` (aplicando `exclude`).
+6. Si `ftp.enabled`, sube la carpeta de salida por FTP/FTPS.
+
+## Licencia
+
+MIT

package/bin/deploy-server.js

@@ -1,39 +1,24 @@
 #!/usr/bin/env node
 
-const { execSync } = require("child_process");
-const fs = require("fs");
-const path = require("path");
-const os = require("os");
-
-function run() {
-    const projectRoot = process.cwd(); // 👈 importante: proyecto donde se instala
-
-    const documentsPath =
-        process.platform === "win32"
-            ? path.join(process.env.USERPROFILE, "Documents")
-            : path.join(os.homedir(), "Documents");
-
-    const destination = path.join(documentsPath, "app.host");
-
-    const distPath = path.join(projectRoot, "dist");
-    const apiPath = path.join(projectRoot, "server", "api");
-
-    console.log("📁 Creando carpeta...");
-    fs.mkdirSync(destination, { recursive: true });
-
-    console.log("⚙️ Ejecutando build...");
-    execSync("npm run build", {
-        cwd: projectRoot,
-        stdio: "inherit"
-    });
-
-    console.log("📦 Copiando dist...");
-    fs.cpSync(distPath, destination, { recursive: true });
-
-    console.log("📦 Copiando server/api...");
-    fs.cpSync(apiPath, destination, { recursive: true });
-
-    console.log("✅ Deploy completado en:", destination);
-}
-
-run();
+const { program } = require("commander");
+const chalk = require("chalk");
+const deploy = require("../lib/deploy");
+
+program
+  .name("deploy-server")
+  .description("Config-driven deploy tool")
+  .option("--config <path>", "config file path", "deploy.config.json")
+  .option("--clean", "clean output folder before deploy")
+  .action(async (options) => {
+    console.log(chalk.blue("🚀 Loading deploy config..."));
+
+    try {
+      await deploy(options);
+      console.log(chalk.green("✅ Deploy completed"));
+    } catch (err) {
+      console.error(chalk.red("❌ Deploy failed:"), err);
+      process.exit(1);
+    }
+  });
+
+program.parse();

package/lib/deploy.js

@@ -0,0 +1,108 @@
+const path = require("path");
+const fs = require("fs-extra");
+const chalk = require("chalk");
+const { execSync } = require("child_process");
+const ftp = require("basic-ftp");
+
+// Ejecuta una lista de comandos de build en orden
+function runBuildCommands(commands, cwd) {
+  for (const command of commands) {
+    console.log(chalk.gray(`🔨 $ ${command}`));
+    execSync(command, { cwd, stdio: "inherit" });
+  }
+}
+
+// Copia un directorio excluyendo los patrones indicados (match por nombre o ruta relativa)
+async function copyFiltered(srcPath, destPath, exclude = []) {
+  if (!(await fs.pathExists(srcPath))) {
+    console.log(chalk.yellow(`⚠️  Origen no encontrado, se omite: ${srcPath}`));
+    return;
+  }
+
+  await fs.copy(srcPath, destPath, {
+    filter: (src) => {
+      const relative = path.relative(srcPath, src);
+      if (!relative) return true; // el propio directorio raíz
+      const name = path.basename(src);
+      return !exclude.some(
+        (pattern) => name === pattern || relative.split(path.sep).includes(pattern)
+      );
+    }
+  });
+}
+
+module.exports = async function deploy(options) {
+  const config = require(path.resolve(process.cwd(), options.config));
+
+  const projectRoot = process.cwd();
+
+  if (!config.output) {
+    throw new Error("Falta 'output' en el config: indica la carpeta destino del deploy.");
+  }
+
+  // 'output' es la ruta destino. Si es absoluta se usa tal cual;
+  // si es relativa se resuelve desde la raíz del proyecto.
+  const outputPath = path.resolve(projectRoot, config.output);
+
+  const distPath = path.join(projectRoot, config.dist);
+  const serverPath = path.join(projectRoot, config.server);
+
+  // Clean
+  if (options.clean) {
+    console.log(chalk.gray("🧹 Cleaning output..."));
+    await fs.remove(outputPath);
+  }
+
+  await fs.ensureDir(outputPath);
+
+  // BUILD (ARRAY)
+  if (Array.isArray(config.buildCommand)) {
+    runBuildCommands(config.buildCommand, projectRoot);
+  } else {
+    execSync(config.buildCommand, {
+      cwd: projectRoot,
+      stdio: "inherit"
+    });
+  }
+
+  // COPY DIST
+  console.log(chalk.blue("📦 Copying dist..."));
+  await copyFiltered(distPath, outputPath, config.exclude || []);
+
+  // COPY SERVER
+  console.log(chalk.blue("📦 Copying server..."));
+  await copyFiltered(serverPath, outputPath, config.exclude || []);
+
+  // FTP (opcional)
+  if (config.ftp?.enabled) {
+    const client = new ftp.Client();
+
+    // Las credenciales se leen preferentemente de variables de entorno.
+    // El config solo debe usarse como fallback para valores no sensibles.
+    const host = process.env.FTP_HOST || config.ftp.host;
+    const user = process.env.FTP_USER || config.ftp.user;
+    const password = process.env.FTP_PASSWORD || config.ftp.password;
+    // FTPS por defecto; poner ftp.secure=false en el config solo si el
+    // servidor no soporta TLS (no recomendado).
+    const secure = config.ftp.secure !== false;
+
+    if (!host || !user || !password) {
+      throw new Error(
+        "FTP habilitado pero faltan credenciales. Define FTP_HOST, FTP_USER y FTP_PASSWORD (o config.ftp.*)."
+      );
+    }
+
+    console.log(chalk.yellow(`📡 Connecting FTP (${secure ? "FTPS" : "sin cifrar"})...`));
+
+    try {
+      await client.access({ host, user, password, secure });
+
+      await client.ensureDir(config.ftp.remotePath);
+      await client.uploadFromDir(outputPath);
+
+      console.log(chalk.green("🌐 FTP upload done"));
+    } finally {
+      client.close();
+    }
+  }
+};

package/package.json

@@ -1,13 +1,26 @@
 {
   "name": "@batistafull/deploy-server",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Deploy tool that builds and copies dist + api to Documents/app.host",
   "main": "bin/deploy-server.js",
   "bin": {
     "deploy-server": "bin/deploy-server.js"
   },
+  "files": [
+    "bin/",
+    "lib/"
+  ],
   "keywords": ["deploy", "cli", "nodejs"],
   "author": "batistafull",
   "license": "MIT",
-  "type": "commonjs"
+  "type": "commonjs",
+  "engines": {
+    "node": ">=16"
+  },
+  "dependencies": {
+    "basic-ftp": "^5.0.5",
+    "chalk": "^4.1.2",
+    "commander": "^12.1.0",
+    "fs-extra": "^11.2.0"
+  }
 }