@batistafull/deploy-server 1.1.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +120 -0
- package/lib/deploy.js +6 -6
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# @batistafull/deploy-server
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Instalación
|
|
6
|
+
|
|
7
|
+
Global:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @batistafull/deploy-server
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
O como dependencia de desarrollo del proyecto:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install --save-dev @batistafull/deploy-server
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Uso
|
|
20
|
+
|
|
21
|
+
Desde la raíz de tu proyecto, crea un archivo `deploy.config.json` (ver formato abajo) y ejecuta:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
deploy-server
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Opciones
|
|
28
|
+
|
|
29
|
+
| Opción | Descripción | Por defecto |
|
|
30
|
+
| ----------------- | ---------------------------------------------- | -------------------- |
|
|
31
|
+
| `--config <path>` | Ruta al archivo de configuración | `deploy.config.json` |
|
|
32
|
+
| `--clean` | Limpia la carpeta de salida antes de desplegar | (desactivado) |
|
|
33
|
+
| `-h, --help` | Muestra la ayuda | |
|
|
34
|
+
|
|
35
|
+
Ejemplos:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# Deploy con la config por defecto
|
|
39
|
+
deploy-server
|
|
40
|
+
|
|
41
|
+
# Limpiar la salida antes de copiar
|
|
42
|
+
deploy-server --clean
|
|
43
|
+
|
|
44
|
+
# Usar otro archivo de config
|
|
45
|
+
deploy-server --config configs/prod.json
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Configuración
|
|
49
|
+
|
|
50
|
+
Crea `deploy.config.json` en la raíz de tu proyecto. **Este archivo lo creas tú**, no viene incluido en el paquete.
|
|
51
|
+
|
|
52
|
+
```json
|
|
53
|
+
{
|
|
54
|
+
"output": "C:/inetpub/app.host",
|
|
55
|
+
"dist": "dist",
|
|
56
|
+
"server": "api",
|
|
57
|
+
"buildCommand": ["npm install", "npm run build"],
|
|
58
|
+
"exclude": ["node_modules", ".git", ".env"],
|
|
59
|
+
"ftp": {
|
|
60
|
+
"enabled": false,
|
|
61
|
+
"host": "ftp.example.com",
|
|
62
|
+
"secure": true,
|
|
63
|
+
"remotePath": "/public_html"
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Campos
|
|
69
|
+
|
|
70
|
+
| Campo | Tipo | Descripción |
|
|
71
|
+
| -------------- | --------------------- | ------------------------------------------------------------- |
|
|
72
|
+
| `output` | `string` | Ruta destino del deploy (ver nota abajo). |
|
|
73
|
+
| `dist` | `string` | Ruta (relativa al proyecto) de la carpeta compilada a copiar. |
|
|
74
|
+
| `server` | `string` | Ruta (relativa al proyecto) de la carpeta del servidor/API. |
|
|
75
|
+
| `buildCommand` | `string` o `string[]` | Comando(s) de build. Si es un array, se ejecutan en orden. |
|
|
76
|
+
| `exclude` | `string[]` | Nombres de archivos o carpetas a excluir al copiar. |
|
|
77
|
+
| `ftp` | `object` | (Opcional) Configuración de subida por FTP/FTPS. Ver abajo. |
|
|
78
|
+
|
|
79
|
+
> **`output`:** si es una ruta **absoluta** se usa tal cual (ej: `C:/inetpub/app.host`);
|
|
80
|
+
> si es **relativa** se resuelve desde la raíz del proyecto (ej: `../deploy/app.host`).
|
|
81
|
+
|
|
82
|
+
### FTP / FTPS
|
|
83
|
+
|
|
84
|
+
La subida por FTP está desactivada salvo que pongas `ftp.enabled: true`.
|
|
85
|
+
|
|
86
|
+
| Campo | Descripción |
|
|
87
|
+
| ---------------- | -------------------------------------------------------------------------- |
|
|
88
|
+
| `ftp.enabled` | `true` para activar la subida. |
|
|
89
|
+
| `ftp.host` | Host del servidor FTP (fallback de `FTP_HOST`). |
|
|
90
|
+
| `ftp.secure` | `true` (por defecto) usa FTPS con TLS. Pon `false` solo si no hay soporte. |
|
|
91
|
+
| `ftp.remotePath` | Carpeta remota destino. |
|
|
92
|
+
|
|
93
|
+
> **Seguridad:** las credenciales se leen preferentemente de variables de entorno.
|
|
94
|
+
> **No pongas la contraseña en el JSON.**
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
# Linux / macOS
|
|
98
|
+
FTP_HOST=ftp.tuservidor.com FTP_USER=usuario FTP_PASSWORD=secreto deploy-server
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
```powershell
|
|
102
|
+
# Windows (PowerShell)
|
|
103
|
+
$env:FTP_HOST="ftp.tuservidor.com"; $env:FTP_USER="usuario"; $env:FTP_PASSWORD="secreto"
|
|
104
|
+
deploy-server
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
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.
|
|
108
|
+
|
|
109
|
+
## Qué hace, paso a paso
|
|
110
|
+
|
|
111
|
+
1. Carga el `deploy.config.json`.
|
|
112
|
+
2. Si se pasa `--clean`, borra la carpeta de salida.
|
|
113
|
+
3. Ejecuta el/los `buildCommand`.
|
|
114
|
+
4. Copia `dist` → `<output>` (aplicando `exclude`).
|
|
115
|
+
5. Copia `server` → `<output>` (aplicando `exclude`).
|
|
116
|
+
6. Si `ftp.enabled`, sube la carpeta de salida por FTP/FTPS.
|
|
117
|
+
|
|
118
|
+
## Licencia
|
|
119
|
+
|
|
120
|
+
MIT
|
package/lib/deploy.js
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
const path = require("path");
|
|
2
|
-
const os = require("os");
|
|
3
2
|
const fs = require("fs-extra");
|
|
4
3
|
const chalk = require("chalk");
|
|
5
4
|
const { execSync } = require("child_process");
|
|
@@ -37,12 +36,13 @@ module.exports = async function deploy(options) {
|
|
|
37
36
|
|
|
38
37
|
const projectRoot = process.cwd();
|
|
39
38
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
: path.join(os.homedir(), "Documents");
|
|
39
|
+
if (!config.output) {
|
|
40
|
+
throw new Error("Falta 'output' en el config: indica la carpeta destino del deploy.");
|
|
41
|
+
}
|
|
44
42
|
|
|
45
|
-
|
|
43
|
+
// 'output' es la ruta destino. Si es absoluta se usa tal cual;
|
|
44
|
+
// si es relativa se resuelve desde la raíz del proyecto.
|
|
45
|
+
const outputPath = path.resolve(projectRoot, config.output);
|
|
46
46
|
|
|
47
47
|
const distPath = path.join(projectRoot, config.dist);
|
|
48
48
|
const serverPath = path.join(projectRoot, config.server);
|