@mittwald/cli 1.1.0 → 1.2.0

package/dist/commands/app/download.d.ts

@@ -11,10 +11,15 @@ export declare class Download extends ExecRenderBaseCommand<typeof Download, voi
         exclude: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
         "dry-run": import("@oclif/core/interfaces").BooleanFlag<boolean>;
         delete: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "remote-sub-directory": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         "ssh-user": import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         "ssh-identity-file": import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     protected exec(): Promise<void>;
     protected render(): ReactNode;
 }

package/dist/commands/app/download.js

@@ -8,7 +8,7 @@ import { getSSHConnectionForAppInstallation } from "../../lib/resources/ssh/appi
 import { spawnInProcess } from "../../rendering/process/process_exec.js";
 import { sshConnectionFlags } from "../../lib/resources/ssh/flags.js";
 import { sshUsageDocumentation } from "../../lib/resources/ssh/doc.js";
-import { appInstallationSyncFlags, appInstallationSyncFlagsToRsyncFlags, filterFileDocumentation, filterFileToRsyncFlagsIfPresent, } from "../../lib/resources/app/sync.js";
+import { appInstallationSyncFlags, appInstallationSyncFlagsToRsyncFlags, buildRsyncConnectionString, filterFileDocumentation, filterFileToRsyncFlagsIfPresent, } from "../../lib/resources/app/sync.js";
 import { hasBinaryInPath } from "../../lib/util/fs/hasBinaryInPath.js";
 export class Download extends ExecRenderBaseCommand {
     static summary = "Download the filesystem of an app within a project to your local machine";
@@ -30,11 +30,21 @@ export class Download extends ExecRenderBaseCommand {
             exists: false,
         }),
     };
+    static examples = [
+        {
+            description: "Download entire app to current working directory",
+            command: "$ <%= config.bin %> <%= command.id %> .",
+        },
+        {
+            description: "Download only shared dir from a deployer-managed app",
+            command: "<%= config.bin %> <%= command.id %> --remote-sub-directory=shared .",
+        },
+    ];
     async exec() {
         const appInstallationId = await this.withAppInstallationId(Download);
         const { "dry-run": dryRun, target, "ssh-user": sshUser } = this.flags;
         const p = makeProcessRenderer(this.flags, "Downloading app installation");
-        const { host, user, directory } = await p.runStep("getting connection data", async () => {
+        const connectionData = await p.runStep("getting connection data", async () => {
             return getSSHConnectionForAppInstallation(this.apiClient, appInstallationId, sshUser);
         });
         await p.runStep("check if rsync is installed", async () => {
@@ -42,11 +52,12 @@ export class Download extends ExecRenderBaseCommand {
                 throw new Error("this command requires rsync to be installed");
             }
         });
+        const rsyncHost = buildRsyncConnectionString(connectionData, this.flags);
         const rsyncOpts = [
             ...appInstallationSyncFlagsToRsyncFlags(this.flags),
             ...(await filterFileToRsyncFlagsIfPresent(target)),
         ];
-        await spawnInProcess(p, "downloading app installation" + (dryRun ? " (dry-run)" : ""), "rsync", [...rsyncOpts, `${user}@${host}:${directory}/`, target]);
+        await spawnInProcess(p, "downloading app installation" + (dryRun ? " (dry-run)" : ""), "rsync", [...rsyncOpts, rsyncHost, target]);
         if (dryRun) {
             await p.complete(_jsx(Success, { children: "App would (probably) have successfully been downloaded. \uD83D\uDE42" }));
         }

package/dist/commands/app/upload.d.ts

@@ -11,6 +11,7 @@ export declare class Upload extends ExecRenderBaseCommand<typeof Upload, void> {
         exclude: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
         "dry-run": import("@oclif/core/interfaces").BooleanFlag<boolean>;
         delete: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "remote-sub-directory": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         "ssh-user": import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         "ssh-identity-file": import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;

package/dist/commands/app/upload.js

@@ -8,7 +8,7 @@ import { getSSHConnectionForAppInstallation } from "../../lib/resources/ssh/appi
 import { spawnInProcess } from "../../rendering/process/process_exec.js";
 import { sshConnectionFlags } from "../../lib/resources/ssh/flags.js";
 import { sshUsageDocumentation } from "../../lib/resources/ssh/doc.js";
-import { appInstallationSyncFlags, appInstallationSyncFlagsToRsyncFlags, filterFileDocumentation, filterFileToRsyncFlagsIfPresent, } from "../../lib/resources/app/sync.js";
+import { appInstallationSyncFlags, appInstallationSyncFlagsToRsyncFlags, buildRsyncConnectionString, filterFileDocumentation, filterFileToRsyncFlagsIfPresent, } from "../../lib/resources/app/sync.js";
 import { hasBinaryInPath } from "../../lib/util/fs/hasBinaryInPath.js";
 export class Upload extends ExecRenderBaseCommand {
     static summary = "Upload the filesystem of an app to a project";
@@ -36,7 +36,7 @@ export class Upload extends ExecRenderBaseCommand {
         const appInstallationId = await this.withAppInstallationId(Upload);
         const { "dry-run": dryRun, source, "ssh-user": sshUser } = this.flags;
         const p = makeProcessRenderer(this.flags, "Uploading app installation");
-        const { host, user, directory } = await p.runStep("getting connection data", async () => {
+        const connectionData = await p.runStep("getting connection data", async () => {
             return getSSHConnectionForAppInstallation(this.apiClient, appInstallationId, sshUser);
         });
         await p.runStep("check if rsync is installed", async () => {
@@ -44,11 +44,12 @@ export class Upload extends ExecRenderBaseCommand {
                 throw new Error("this command requires rsync to be installed");
             }
         });
+        const rsyncHost = buildRsyncConnectionString(connectionData, this.flags);
         const rsyncOpts = [
             ...appInstallationSyncFlagsToRsyncFlags(this.flags),
             ...(await filterFileToRsyncFlagsIfPresent(source)),
         ];
-        await spawnInProcess(p, "uploading app installation" + (dryRun ? " (dry-run)" : ""), "rsync", [...rsyncOpts, source, `${user}@${host}:${directory}/`]);
+        await spawnInProcess(p, "uploading app installation" + (dryRun ? " (dry-run)" : ""), "rsync", [...rsyncOpts, source, rsyncHost]);
         await p.complete(_jsx(UploadSuccess, { dryRun: dryRun }));
     }
     render() {

package/dist/lib/resources/app/sync.d.ts

@@ -1,15 +1,29 @@
 import { SSHConnectionFlags } from "../ssh/flags.js";
+import { SSHConnectionData } from "../ssh/types.js";
 export declare const defaultRsyncFilterFile = ".mw-rsync-filter";
 export interface AppInstallationSyncFlags {
     exclude: string[];
     "dry-run": boolean;
     delete: boolean;
+    "sub-directory"?: string;
 }
 export declare const appInstallationSyncFlags: (direction: "upload" | "download") => {
     exclude: import("@oclif/core/interfaces").OptionFlag<string[], import("@oclif/core/interfaces").CustomOptions>;
     "dry-run": import("@oclif/core/interfaces").BooleanFlag<boolean>;
     delete: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    "remote-sub-directory": import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
 };
 export declare const filterFileDocumentation: string;
 export declare function filterFileToRsyncFlagsIfPresent(targetDir: string, filterFile?: string): Promise<string[]>;
+/**
+ * Build the rsync connection string for the given SSH connection data and flag
+ * inputs.
+ *
+ * @param host Remote SSH hostname
+ * @param directory Remove base directory of the app installation
+ * @param user Remote SSH user
+ * @param subDirectory Optional sub-directory within the app installation to
+ *   sync
+ */
+export declare function buildRsyncConnectionString({ host, directory, user }: SSHConnectionData, { "sub-directory": subDirectory }: AppInstallationSyncFlags): string;
 export declare function appInstallationSyncFlagsToRsyncFlags(f: AppInstallationSyncFlags & SSHConnectionFlags): string[];

package/dist/lib/resources/app/sync.js

@@ -18,6 +18,13 @@ export const appInstallationSyncFlags = (direction) => ({
             : "delete remote files that are not present locally",
         default: false,
     }),
+    "remote-sub-directory": Flags.string({
+        summary: `specify a sub-directory within the app installation to ${direction}`,
+        description: `This is particularly useful when you only want to ${direction} a specific sub-directory of the app installation, ` +
+            "for example when you are using a deployment tool that manages the app installation directory itself, " +
+            `and you only want to ${direction} exempt files, like environment specific configuration files or user data. ` +
+            `For example, if you want to ${direction} ${direction === "upload" ? "to" : "from"} "/html/my-app-XXXXX/config", set "--remote-sub-directory=config".`,
+    }),
 });
 export const filterFileDocumentation = `This command will also look for a file named ${defaultRsyncFilterFile} in the current ` +
     "directory and use it as a filter file for rsync. Have a look at " +
@@ -30,6 +37,22 @@ export async function filterFileToRsyncFlagsIfPresent(targetDir, filterFile = de
     }
     return [];
 }
+/**
+ * Build the rsync connection string for the given SSH connection data and flag
+ * inputs.
+ *
+ * @param host Remote SSH hostname
+ * @param directory Remove base directory of the app installation
+ * @param user Remote SSH user
+ * @param subDirectory Optional sub-directory within the app installation to
+ *   sync
+ */
+export function buildRsyncConnectionString({ host, directory, user }, { "sub-directory": subDirectory }) {
+    if (subDirectory) {
+        directory = path.join(directory, subDirectory).replace(/\/$/, "");
+    }
+    return `${user}@${host}:${directory}/`;
+}
 export function appInstallationSyncFlagsToRsyncFlags(f) {
     const { "dry-run": dryRun, "ssh-identity-file": sshIdentityFile, exclude, } = f;
     const rsyncOpts = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/cli",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Hand-crafted CLI for the mittwald API",
   "license": "MIT",
   "author": {
@@ -51,7 +51,7 @@
     "@oclif/plugin-warn-if-update-available": "^3.0.2",
     "axios-retry": "^4.0.0",
     "chalk": "^5.3.0",
-    "date-fns": "^3.2.0",
+    "date-fns": "^4.0.0",
     "ink": "^5.0.1",
     "ink-link": "^4.0.0",
     "ink-text-input": "^6.0.0",