d3ployer 0.0.13 → 0.0.14

package/README.md

@@ -25,7 +25,7 @@ export default defineConfig({
     },
   },
   files: {
-    basePath: './dist',
+    localPath: './dist',
     exclude: ['node_modules', '.git'],
   },
   symlinks: [
@@ -103,12 +103,22 @@ Configure rsync file upload.
 
 ```ts
 files: {
-  basePath: './dist',       // local directory to sync (default: '.')
-  include: ['src/**'],      // rsync include patterns
-  exclude: ['node_modules'],// rsync exclude patterns
+  localPath: './dist',        // local directory to sync (relative to rootDir or absolute, default: '.')
+  remotePath: 'app',          // remote directory (relative to deployPath or absolute, default: deployPath)
+  include: ['src/**'],        // rsync include patterns
+  exclude: ['node_modules'],  // rsync exclude patterns
 }
 ```
 
+Or as an array of entries to sync multiple directories:
+
+```ts
+files: [
+  { localPath: './dist', remotePath: 'app', exclude: ['*.map'] },
+  { localPath: './config', remotePath: 'config' },
+]
+```
+
 ### `symlinks`
 
 Create symlinks on the remote server.
@@ -188,9 +198,26 @@ tasks: {
 }
 ```
 
+Use `defineTask` for type-safe task definitions with a typed config:
+
+```ts
+import { defineConfig, defineTask } from 'd3ployer';
+
+export default defineConfig({
+  tasks: {
+    myTask: defineTask<{ retries: number }>({
+      task: async (ctx) => {
+        const retries = ctx.taskConfig!.retries; // typed as number
+      },
+      config: { retries: 3 },
+    }),
+  },
+});
+```
+
 Task keys are auto-converted from camelCase to colon:case (e.g. `depInstall` becomes `dep:install`).
 
-**TaskContext** provides:
+**TaskContext\<C\>** provides:
 - `run(cmd, options?)` - execute a command on the remote server (auto cd's to `deployPath`)
 - `test(cmd)` - execute a command on the remote server, returns `boolean`
 - `runLocal(cmd, options?)` - execute a command locally
@@ -198,7 +225,7 @@ Task keys are auto-converted from camelCase to colon:case (e.g. `depInstall` bec
 - `server` - current server config (includes `name`)
 - `ssh` - SSH2Promise connection
 - `config` - full deployer config
-- `taskConfig` - per-task config from task definition
+- `taskConfig` - per-task config from task definition (typed as `C` when using `defineTask<C>`)
 
 **RunOptions** (for `run` and `runLocal`):
 - `printOutput` - print stdout/stderr (default: `true`)
@@ -234,8 +261,8 @@ scenarios: {
 
 | Task                | Description                                              |
 | ------------------- | -------------------------------------------------------- |
-| `upload`            | Rsync files to the remote server                         |
-| `download`          | Rsync files from the remote server (uses task config)    |
+| `upload`            | Rsync files to the remote server (supports multiple file entries) |
+| `download`          | Rsync files from the remote server (uses task config, supports multiple file entries) |
 | `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.*)  |

package/dist/config.d.ts

@@ -1,2 +1,3 @@
-import type { DeployerConfig, DeployerConfigInput } from './def.js';
+import type { DeployerConfig, DeployerConfigInput, TaskConfigBase } from './def.js';
+export declare function defineTask<C>(input: TaskConfigBase<C>): TaskConfigBase<C>;
 export declare function defineConfig(input: DeployerConfigInput): DeployerConfig;

package/dist/config.js

@@ -35,6 +35,9 @@ function normalizeScenario(key, input) {
         tasks: input.tasks,
     };
 }
+export function defineTask(input) {
+    return input;
+}
 export function defineConfig(input) {
     const servers = {};
     for (const [name, serverInput] of Object.entries(input.servers)) {

package/dist/def.d.ts

@@ -19,11 +19,13 @@ export interface ServerConfig {
     initCmd?: string;
 }
 export type ServerConfigInput = Partial<ServerConfig> & Pick<ServerConfig, 'host' | 'deployPath'>;
-export interface FilesConfig {
-    basePath?: string;
+export interface FilesConfigBase {
+    localPath?: string;
+    remotePath?: string;
     include?: string[];
     exclude?: string[];
 }
+export type FilesConfig = FilesConfigBase | FilesConfigBase[];
 export interface SymlinkConfig {
     path: string;
     target: string;
@@ -77,7 +79,7 @@ export type RunOptions = {
     printOutput?: boolean;
     ignoreError?: boolean;
 };
-export interface TaskContext {
+export interface TaskContext<C = any> {
     server: ServerConfig & {
         name: string;
     };
@@ -87,16 +89,18 @@ export interface TaskContext {
     testLocal: (cmd: string) => Promise<boolean>;
     run: (cmd: string, options?: RunOptions) => Promise<ExecResult>;
     test: (cmd: string) => Promise<boolean>;
-    taskConfig?: any;
+    taskConfig?: C;
 }
-export type TaskFn = (ctx: TaskContext, ph: Placeholders, task: ListrTaskWrapper<any, any, any>) => Promise<void>;
+export type TaskFn<C = any> = (ctx: TaskContext<C>, ph: Placeholders, task: ListrTaskWrapper<any, any, any>) => Promise<void>;
 export type TaskSkipFn = (ctx: TaskContext, ph: Placeholders) => Promise<boolean | string> | boolean | string;
-export type TaskInput = TaskFn | {
+export type TaskConfigBase<C = any> = {
     name?: string;
-    task: TaskFn;
+    task: TaskFn<C>;
     skip?: TaskSkipFn;
-    config?: any;
+    config?: C;
 };
+export type TaskConfig<T = any> = T extends TaskFn<infer C> ? TaskConfigBase<C> : TaskConfigBase;
+export type TaskInput<C = any> = TaskFn<C> | TaskConfig<C>;
 export interface ScenarioDef {
     name: string;
     tasks: string[];

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 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 { defineConfig, defineTask } from './config.js';
 export { runScenario, runTask } from './runner.js';
 export { loadConfig, findConfigFile } from './configLoader.js';
 export { buildRsyncCommand, downloadSkip, downloadTask } from './tasks/index.js';

package/dist/index.js

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

package/dist/tasks/download.d.ts

@@ -1,3 +1,3 @@
-import type { TaskFn, TaskSkipFn } from '../def.js';
+import type { FilesConfig, TaskFn, TaskSkipFn } from '../def.js';
 export declare const downloadSkip: TaskSkipFn;
-export declare const downloadTask: TaskFn;
+export declare const downloadTask: TaskFn<FilesConfig>;

package/dist/tasks/download.js

@@ -9,20 +9,26 @@ export const downloadSkip = (ctx) => {
         : false;
 };
 export const downloadTask = async (ctx, ph) => {
-    const files = ctx.taskConfig;
-    if (!files) {
+    if (!ctx.taskConfig) {
         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,
-        ...ctx.taskConfig,
-    });
-    console.log(chalk.grey(command));
-    await ctx.runLocal(command);
+    const filesArray = ctx.taskConfig instanceof Array
+        ? ctx.taskConfig
+        : [ctx.taskConfig];
+    for (const filesEntry of filesArray) {
+        const localBase = filesEntry.localPath?.startsWith('/')
+            ? filesEntry.localPath
+            : path.resolve(ctx.config.rootDir, filesEntry.localPath ?? '.');
+        const remotePath = filesEntry.remotePath?.startsWith('/')
+            ? filesEntry.remotePath
+            : path.join(ctx.server.deployPath, filesEntry.remotePath ?? '.');
+        const source = `${ctx.server.username}@${ctx.server.host}:${remotePath}/`;
+        const dest = localBase.endsWith('/') ? localBase : localBase + '/';
+        const command = buildRsyncCommand(ctx.server, source, dest, filesEntry, {
+            delete: false,
+            ...ctx.taskConfig,
+        });
+        console.log(chalk.grey(command));
+        await ctx.runLocal(command);
+    }
 };

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

@@ -1,6 +1,6 @@
-import type { FilesConfig, ServerConfig } from '../../def.js';
+import type { FilesConfigBase, 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;
+export declare function buildRsyncCommand(server: ServerConfig, source: string, dest: string, files: FilesConfigBase, options?: RsyncOptions): string;

package/dist/tasks/upload.js

@@ -8,18 +8,24 @@ export const uploadSkip = (ctx) => {
         : false;
 };
 export 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,
-        ...ctx.taskConfig,
-    });
-    console.log(chalk.grey(command));
-    await ctx.runLocal(command);
+    const filesArray = ctx.config.files instanceof Array
+        ? ctx.config.files
+        : [ctx.config.files];
+    for (const filesEntry of filesArray) {
+        const localBase = filesEntry.localPath?.startsWith('/')
+            ? filesEntry.localPath
+            : path.resolve(ctx.config.rootDir, filesEntry.localPath ?? '.');
+        const remotePath = filesEntry.remotePath?.startsWith('/')
+            ? filesEntry.remotePath
+            : path.join(ctx.server.deployPath, filesEntry.remotePath ?? '.');
+        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, filesEntry, {
+            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.13",
+    "version": "0.0.14",
     "license": "MIT",
     "type": "module",
     "bin": {