@zuplo/cli 1.53.0 → 1.54.0

package/README.md

@@ -9,10 +9,20 @@ Commands:
   zup deploy    Deploys current Git branch of the current directory
   zup dev       Runs the zup locally
   zup list      Lists all deployed zups
+  zup link      Links information from your Zuplo account to your local machine
+  zup login     Authenticates the user
   zup test      Runs the tests under /tests against an endpoint
+  zup project   Project commands
   zup tunnel    Tunnel commands
   zup variable  Variable commands
 
+zup project
+
+Project commands
+
+Commands:
+  zup project update  Updates your project structure to the latest conventions
+
 zup tunnel
 
 Tunnel commands
@@ -33,7 +43,6 @@ Commands:
   zup tunnel services describe  Describes the services for this tunnel
   zup tunnel services update    Updates the services for this tunnel
 
-
 zup variable
 
 Variable commands

package/dist/cli.js

@@ -10,6 +10,7 @@ import dev from "./cmds/dev.js";
 import link from "./cmds/link.js";
 import list from "./cmds/list.js";
 import login from "./cmds/login.js";
+import project from "./cmds/project/index.js";
 import test from "./cmds/test.js";
 import tunnel from "./cmds/tunnel/index.js";
 import variable from "./cmds/variable/index.js";
@@ -26,6 +27,7 @@ if (gte(process.versions.node, MIN_NODE_VERSION)) {
         .command(link)
         .command(login)
         .command(test)
+        .command(project)
         .command(tunnel)
         .command(variable)
         .demandCommand()

package/dist/cmds/project/index.js

@@ -0,0 +1,12 @@
+import { groupHandler } from "../../common/handler.js";
+import update from "./update.js";
+const commands = {
+    describe: "Project commands",
+    command: "project",
+    builder: (yargs) => {
+        return yargs.command(update).help();
+    },
+    handler: groupHandler,
+};
+export default commands;
+//# sourceMappingURL=index.js.map

package/dist/cmds/project/update.js

@@ -0,0 +1,26 @@
+import setBlocking from "../../common/output.js";
+import { ZuploProjectValidator } from "../../common/validators/file-system-validator.js";
+import { YargsChecker } from "../../common/validators/lib.js";
+import { update } from "../../project/update/handler.js";
+export default {
+    desc: "Updates your project structure to the latest conventions",
+    command: "update",
+    builder: (yargs) => {
+        return yargs
+            .option("dir", {
+            type: "string",
+            describe: "The directory containing your zup",
+            default: ".",
+            normalize: true,
+            hidden: true,
+        })
+            .middleware([setBlocking])
+            .check(async (argv) => {
+            return await new YargsChecker(new ZuploProjectValidator()).check(argv);
+        });
+    },
+    handler: async (argv) => {
+        await update(argv);
+    },
+};
+//# sourceMappingURL=update.js.map

package/dist/common/upgraders/lib.js

@@ -0,0 +1,13 @@
+export class StandardUpgrader {
+    normalizedDir;
+    constructor(normalizedDir) {
+        this.normalizedDir = normalizedDir;
+    }
+}
+export class VsCodeFolderMissing extends Error {
+    constructor() {
+        super("Missing .vscode folder: The current directory does not contain a .vscode folder.");
+        Object.setPrototypeOf(this, VsCodeFolderMissing.prototype);
+    }
+}
+//# sourceMappingURL=lib.js.map

package/dist/common/upgraders/package-json-upgrader.js

@@ -0,0 +1,54 @@
+import { readFile, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import prettier from "prettier";
+import { StandardUpgrader } from "./lib.js";
+export class FailedToParsePackageJson extends Error {
+    constructor() {
+        super("Invalid package.json: Failed to parse the package.json file.");
+        Object.setPrototypeOf(this, FailedToParsePackageJson.prototype);
+    }
+}
+export class PackageJsonUpgrader extends StandardUpgrader {
+    async isApplicable() {
+        try {
+            const rawPackage = await readFile(join(this.normalizedDir, "package.json"), "utf-8");
+            const packageJson = JSON.parse(rawPackage);
+            return { ok: true };
+        }
+        catch (err) {
+            return { ok: false, error: new FailedToParsePackageJson() };
+        }
+    }
+    async upgrade() {
+        const packageJsonFile = join(this.normalizedDir, "package.json");
+        const rawPackage = await readFile(packageJsonFile, "utf-8");
+        const packageJson = JSON.parse(rawPackage);
+        packageJson.scripts.dev = "zup dev";
+        delete packageJson.scripts.build;
+        if ((packageJson.scripts.test && packageJson.scripts.test === "zup test") ||
+            packageJson.scripts.test === "zuplo test") {
+            delete packageJson.scripts.test;
+        }
+        if (packageJson.scripts.postinstall &&
+            packageJson.scripts.postinstall === "husky install") {
+            delete packageJson.scripts.postinstall;
+        }
+        if (packageJson.dependencies["@zuplo/runtime"]) {
+            delete packageJson.dependencies["@zuplo/runtime"];
+        }
+        if (packageJson.dependencies["@zuplo/core"]) {
+            delete packageJson.dependencies["@zuplo/core"];
+        }
+        packageJson.dependencies["zuplo"] = "latest";
+        delete packageJson.devDependencies["@zuplo/test"];
+        delete packageJson.devDependencies["husky"];
+        delete packageJson.devDependencies["chai"];
+        delete packageJson.devDependencies["@types/chai"];
+        const formatted = prettier.format(JSON.stringify(packageJson), {
+            parser: "json-stringify",
+            quoteProps: "as-needed",
+        });
+        await writeFile(packageJsonFile, formatted);
+    }
+}
+//# sourceMappingURL=package-json-upgrader.js.map

package/dist/common/upgraders/vscode-settings-json-upgrader.js

@@ -0,0 +1,93 @@
+import { parse } from "jsonc-parser";
+import { existsSync } from "node:fs";
+import { readFile, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import prettier from "prettier";
+import { StandardUpgrader, VsCodeFolderMissing } from "./lib.js";
+const zuploSchemas = [
+    {
+        fileMatch: ["config/*.oas.json"],
+        url: "https://cdn.zuplo.com/schemas/openapi-v3.1-zuplo.json",
+    },
+    {
+        fileMatch: ["config/policies.json"],
+        url: "https://cdn.zuplo.com/schemas/policies.json",
+    },
+    {
+        fileMatch: ["config/routes.json"],
+        url: "https://cdn.zuplo.com/schemas/routes.json",
+    },
+    {
+        fileMatch: ["config/dev-portal.json"],
+        url: "https://cdn.zuplo.com/schemas/dev-portal.json",
+    },
+    {
+        fileMatch: ["docs/sidebar.json"],
+        url: "https://cdn.zuplo.com/schemas/sidebar.json",
+    },
+];
+export class VsCodeSettingsJsonUpgrader extends StandardUpgrader {
+    async isApplicable() {
+        const vsCodeFolder = join(this.normalizedDir, ".vscode");
+        if (existsSync(vsCodeFolder)) {
+            return { ok: true };
+        }
+        else {
+            return { ok: false, error: new VsCodeFolderMissing() };
+        }
+    }
+    async upgrade() {
+        const vsCodeSettingsFile = join(this.normalizedDir, ".vscode", "settings.json");
+        if (!existsSync(vsCodeSettingsFile)) {
+            const content = `
+{
+"json.schemas": [
+    {
+    "fileMatch": ["config/*.oas.json"],
+    "url": "https://cdn.zuplo.com/schemas/openapi-v3.1-zuplo.json"
+    },
+    {
+    "fileMatch": ["config/policies.json"],
+    "url": "https://cdn.zuplo.com/schemas/policies.json"
+    },
+    {
+    "fileMatch": ["config/routes.json"],
+    "url": "https://cdn.zuplo.com/schemas/routes.json"
+    },
+    {
+    "fileMatch": ["config/dev-portal.json"],
+    "url": "https://cdn.zuplo.com/schemas/dev-portal.json"
+    },
+    {
+    "fileMatch": ["docs/sidebar.json"],
+    "url": "https://cdn.zuplo.com/schemas/sidebar.json"
+    }
+]
+}`;
+            const formatted = prettier.format(content, {
+                parser: "json",
+                quoteProps: "as-needed",
+            });
+            await writeFile(vsCodeSettingsFile, formatted);
+        }
+        else {
+            const settingsRaw = await readFile(vsCodeSettingsFile, "utf-8");
+            const settingsJson = parse(settingsRaw, [], {});
+            for (const schema of zuploSchemas) {
+                const existingSchema = settingsJson["json.schemas"].find((s) => s.fileMatch[0] === schema.fileMatch[0]);
+                if (existingSchema) {
+                    existingSchema.url = schema.url;
+                }
+                else {
+                    settingsJson["json.schemas"].push(schema);
+                }
+            }
+            const formatted = prettier.format(JSON.stringify(settingsJson), {
+                parser: "json",
+                quoteProps: "as-needed",
+            });
+            await writeFile(vsCodeSettingsFile, formatted);
+        }
+    }
+}
+//# sourceMappingURL=vscode-settings-json-upgrader.js.map

package/dist/common/validators/login-state-validator.js

@@ -7,7 +7,7 @@ import settings from "../settings.js";
 import { ZUPLO_XDG_STATE_HOME } from "../xdg/lib.js";
 export class UserIsNotLoggedIn extends Error {
     constructor() {
-        super(`You are not logged in (or your credentials have expired). Please run \`zuplo login\` to log in.`);
+        super(`You are not logged in (or your credentials have expired). Please run \`zup login\` to log in.`);
         Object.setPrototypeOf(this, UserIsNotLoggedIn.prototype);
     }
 }

package/dist/link/populate.js

@@ -20,7 +20,7 @@ export async function safeMergeConfig(dir, options) {
         const contentsPostProject = applyEdits(contentsPostAccount, modifyProjectEdit);
         const formatted = prettier.format(contentsPostProject, {
             parser: "json",
-            quoteProps: "preserve",
+            quoteProps: "as-needed",
         });
         await writeFile(zuploPreferredConfigFile, formatted);
     }
@@ -33,7 +33,7 @@ export async function safeMergeConfig(dir, options) {
             compatibilityDate: config.compatibilityDate,
         }), {
             parser: "json",
-            quoteProps: "preserve",
+            quoteProps: "as-needed",
         });
         await writeFile(zuploPreferredConfigFile, formatted);
     }
@@ -45,7 +45,7 @@ export async function safeMergeConfig(dir, options) {
             compatibilityDate: "2023-03-14",
         }), {
             parser: "json",
-            quoteProps: "preserve",
+            quoteProps: "as-needed",
         });
         await writeFile(zuploPreferredConfigFile, formatted);
     }

package/dist/project/update/handler.js

@@ -0,0 +1,26 @@
+import { confirm } from "@inquirer/prompts";
+import { printDiagnosticsToConsole, printResultToConsoleAndExitGracefully, } from "../../common/output.js";
+import { PackageJsonUpgrader } from "../../common/upgraders/package-json-upgrader.js";
+import { VsCodeSettingsJsonUpgrader } from "../../common/upgraders/vscode-settings-json-upgrader.js";
+export async function update(argv) {
+    printDiagnosticsToConsole("This command will make changes to your source code. Please commit your changes to version control before continuing.");
+    const answer = await confirm({ message: "Continue?", default: true });
+    if (answer) {
+        const u = new PackageJsonUpgrader(argv.dir);
+        if ((await u.isApplicable()).ok) {
+            printDiagnosticsToConsole("Updating your package.json...");
+            await u.upgrade();
+        }
+        else {
+        }
+        const v = new VsCodeSettingsJsonUpgrader(argv.dir);
+        if ((await v.isApplicable()).ok) {
+            printDiagnosticsToConsole("Updating your .vsode settings...");
+            await v.upgrade();
+        }
+        else {
+        }
+        printResultToConsoleAndExitGracefully("Update completed");
+    }
+}
+//# sourceMappingURL=handler.js.map

package/package.json

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