@zuplo/cli 1.11.0 → 1.13.0

package/README.md

@@ -1 +1,12 @@
 # Zuplo CLI
+
+```
+zup <command>
+
+Commands:
+  zup deploy  Deploys current Git branch of the current directory.
+  zup test    Runs the tests under /tests against an endpoint
+
+Options:
+  --help  Show help                                                    [boolean]
+```

package/dist/cmds/deploy.js

@@ -3,15 +3,15 @@ import { YargsChecker } from "../common/validators/lib.js";
 import { deploy } from "../deploy/handler.js";
 export default {
     desc: "Deploys current Git branch of the current directory.",
-    command: "deploy [--apiKey]",
+    command: "deploy",
     builder: (yargs) => {
         return yargs
-            .option("apiKey", {
+            .option("api-key", {
             type: "string",
             describe: "The API Key from Zuplo",
             envVar: "API_KEY",
         })
-            .demandOption(["apiKey"])
+            .demandOption(["api-key"])
             .option("dir", {
             type: "string",
             describe: "The directory containing your zup",

package/dist/cmds/test.js

@@ -2,11 +2,11 @@ import { validTestDirectoryValidator } from "../common/validators/file-system-va
 import { YargsChecker } from "../common/validators/lib.js";
 import { test } from "../test/handler.js";
 export default {
-    desc: "Runs the tests under /tests against the [endpoint]",
-    command: "test [endpoint]",
+    desc: "Runs the tests under /tests against an endpoint",
+    command: "test",
     builder: (yargs) => {
         return yargs
-            .positional("endpoint", {
+            .option("endpoint", {
             type: "string",
             describe: "The URL of the zup to test against",
         })

package/dist/common/output.js

@@ -1,7 +1,12 @@
-export function logDiagnosticsToConsole(message, ...optionalParams) {
-    console.error(message, ...optionalParams);
+import chalk from "chalk";
+export function printDiagnosticsToConsole(message) {
+    console.error(chalk.bold.blue(message));
 }
-export function outputResultToConsole(message, ...optionalParams) {
-    console.log(message, ...optionalParams);
+export function printCriticalFailureToConsoleAndExit(message) {
+    console.error(chalk.bold.red(message));
+    process.exit(1);
+}
+export function printResultToConsole(message) {
+    console.log(chalk.bold.green(message));
 }
 //# sourceMappingURL=output.js.map

package/dist/common/settings.js

@@ -3,7 +3,7 @@ class Settings {
         return process.env.ZUPLO_DEVELOPER_API_ENDPOINT ?? "https://dev.zuplo.com";
     }
     get MAX_POLL_RETRIES() {
-        return parseInt(process.env.MAX_POLL_RETRIES ?? "30");
+        return parseInt(process.env.MAX_POLL_RETRIES ?? "60");
     }
     get POLL_INTERVAL() {
         return parseInt(process.env.POLL_INTERVAL ?? "1000");

package/dist/common/validators/file-system-validator.js

@@ -21,6 +21,24 @@ export class ZuploProjectMissingTests extends Error {
         Object.setPrototypeOf(this, ZuploProjectMissingTests.prototype);
     }
 }
+export class NoGitCommits extends Error {
+    constructor() {
+        super("Invalid Git state: The current directory does not contain any commits. Make a commit before deploying.");
+        Object.setPrototypeOf(this, NoGitCommits.prototype);
+    }
+}
+export class NotOnAGitBranch extends Error {
+    constructor() {
+        super("Invalid Git state: You are not on a branch. Run `git checkout -b <branch-name>` to create a new branch.");
+        Object.setPrototypeOf(this, NotOnAGitBranch.prototype);
+    }
+}
+export class MissingGitRemote extends Error {
+    constructor() {
+        super("Invalid Git state: You do not have a remote origin configured. Run `git remote add origin <url>` to add the url of Git repository matching your project on Zuplo.");
+        Object.setPrototypeOf(this, MissingGitRemote.prototype);
+    }
+}
 export class GitVersionControlValidator {
     async validate(dir) {
         try {
@@ -35,6 +53,54 @@ export class GitVersionControlValidator {
         }
     }
 }
+export class GitCommitValidator {
+    async validate(dir) {
+        try {
+            const git = simpleGit({ baseDir: dir });
+            const commits = await git.log({ maxCount: 1 });
+            if (commits.total === 0) {
+                return {
+                    ok: false,
+                    error: new NoGitCommits(),
+                };
+            }
+            return { ok: true };
+        }
+        catch (err) {
+            return {
+                ok: false,
+                error: new NoGitCommits(),
+            };
+        }
+    }
+}
+export class GitBranchValidator {
+    async validate(dir) {
+        const git = simpleGit({ baseDir: dir });
+        const branch = await git.branch();
+        if (!branch.current) {
+            return {
+                ok: false,
+                error: new NotOnAGitBranch(),
+            };
+        }
+        return { ok: true };
+    }
+}
+export class GitRemoteValidator {
+    async validate(dir) {
+        const git = simpleGit({ baseDir: dir });
+        const remotes = await git.getRemotes(true);
+        const origin = remotes.find((r) => r.name === "origin");
+        if (!origin) {
+            return {
+                ok: false,
+                error: new MissingGitRemote(),
+            };
+        }
+        return { ok: true };
+    }
+}
 export class ZuploProjectValidator {
     async validate(dir) {
         try {
@@ -77,6 +143,6 @@ export class ZuploProjectHasTestsValidator {
         }
     }
 }
-export const validDeployDirectoryValidator = new CompositeValidator(new GitVersionControlValidator(), new ZuploProjectValidator());
+export const validDeployDirectoryValidator = new CompositeValidator(new ZuploProjectValidator(), new GitVersionControlValidator(), new GitCommitValidator(), new GitBranchValidator(), new GitRemoteValidator());
 export const validTestDirectoryValidator = new CompositeValidator(new ZuploProjectValidator(), new ZuploProjectHasTestsValidator());
 //# sourceMappingURL=file-system-validator.js.map

package/dist/deploy/handler.js

@@ -1,7 +1,6 @@
-import chalk from "chalk";
 import { parse } from "path";
 import { logger } from "../common/logger.js";
-import { logDiagnosticsToConsole, outputResultToConsole, } from "../common/output.js";
+import { printCriticalFailureToConsoleAndExit, printDiagnosticsToConsole, printResultToConsole, } from "../common/output.js";
 import settings from "../common/settings.js";
 import { archive, ARCHIVE_EXTENSION } from "./archive.js";
 import { upload } from "./file-upload.js";
@@ -12,7 +11,7 @@ export async function deploy(argv) {
     const whoAmIResponse = await fetch(`${settings.ZUPLO_DEVELOPER_API_ENDPOINT}/v1/who-am-i`, {
         method: "GET",
         headers: {
-            Authorization: `Bearer ${argv.apiKey}`,
+            Authorization: `Bearer ${argv["api-key"]}`,
         },
     });
     if (whoAmIResponse.ok) {
@@ -20,21 +19,21 @@ export async function deploy(argv) {
         const uploadUrlResponse = await fetch(`${settings.ZUPLO_DEVELOPER_API_ENDPOINT}/v1/accounts/${account}/projects/${project}/sources`, {
             method: "POST",
             headers: {
-                Authorization: `Bearer ${argv.apiKey}`,
+                Authorization: `Bearer ${argv["api-key"]}`,
             },
         });
         if (uploadUrlResponse.ok) {
             const { uploadUrl } = await uploadUrlResponse.json();
             const uploadResponse = await upload(archiveMetadata.tarball, uploadUrl);
             if (uploadResponse.ok) {
-                logDiagnosticsToConsole(chalk.green.bold(`Deploying the current branch ${archiveMetadata.metadata.branch} to project ${project} on account ${account}...`));
+                printDiagnosticsToConsole(`Deploying the current branch ${archiveMetadata.metadata.branch} to project ${project} on account ${account}...`);
                 const fileId = parse(new URL(uploadUrl).pathname).base.replace(ARCHIVE_EXTENSION, "");
                 const { url } = await pollDeployment(argv, fileId, account, project);
                 if (url) {
-                    outputResultToConsole(chalk.green.bold(`Deployed to ${url}`));
+                    printResultToConsole(`Deployed to ${url}`);
                 }
                 else {
-                    logDiagnosticsToConsole(`Failed to deploy the current branch ${archiveMetadata.metadata.branch} to project ${project} on account ${account}`);
+                    printCriticalFailureToConsoleAndExit(`Failed to deploy the current branch ${archiveMetadata.metadata.branch} to project ${project} on account ${account}.`);
                 }
             }
             else {
@@ -42,7 +41,7 @@ export async function deploy(argv) {
                     status: uploadResponse.status,
                     statusText: uploadResponse.statusText,
                 }, "Failed to upload source to cloud storage");
-                process.exit(1);
+                printDiagnosticsToConsole("Error: Failed to upload source to cloud storage. Try again later.");
             }
         }
         else {
@@ -50,12 +49,12 @@ export async function deploy(argv) {
                 status: uploadUrlResponse.status,
                 statusText: uploadUrlResponse.statusText,
             }, "Failed to retrieve uploadUrl");
-            process.exit(1);
+            printDiagnosticsToConsole("Error: Failed to determine where to upload your files. Try again later.");
         }
     }
     else {
         logger.error({ status: whoAmIResponse.status, statusText: whoAmIResponse.statusText }, "Failed to determine who-am-i");
-        process.exit(1);
+        printDiagnosticsToConsole("Error: Failed to validate the API key. Check your API key.");
     }
 }
 //# sourceMappingURL=handler.js.map

package/dist/deploy/poll-deployment.js

@@ -1,16 +1,15 @@
-import chalk from "chalk";
-import { logDiagnosticsToConsole } from "../common/output.js";
+import { printDiagnosticsToConsole } from "../common/output.js";
 import settings from "../common/settings.js";
 function wait(duration = settings.POLL_INTERVAL) {
     return new Promise((resolve) => setTimeout(resolve, duration));
 }
 export async function pollDeployment(argv, fileId, account, project) {
     for (let pollRetry = 0; pollRetry < settings.MAX_POLL_RETRIES; pollRetry++) {
-        logDiagnosticsToConsole(chalk.yellow(`Polling for deployment status... (${pollRetry}/${settings.MAX_POLL_RETRIES})`));
+        printDiagnosticsToConsole(`Polling for deployment status... (${pollRetry}/${settings.MAX_POLL_RETRIES})`);
         const response = await fetch(`${settings.ZUPLO_DEVELOPER_API_ENDPOINT}/v1/accounts/${account}/projects/${project}/deployment-status/${fileId}`, {
             method: "GET",
             headers: {
-                Authorization: `Bearer ${argv.apiKey}`,
+                Authorization: `Bearer ${argv["api-key"]}`,
             },
         });
         if (response.ok) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zuplo/cli",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "type": "module",
   "repository": "https://github.com/zuplo/cli",
   "author": "Zuplo, Inc.",