d3ployer 0.0.11 → 0.0.12

package/README.md

@@ -37,7 +37,7 @@ export default defineConfig({
     },
   },
   scenarios: {
-    deploy: ['upload', 'symlinks', 'dep:install', 'restart'],
+    deploy: ['upload', 'symlinks', 'install:packages', 'restart'],
   },
 });
 ```
@@ -45,10 +45,11 @@ export default defineConfig({
 Then deploy:
 
 ```bash
-dpl deploy           # run "deploy" scenario on all servers
-dpl deploy prod      # run on specific server(s)
-dpl upload           # run a single task
-dpl list             # list available scenarios, tasks, and servers
+dpl deploy                          # run "deploy" scenario on all servers
+dpl deploy prod                     # run on specific server(s)
+dpl upload                          # run a single task
+dpl deploy --skip install:packages  # skip specific tasks (comma-separated)
+dpl list                            # list available scenarios, tasks, and servers
 ```
 
 ## CLI
@@ -59,6 +60,7 @@ dpl list                   List scenarios, tasks, and servers
 
 Options:
   -c, --config <path>      Path to deployer.config.ts
+  --skip <tasks>           Comma-separated list of tasks to skip
 ```
 
 If `<name>` matches a scenario, it runs all tasks in that scenario sequentially. Otherwise it runs the matching task directly.
@@ -119,20 +121,33 @@ packageManager: {
 
 ### `pm2`
 
-Set to `false` to disable the built-in PM2 task. When enabled (default), the `pm2:setup` task auto-detects `pm2.config.*` files and runs `pm2 start`.
+Configure PM2 integration. Set to `false` to disable entirely. The `setup:pm2` task auto-detects `pm2.config.*` files. Post-deploy log streaming is configured via `pm2.logs`.
 
-### `dockerCompose`
-
-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`.
+```ts
+pm2: {
+  logs: {
+    time: 5,   // seconds to stream (default: 3)
+    lines: 50, // log lines to show (default: 25)
+  },
+  // logs: false  — disable log streaming only
+}
+// pm2: false    — disable PM2 entirely
+```
 
-### `logs`
+### `dockerCompose`
 
-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.
+Configure Docker Compose integration. Set to `false` to disable entirely. The `setup:docker` task auto-detects compose files. Specify custom compose files via `configFiles`.
 
 ```ts
-logs: {
-  time: 5, // seconds to stream logs (default: 3)
+dockerCompose: {
+  configFiles: ['docker-compose.prod.yml'], // optional, defaults to auto-detect
+  logs: {
+    time: 5,   // seconds to stream (default: 3)
+    lines: 50, // log lines to show (default: 25)
+  },
+  // logs: false  — disable log streaming only
 }
+// dockerCompose: false  — disable Docker Compose entirely
 ```
 
 ### `tasks`
@@ -141,7 +156,7 @@ Custom task functions receive a `TaskContext` and `Placeholders`:
 
 ```ts
 tasks: {
-  migrate: async (ctx, ph) => {
+  migrate: async (ctx, ph, task) => {
     await ctx.run('npm run migrate');
   },
 }
@@ -154,7 +169,7 @@ tasks: {
   myTask: {
     name: 'My Task',
     skip: async (ctx) => !someCondition ? 'Reason to skip' : false,
-    task: async (ctx, ph) => { /* ... */ },
+    task: async (ctx, ph, task) => { /* ... */ },
     config: { /* passed as ctx.taskConfig */ },
   },
 }
@@ -187,7 +202,7 @@ Named sequences of tasks:
 
 ```ts
 scenarios: {
-  deploy: ['upload', 'symlinks', 'dep:install', 'restart'],
+  deploy: ['upload', 'symlinks', 'install:packages', 'restart'],
 }
 ```
 
@@ -197,30 +212,31 @@ Or as objects with a custom name:
 scenarios: {
   deploy: {
     name: 'Deploy',
-    tasks: ['upload', 'symlinks', 'dep:install', 'restart'],
+    tasks: ['upload', 'symlinks', 'install:packages', 'restart'],
   },
 }
 ```
 
 ## Built-in tasks
 
-| Task               | Description                                              |
-| ------------------ | -------------------------------------------------------- |
-| `upload`           | Rsync files to the remote server                         |
-| `download`         | Rsync files from the remote server (uses task config)    |
-| `symlinks`         | Create configured symlinks on the remote server          |
-| `dep:install`      | Install dependencies via npm/yarn/pnpm                   |
-| `pm2:setup`        | Start/restart PM2 processes (auto-detects pm2.config.*)  |
-| `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         |
+| Task                | Description                                              |
+| ------------------- | -------------------------------------------------------- |
+| `upload`            | Rsync files to the remote server                         |
+| `download`          | Rsync files from the remote server (uses task config)    |
+| `symlinks`          | Create configured symlinks on the remote server          |
+| `install:packages`  | Install dependencies via npm/yarn/pnpm                   |
+| `setup:pm2`         | Start/restart PM2 processes (auto-detects pm2.config.*)  |
+| `setup:docker`      | 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)          |
+| `print:logs:pm2`    | Stream PM2 logs for a configured duration                |
+| `print:logs:docker` | Stream Docker Compose logs for a configured duration     |
 
 ### Default `deploy` scenario
 
-The built-in `deploy` scenario runs: `upload` → `symlinks` → `dep:install` → `pm2:setup` → `docker:setup` → `print:deployment` → `stream:logs`
+The built-in `deploy` scenario runs: `upload` → `symlinks` → `install:packages` → `setup:pm2` → `setup:docker` → `print:deployment` → `print:logs:pm2` → `print:logs:docker`
 
-Tasks with skip conditions will be automatically skipped when not applicable (e.g. `pm2:setup` skips if no PM2 config file exists).
+Tasks with skip conditions will be automatically skipped when not applicable (e.g. `setup:pm2` skips if no PM2 config file exists).
 
 ## Requirements
 

package/package.json

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

package/dist/defaultTasks.d.ts

@@ -1,9 +0,0 @@
-import type { FilesConfig, ScenarioDef, ServerConfig, TaskDef, TaskFn, TaskSkipFn } from './def.js';
-export type RsyncOptions = {
-    delete?: boolean;
-};
-export declare function buildRsyncCommand(server: ServerConfig, source: string, dest: string, files: FilesConfig, options?: RsyncOptions): string;
-export declare const downloadSkip: TaskSkipFn;
-export declare const downloadTask: TaskFn;
-export declare const defaultTasks: Record<string, TaskDef>;
-export declare const defaultScenarios: Record<string, ScenarioDef>;

package/dist/defaultTasks.js

@@ -1,303 +0,0 @@
-import confirm from '@inquirer/confirm';
-import chalk from 'chalk';
-import path from 'node:path';
-import { Exception } from './utils/index.js';
-export function buildRsyncCommand(server, source, dest, files, options = {}) {
-    const { delete: useDelete = true, } = options;
-    const args = ['rsync', '-avz', '--progress=info2'];
-    if (useDelete) {
-        args.push('--delete');
-    }
-    // ssh shell
-    const sshParts = ['ssh'];
-    if (server.port && server.port !== 22) {
-        sshParts.push(`-p ${server.port}`);
-    }
-    if (server.authMethod === 'key' && server.privateKey) {
-        sshParts.push(`-i ${server.privateKey}`);
-    }
-    sshParts.push('-o StrictHostKeyChecking=no');
-    args.push('-e', `"${sshParts.join(' ')}"`);
-    // include/exclude
-    if (files.exclude) {
-        for (const pattern of files.exclude) {
-            args.push(`--exclude="${pattern}"`);
-        }
-    }
-    if (files.include) {
-        for (const pattern of files.include) {
-            args.push(`--include="${pattern}"`);
-        }
-        args.push('--exclude="*"');
-    }
-    args.push(source, dest);
-    return args.join(' ');
-}
-const uploadSkip = (ctx) => {
-    const files = ctx.config.files;
-    return !files
-        ? 'No files configuration defined'
-        : false;
-};
-const uploadTask = async (ctx, ph) => {
-    const files = ctx.config.files;
-    const localBase = files.basePath?.startsWith('/')
-        ? files.basePath
-        : path.resolve(ctx.config.rootDir, files.basePath ?? '.');
-    const remotePath = ph.deployPath;
-    const dest = `${ctx.server.username}@${ctx.server.host}:${remotePath}`;
-    const source = localBase.endsWith('/') ? localBase : localBase + '/';
-    await ctx.run(`mkdir -p ${remotePath}`);
-    const command = buildRsyncCommand(ctx.server, source, dest, files, {
-        delete: true,
-    });
-    console.log(chalk.grey(command));
-    await ctx.runLocal(command);
-};
-export const downloadSkip = (ctx) => {
-    const files = ctx.taskConfig;
-    return !files
-        ? 'No files configuration provided in task config'
-        : false;
-};
-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 ?? '.');
-    const remotePath = ph.deployPath;
-    const source = `${ctx.server.username}@${ctx.server.host}:${remotePath}/`;
-    const dest = localBase.endsWith('/') ? localBase : localBase + '/';
-    const command = buildRsyncCommand(ctx.server, source, dest, files, {
-        delete: false,
-    });
-    console.log(chalk.grey(command));
-    await ctx.runLocal(command);
-};
-const symlinksSkip = (ctx) => {
-    const symlinks = ctx.config.symlinks;
-    return !symlinks || symlinks.length === 0
-        ? 'No symlinks defined in config'
-        : false;
-};
-const symlinksTask = async (ctx, ph) => {
-    const symlinks = ctx.config.symlinks;
-    for (const link of symlinks) {
-        const target = link.target.startsWith('/')
-            ? link.target
-            : `${ph.deployPath}/${link.target}`;
-        const path = link.path.startsWith('/')
-            ? link.path
-            : `${ph.deployPath}/${link.path}`;
-        await ctx.run(`ln -sfn ${target} ${path}`);
-    }
-};
-const depInstallSkip = (ctx) => {
-    if (ctx.server.packageManager !== undefined) {
-        return ctx.server.packageManager === false
-            ? 'Package manager disabled for server'
-            : false;
-    }
-    if (ctx.config.packageManager !== undefined) {
-        return ctx.config.packageManager === false
-            ? 'Package manager disabled in config'
-            : false;
-    }
-    return false;
-};
-const depInstallTask = async (ctx) => {
-    const config = {
-        manager: 'npm',
-        productionOnly: true,
-        ...ctx.config.packageManager,
-        ...ctx.server.packageManager,
-    };
-    let cmd = `${config.manager} install`;
-    if (config.productionOnly) {
-        if (config.manager === 'npm') {
-            cmd += ' --omit=dev';
-        }
-        else if (config.manager === 'yarn') {
-            cmd += ' --production';
-        }
-        else if (config.manager === 'pnpm') {
-            cmd += ' --prod';
-        }
-        else {
-            throw new Exception(`Unsupported package manager "${config.manager}"`, 1774823752134);
-        }
-    }
-    await ctx.run(cmd);
-};
-const pm2SetupSkip = async (ctx) => {
-    if (ctx.config.pm2 === false) {
-        return 'PM2 disabled';
-    }
-    const pm2ConfigExists = await ctx.test('test -f pm2.config.*');
-    if (!pm2ConfigExists) {
-        return 'PM2 config not found';
-    }
-    return false;
-};
-const pm2SetupTask = async (ctx) => {
-    await ctx.run('pm2 start pm2.config.* --update-env');
-    await ctx.run('pm2 save');
-};
-function buildDockerComposeTestCmd(dockerComposeConfig) {
-    if (dockerComposeConfig === false) {
-        return 'false';
-    }
-    const configFiles = dockerComposeConfig.configFiles ?? [
-        'docker-compose.yml',
-        'docker-compose.yaml',
-        'compose.yml',
-        'compose.yaml',
-    ];
-    const testCmdPart = configFiles.map(f => `-f ${f}`);
-    return `test ${testCmdPart.join(' -o ')}`;
-}
-const dockerSetupSkip = async (ctx) => {
-    if (ctx.config.dockerCompose === false) {
-        return 'Docker Compose disabled';
-    }
-    const testCmd = buildDockerComposeTestCmd(ctx.config.dockerCompose);
-    const composeExists = await ctx.test(testCmd);
-    if (!composeExists) {
-        return 'Docker Compose config not found';
-    }
-    return false;
-};
-const dockerSetupTask = async (ctx) => {
-    if (ctx.config.dockerCompose === false) {
-        return;
-    }
-    const configFiles = ctx.config.dockerCompose?.configFiles ?? [];
-    const options = configFiles.map(f => `-f ${f}`).join(' ');
-    await ctx.run(`docker compose ${options} down --remove-orphans`);
-    await ctx.run(`docker compose ${options} up -d --build`);
-};
-const clearTargetTask = async (ctx, ph) => {
-    const confirmed = await confirm({
-        message: chalk.red(`Remove entire deploy path ${ph.deployPath} on ${ctx.server.host}?`),
-        default: false,
-    });
-    if (!confirmed) {
-        console.log(chalk.yellow('Skipped clearing target'));
-        return;
-    }
-    await ctx.run(`rm -rf ${ph.deployPath}`);
-};
-const printDeploymentTask = async (ctx, ph) => {
-    await ctx.run('date');
-    console.log(chalk.cyan('Deployment directory'), ph.deployPath);
-    await ctx.run('ls -la .');
-    console.log(chalk.cyan('Directory size'));
-    await ctx.run('du -hd 1 .');
-};
-const logsStreamSkip = async (ctx) => {
-    if (ctx.config.logs === false) {
-        return 'Logs streaming disabled';
-    }
-    const hasPm2 = ctx.config.pm2 !== false && await ctx.test('test -f pm2.config.*');
-    let hasDocker = false;
-    if (ctx.config.dockerCompose) {
-        const testCmd = buildDockerComposeTestCmd(ctx.config.dockerCompose);
-        hasDocker = await ctx.test(testCmd);
-    }
-    if (!hasPm2 && !hasDocker) {
-        return 'No PM2 or Docker Compose detected';
-    }
-    return false;
-};
-const logsStreamTask = 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.*');
-    let hasDocker = false;
-    if (ctx.config.dockerCompose !== false) {
-        const testCmd = buildDockerComposeTestCmd(ctx.config.dockerCompose);
-        hasDocker = await ctx.test(testCmd);
-    }
-    if (hasPm2) {
-        const pm2ConfigRaw = await ctx.run('cat pm2.config.*', { printOutput: false });
-        const nameMatch = pm2ConfigRaw.stdout.match(/name: ['"](?<name>.+?)['"]/);
-        const name = nameMatch.groups?.name ?? 'all';
-        console.log(chalk.cyan(`Streaming PM2 logs for ${time}s...`));
-        await ctx.run(`timeout ${time} pm2 logs "${name}" || true`, { printOutput: true, ignoreError: true });
-    }
-    else if (hasDocker && ctx.config.dockerCompose) {
-        const configFiles = ctx.config.dockerCompose.configFiles ?? [];
-        const options = configFiles.map(f => `-f ${f}`).join(' ');
-        console.log(chalk.cyan(`Streaming Docker Compose logs for ${time}s...`));
-        await ctx.run(`timeout ${time} docker compose ${options} logs --tail=10 -f || true`, {
-            printOutput: true,
-            ignoreError: true,
-        });
-    }
-};
-export const defaultTasks = {
-    clearTarget: {
-        name: 'Clear target',
-        task: clearTargetTask,
-    },
-    upload: {
-        name: 'Upload files',
-        skip: uploadSkip,
-        task: uploadTask,
-    },
-    download: {
-        name: 'Download files',
-        skip: downloadSkip,
-        task: downloadTask,
-    },
-    symlinks: {
-        name: 'Create symlinks',
-        skip: symlinksSkip,
-        task: symlinksTask,
-    },
-    depInstall: {
-        name: 'Install dependencies',
-        skip: depInstallSkip,
-        task: depInstallTask,
-    },
-    pm2Setup: {
-        name: 'PM2 setup',
-        skip: pm2SetupSkip,
-        task: pm2SetupTask,
-    },
-    dockerSetup: {
-        name: 'Docker Compose setup',
-        skip: dockerSetupSkip,
-        task: dockerSetupTask,
-    },
-    printDeployment: {
-        name: 'Print deployment info',
-        task: printDeploymentTask,
-    },
-    logsStream: {
-        name: 'Logs stream',
-        skip: logsStreamSkip,
-        task: logsStreamTask,
-    },
-};
-export const defaultScenarios = {
-    deploy: {
-        name: 'Deploy',
-        tasks: [
-            'upload',
-            'symlinks',
-            'dep:install',
-            'pm2:setup',
-            'docker:setup',
-            'print:deployment',
-            'logs:stream',
-        ],
-    },
-};

package/dist/tasks/logsStream.d.ts

@@ -1,5 +0,0 @@
-import type { TaskFn, TaskSkipFn } from '../def.js';
-export declare const printLogsPm2Skip: TaskSkipFn;
-export declare const printLogsDockerSkip: TaskSkipFn;
-export declare const printLogsPm2Task: TaskFn;
-export declare const printLogsDockerComposeTask: TaskFn;

package/dist/tasks/logsStream.js

@@ -1,69 +0,0 @@
-import chalk from 'chalk';
-import { buildDockerComposeTestCmd } from './setupDocker.js';
-export const printLogsPm2Skip = async (ctx) => {
-    if (ctx.config.pm2 === false
-        || ctx.config.pm2.logs === false) {
-        return 'Logs disabled';
-    }
-    const hasPm2 = await ctx.test('test -f pm2.config.*');
-    if (!hasPm2) {
-        return 'No PM2 detected';
-    }
-    return false;
-};
-export const printLogsDockerSkip = async (ctx) => {
-    if (ctx.config.dockerCompose === false
-        || ctx.config.dockerCompose.logs === false) {
-        return 'Logs disabled';
-    }
-    const testCmd = buildDockerComposeTestCmd(ctx.config.dockerCompose);
-    const hasDocker = await ctx.test(testCmd);
-    if (!hasDocker) {
-        return 'No Docker Compose detected';
-    }
-    return false;
-};
-export const printLogsPm2Task = async (ctx) => {
-    if (ctx.config.pm2 === false
-        || ctx.config.pm2.logs === false) {
-        return;
-    }
-    const logsConfig = {
-        time: 3,
-        lines: 25,
-        ...ctx.config.pm2.logs,
-    };
-    const hasPm2 = await ctx.test('test -f pm2.config.*');
-    if (hasPm2) {
-        const pm2ConfigRaw = await ctx.run('cat pm2.config.*', { printOutput: false });
-        const nameMatch = pm2ConfigRaw.stdout.match(/name: ['"](?<name>.+?)['"]/);
-        const name = nameMatch.groups?.name ?? 'all';
-        console.log(chalk.cyan(`Streaming PM2 logs for ${logsConfig.time}s...`));
-        await ctx.run(`timeout ${logsConfig.time} pm2 logs --lines=${logsConfig.lines} "${name}" || true`, {
-            printOutput: true,
-            ignoreError: true,
-        });
-    }
-};
-export const printLogsDockerComposeTask = async (ctx) => {
-    if (ctx.config.dockerCompose === false
-        || ctx.config.dockerCompose.logs === false) {
-        return;
-    }
-    const logsConfig = {
-        time: 3,
-        lines: 25,
-        ...ctx.config.dockerCompose.logs,
-    };
-    const testCmd = buildDockerComposeTestCmd(ctx.config.dockerCompose);
-    const hasDocker = await ctx.test(testCmd);
-    if (hasDocker) {
-        const configFiles = ctx.config.dockerCompose.configFiles ?? [];
-        const options = configFiles.map(f => `-f ${f}`).join(' ');
-        console.log(chalk.cyan(`Streaming Docker Compose logs for ${logsConfig.time}s...`));
-        await ctx.run(`timeout ${logsConfig.time} docker compose ${options} logs --tail=${logsConfig.lines} -f || true`, {
-            printOutput: true,
-            ignoreError: true,
-        });
-    }
-};