d3ployer 0.0.12 → 0.0.13

package/README.md

@@ -55,16 +55,29 @@ dpl list                            # list available scenarios, tasks, and serve
 ## CLI
 
 ```
-dpl <name> [servers...]    Run a scenario or task
-dpl list                   List scenarios, tasks, and servers
+dpl <name> [servers...]         Run a scenario or task
+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
+  -p, --project <path>          Path to deployer.config.ts
+  --skip <tasks>                Comma-separated list of tasks to skip
+  --config <task.key=value...>  Override task config values at runtime
 ```
 
 If `<name>` matches a scenario, it runs all tasks in that scenario sequentially. Otherwise it runs the matching task directly.
 
+### Runtime config overrides
+
+Use `--config` to override individual task config values without editing `deployer.config.ts`. Values are automatically coerced to `boolean` (`true`/`false`) or `number` where applicable.
+
+```bash
+dpl deploy --config download.dryRun=true
+dpl upload --config upload.delete=false
+dpl deploy --config myTask.someKey=hello --config myTask.retries=3
+```
+
+The format is `taskName.path.to.key=value`, where `taskName` is the task's key in the config.
+
 ## Config
 
 ### `servers`

package/dist/cli.js

@@ -6,15 +6,16 @@ import { runScenario, runTask } from './runner.js';
 const program = new Command()
     .name('deployer')
     .description('TypeScript deployment tool')
-    .option('-c, --config <path>', 'path to deployer.config.ts')
-    .option('--skip <tasks>', 'comma-separated list of tasks to skip');
+    .option('-p, --project <path>', 'path to deployer.config.ts')
+    .option('--skip <tasks>', 'comma-separated list of tasks to skip')
+    .option('-c, --config <taskConfig...>', 'option to override task config (format: path.to.entity=value)');
 program
     .argument('<name>', 'scenario or task name')
     .argument('[servers...]', 'target server(s)')
     .action(async (name, servers) => {
     try {
         const opts = program.opts();
-        const config = await loadConfig(opts.config);
+        const config = await loadConfig(opts.project, opts.config);
         const serverList = servers.length > 0 ? servers : undefined;
         const skipTasks = opts.skip
             ? opts.skip.split(',').map((s) => s.trim()).filter(Boolean)
@@ -36,7 +37,8 @@ program
     .description('list available scenarios, tasks and servers')
     .action(async () => {
     try {
-        const config = await loadConfig(program.opts().config);
+        const opts = program.opts();
+        const config = await loadConfig(opts.project, opts.config);
         console.log(chalk.bold('\nScenarios:'));
         const scenarios = config.scenarios ?? {};
         const scenarioKeys = Object.keys(scenarios);

package/dist/configLoader.d.ts

@@ -1,3 +1,3 @@
 import type { DeployerConfig } from './def.js';
 export declare function findConfigFile(startDir?: string): string;
-export declare function loadConfig(configPath?: string): Promise<DeployerConfig>;
+export declare function loadConfig(configPath?: string, configOverrides?: string[]): Promise<DeployerConfig>;

package/dist/configLoader.js

@@ -1,3 +1,4 @@
+import { set } from 'lodash-es';
 import fs from 'node:fs';
 import path from 'node:path';
 import { Exception } from './utils/Exception.js';
@@ -15,7 +16,7 @@ export function findConfigFile(startDir = process.cwd()) {
     } while (parent !== dir);
     throw new Exception(`Could not find ${CONFIG_FILENAME} in ${startDir} or any parent directory`, 1774741892462);
 }
-export async function loadConfig(configPath) {
+export async function loadConfig(configPath, configOverrides) {
     const resolvedPath = configPath ?? findConfigFile();
     const absolutePath = path.resolve(resolvedPath);
     if (!fs.existsSync(absolutePath)) {
@@ -27,5 +28,39 @@ export async function loadConfig(configPath) {
     if (!config.servers || Object.keys(config.servers).length === 0) {
         throw new Exception('Config must define at least one server', 1774741913430);
     }
+    // override task config if provided via CLI
+    if (configOverrides) {
+        for (const configOverride of configOverrides) {
+            const eqIdx = configOverride.indexOf('=');
+            if (eqIdx === -1) {
+                console.warn(`Invalid task config override (missing '='): ${configOverride}`);
+                continue;
+            }
+            const overrideKey = configOverride.slice(0, eqIdx);
+            const rawValue = configOverride.slice(eqIdx + 1);
+            const keyParts = overrideKey.split('.');
+            if (keyParts.length < 2) {
+                console.warn(`Invalid task config override key: ${overrideKey}`);
+                continue;
+            }
+            const [taskName, ...configPathParts] = keyParts;
+            const taskDef = config.tasks?.[taskName];
+            if (!taskDef) {
+                console.warn(`Task not found for config override: ${taskName}`);
+                continue;
+            }
+            if (!taskDef.config) {
+                taskDef.config = {};
+            }
+            const value = rawValue === 'true'
+                ? true
+                : rawValue === 'false'
+                    ? false
+                    : rawValue !== '' && !isNaN(Number(rawValue))
+                        ? Number(rawValue)
+                        : rawValue;
+            set(taskDef.config, configPathParts, value);
+        }
+    }
     return config;
 }

package/dist/def.d.ts

@@ -40,6 +40,12 @@ export type DockerComposeConfig = {
     configFiles: string[];
     logs: ConfigOrDisable<LogsConfig>;
 };
+export interface TaskDef {
+    name: string;
+    task: TaskFn;
+    skip?: TaskSkipFn;
+    config?: any;
+}
 export interface DeployerConfig {
     rootDir: string;
     servers: Record<string, ServerConfig>;
@@ -85,12 +91,6 @@ export interface TaskContext {
 }
 export type TaskFn = (ctx: TaskContext, ph: Placeholders, task: ListrTaskWrapper<any, any, any>) => Promise<void>;
 export type TaskSkipFn = (ctx: TaskContext, ph: Placeholders) => Promise<boolean | string> | boolean | string;
-export interface TaskDef {
-    name: string;
-    task: TaskFn;
-    skip?: TaskSkipFn;
-    config?: any;
-}
 export type TaskInput = TaskFn | {
     name?: string;
     task: TaskFn;

package/dist/index.d.ts

@@ -3,4 +3,4 @@ export { defineConfig } from './config.js';
 export { runScenario, runTask } from './runner.js';
 export { loadConfig, findConfigFile } from './configLoader.js';
 export { buildRsyncCommand, downloadSkip, downloadTask } from './tasks/index.js';
-export type { RsyncOptions } from './tasks/upload.js';
+export type { RsyncOptions } from './tasks/index.js';

package/dist/runner.d.ts

@@ -1,9 +1,8 @@
 import type { DeployerConfig, ServerConfig, TaskDef } from './def.js';
 export declare function resolveServers(config: DeployerConfig, serverNames?: string[]): Record<string, ServerConfig>;
 export declare function resolveTaskDefs(taskNames: string[], allTasks: Record<string, TaskDef>): Record<string, TaskDef>;
-export declare function runScenario(config: DeployerConfig, scenarioName: string, serverNames?: string[], options?: {
+export type RunTaskOrScenarioOptions = {
     skip?: string[];
-}): Promise<void>;
-export declare function runTask(config: DeployerConfig, taskName: string, serverNames?: string[], options?: {
-    skip?: string[];
-}): Promise<void>;
+};
+export declare function runScenario(config: DeployerConfig, scenarioName: string, serverNames?: string[], options?: RunTaskOrScenarioOptions): Promise<void>;
+export declare function runTask(config: DeployerConfig, taskName: string, serverNames?: string[], options?: RunTaskOrScenarioOptions): Promise<void>;

package/dist/tasks/download.js

@@ -1,7 +1,7 @@
 import chalk from 'chalk';
 import path from 'node:path';
 import { Exception } from '../utils/index.js';
-import { buildRsyncCommand } from './upload.js';
+import { buildRsyncCommand } from './helpers/rsync.js';
 export const downloadSkip = (ctx) => {
     const files = ctx.taskConfig;
     return !files
@@ -21,6 +21,7 @@ export const downloadTask = async (ctx, ph) => {
     const dest = localBase.endsWith('/') ? localBase : localBase + '/';
     const command = buildRsyncCommand(ctx.server, source, dest, files, {
         delete: false,
+        ...ctx.taskConfig,
     });
     console.log(chalk.grey(command));
     await ctx.runLocal(command);

package/dist/tasks/helpers/docker.d.ts

@@ -0,0 +1,2 @@
+import type { DockerComposeConfig } from '../../def.js';
+export declare function buildDockerComposeTestCmd(dockerComposeConfig: DockerComposeConfig | false): string;

package/dist/tasks/helpers/docker.js

@@ -0,0 +1,13 @@
+export 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 ')}`;
+}

package/dist/tasks/helpers/rsync.d.ts

@@ -0,0 +1,6 @@
+import type { FilesConfig, ServerConfig } from '../../def.js';
+export type RsyncOptions = {
+    delete?: boolean;
+    dryRun?: boolean;
+};
+export declare function buildRsyncCommand(server: ServerConfig, source: string, dest: string, files: FilesConfig, options?: RsyncOptions): string;

package/dist/tasks/helpers/rsync.js

@@ -0,0 +1,38 @@
+export function buildRsyncCommand(server, source, dest, files, options = {}) {
+    options = {
+        delete: true,
+        dryRun: false,
+        ...options,
+    };
+    const args = ['rsync', '-avz', '--progress=info2'];
+    if (options.delete) {
+        args.push('--delete');
+    }
+    if (options.dryRun) {
+        args.push('--dry-run');
+    }
+    // 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(' ');
+}

package/dist/tasks/index.d.ts

@@ -1,6 +1,6 @@
 import type { ScenarioDef, TaskDef } from '../def.js';
-export { buildRsyncCommand } from './upload.js';
-export type { RsyncOptions } from './upload.js';
+export { buildRsyncCommand } from './helpers/rsync.js';
+export type { RsyncOptions } from './helpers/rsync.js';
 export { downloadSkip, downloadTask } from './download.js';
 export declare const defaultTasks: Record<string, TaskDef>;
 export declare const defaultScenarios: Record<string, ScenarioDef>;

package/dist/tasks/index.js

@@ -7,7 +7,7 @@ import { setupDockerSkip, setupDockerTask } from './setupDocker.js';
 import { setupPm2Skip, setupPm2Task } from './setupPm2.js';
 import { symlinksSkip, symlinksTask } from './symlinks.js';
 import { uploadSkip, uploadTask } from './upload.js';
-export { buildRsyncCommand } from './upload.js';
+export { buildRsyncCommand } from './helpers/rsync.js';
 export { downloadSkip, downloadTask } from './download.js';
 export const defaultTasks = {
     'clear:target': {

package/dist/tasks/printLogs.js

@@ -1,5 +1,5 @@
 import chalk from 'chalk';
-import { buildDockerComposeTestCmd } from './setupDocker.js';
+import { buildDockerComposeTestCmd } from './helpers/docker.js';
 export const printLogsPm2Skip = async (ctx) => {
     if (ctx.config.pm2 === false
         || ctx.config.pm2.logs === false) {

package/dist/tasks/setupDocker.d.ts

@@ -1,4 +1,3 @@
-import type { DockerComposeConfig, TaskFn, TaskSkipFn } from '../def.js';
-export declare function buildDockerComposeTestCmd(dockerComposeConfig: DockerComposeConfig | false): string;
+import type { TaskFn, TaskSkipFn } from '../def.js';
 export declare const setupDockerSkip: TaskSkipFn;
 export declare const setupDockerTask: TaskFn;

package/dist/tasks/setupDocker.js

@@ -1,16 +1,4 @@
-export 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 ')}`;
-}
+import { buildDockerComposeTestCmd } from './helpers/docker.js';
 export const setupDockerSkip = async (ctx) => {
     if (ctx.config.dockerCompose === false) {
         return 'Docker Compose disabled';

package/dist/tasks/upload.d.ts

@@ -1,7 +1,3 @@
-import type { FilesConfig, ServerConfig, 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;
+import type { TaskFn, TaskSkipFn } from '../def.js';
 export declare const uploadSkip: TaskSkipFn;
 export declare const uploadTask: TaskFn;

package/dist/tasks/upload.js

@@ -1,36 +1,6 @@
 import chalk from 'chalk';
 import path from 'node:path';
-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(' ');
-}
+import { buildRsyncCommand } from './helpers/rsync.js';
 export const uploadSkip = (ctx) => {
     const files = ctx.config.files;
     return !files
@@ -48,6 +18,7 @@ export const uploadTask = async (ctx, ph) => {
     await ctx.run(`mkdir -p ${remotePath}`);
     const command = buildRsyncCommand(ctx.server, source, dest, files, {
         delete: true,
+        ...ctx.taskConfig,
     });
     console.log(chalk.grey(command));
     await ctx.runLocal(command);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "d3ployer",
-    "version": "0.0.12",
+    "version": "0.0.13",
     "license": "MIT",
     "type": "module",
     "bin": {
@@ -39,6 +39,7 @@
         "@tsconfig/node24": "^24.0.4",
         "@types/chai": "^5.2.3",
         "@types/chai-as-promised": "^8.0.2",
+        "@types/lodash-es": "^4.17.12",
         "@types/mocha": "^10.0.10",
         "@types/node": "^24.10.13",
         "c8": "^10.1.3",