d3ployer 0.0.6 → 0.0.8

package/README.md

@@ -125,6 +125,16 @@ Set to `false` to disable the built-in PM2 task. When enabled (default), the `pm
 
 Set to `false` to disable the built-in Docker Compose task. When enabled (default), the `docker:setup` task auto-detects compose files and runs `docker compose up -d --build`.
 
+### `logs`
+
+Configure post-deploy log streaming. The `stream:logs` task will stream PM2 or Docker Compose logs for the configured duration. Set to `false` to disable.
+
+```ts
+logs: {
+  time: 5, // seconds to stream logs (default: 3)
+}
+```
+
 ### `tasks`
 
 Custom task functions receive a `TaskContext` and `Placeholders`:
@@ -204,10 +214,11 @@ scenarios: {
 | `docker:setup`     | Run docker compose up (auto-detects compose files)       |
 | `clear:target`     | Remove the entire deploy path (with confirmation prompt) |
 | `print:deployment` | Print deployment info (date, files, disk usage)          |
+| `stream:logs`      | Stream PM2/Docker Compose logs for a few seconds         |
 
 ### Default `deploy` scenario
 
-The built-in `deploy` scenario runs: `upload` → `symlinks` → `dep:install` → `pm2:setup` → `docker:setup` → `print:deployment`
+The built-in `deploy` scenario runs: `upload` → `symlinks` → `dep:install` → `pm2:setup` → `docker:setup` → `print:deployment` → `stream:logs`
 
 Tasks with skip conditions will be automatically skipped when not applicable (e.g. `pm2:setup` skips if no PM2 config file exists).
 

package/dist/def.d.ts

@@ -27,6 +27,9 @@ export interface SymlinkConfig {
     path: string;
     target: string;
 }
+export interface LogsConfig {
+    time?: number;
+}
 export interface Placeholders {
     serverName: string;
     deployPath: string;
@@ -84,6 +87,7 @@ export interface DeployerConfig {
     packageManager?: PackageManagerConfig | false;
     pm2?: boolean;
     dockerCompose?: boolean;
+    logs?: LogsConfig | false;
     tasks?: Record<string, TaskDef>;
     scenarios?: Record<string, ScenarioDef>;
 }

package/dist/defaultTasks.js

@@ -21,14 +21,14 @@ export function buildRsyncCommand(server, source, dest, files, options = {}) {
     // include/exclude
     if (files.exclude) {
         for (const pattern of files.exclude) {
-            args.push(`--exclude=${pattern}`);
+            args.push(`--exclude="${pattern}"`);
         }
     }
     if (files.include) {
         for (const pattern of files.include) {
-            args.push(`--include=${pattern}`);
+            args.push(`--include="${pattern}"`);
         }
-        args.push('--exclude=*');
+        args.push('--exclude="*"');
     }
     args.push(source, dest);
     return args.join(' ');
@@ -62,6 +62,9 @@ export const downloadSkip = (ctx) => {
 };
 export const downloadTask = async (ctx, ph) => {
     const files = ctx.taskConfig;
+    if (!files) {
+        throw new Exception('No files configuration provided in task config', 1784523741234);
+    }
     const localBase = files.basePath?.startsWith('/')
         ? files.basePath
         : path.resolve(ctx.config.rootDir, files.basePath ?? '.');
@@ -174,6 +177,39 @@ const printDeploymentTask = async (ctx, ph) => {
     console.log(chalk.cyan('Directory size'));
     await ctx.run('du -hd 1 .');
 };
+const streamLogsSkip = async (ctx) => {
+    if (ctx.config.logs === false) {
+        return 'Logs streaming disabled';
+    }
+    const hasPm2 = ctx.config.pm2 !== false && await ctx.test('test -f pm2.config.*');
+    const hasDocker = ctx.config.dockerCompose !== false
+        && await ctx.test('test -f docker-compose.yml -o -f docker-compose.yaml -o -f compose.yml -o -f compose.yaml');
+    if (!hasPm2 && !hasDocker) {
+        return 'No PM2 or Docker Compose detected';
+    }
+    return false;
+};
+const streamLogsTask = async (ctx) => {
+    const logsConfig = {
+        time: 3,
+        ...ctx.config.logs,
+    };
+    const time = logsConfig.time;
+    const hasPm2 = ctx.config.pm2 !== false && await ctx.test('test -f pm2.config.*');
+    const hasDocker = ctx.config.dockerCompose !== false
+        && await ctx.test('test -f docker-compose.yml -o -f docker-compose.yaml -o -f compose.yml -o -f compose.yaml');
+    if (hasPm2) {
+        console.log(chalk.cyan(`Streaming PM2 logs for ${time}s...`));
+        await ctx.run(`timeout ${time} pm2 logs || true`, { printOutput: true, ignoreError: true });
+    }
+    else if (hasDocker) {
+        console.log(chalk.cyan(`Streaming Docker Compose logs for ${time}s...`));
+        await ctx.run(`timeout ${time} docker compose logs --tail=50 -f || true`, {
+            printOutput: true,
+            ignoreError: true,
+        });
+    }
+};
 export const defaultTasks = {
     clearTarget: {
         name: 'Clear target',
@@ -213,6 +249,11 @@ export const defaultTasks = {
         name: 'Print deployment info',
         task: printDeploymentTask,
     },
+    streamLogs: {
+        name: 'Stream logs',
+        skip: streamLogsSkip,
+        task: streamLogsTask,
+    },
 };
 export const defaultScenarios = {
     deploy: {
@@ -224,6 +265,7 @@ export const defaultScenarios = {
             'pm2:setup',
             'docker:setup',
             'print:deployment',
+            'stream:logs',
         ],
     },
 };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export type { AuthMethod, DeployerConfig, DeployerConfigInput, FilesConfig, Placeholders, ScenarioDef, ScenarioInput, ServerConfig, ServerConfigInput, SymlinkConfig, TaskContext, TaskDef, TaskFn, TaskInput, TaskSkipFn, } from './def.js';
+export type { AuthMethod, DeployerConfig, DeployerConfigInput, FilesConfig, LogsConfig, Placeholders, ScenarioDef, ScenarioInput, ServerConfig, ServerConfigInput, SymlinkConfig, TaskContext, TaskDef, TaskFn, TaskInput, TaskSkipFn, } from './def.js';
 export { defineConfig } from './config.js';
 export { runScenario, runTask } from './runner.js';
 export { loadConfig, findConfigFile } from './configLoader.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "d3ployer",
-    "version": "0.0.6",
+    "version": "0.0.8",
     "license": "MIT",
     "type": "module",
     "bin": {