@webiny/cli 6.0.0-alpha.5 → 6.0.0-rc.0

package/index.js

@@ -1,5 +1,3 @@
-const context = require("./context");
-const regions = require("./regions");
+import { GracefulError } from "@webiny/cli-core";
 
-module.exports.cli = context;
-module.exports.regions = regions;
+export { GracefulError };

package/package.json

@@ -1,70 +1,30 @@
 {
 	"name": "@webiny/cli",
-	"version": "6.0.0-alpha.5",
+	"version": "6.0.0-rc.0",
+	"type": "module",
 	"main": "index.js",
-	"bin": {
-		"webiny": "./bin.js"
-	},
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/webiny/webiny-js.git",
-		"directory": "packages/cli"
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"bin": {
+		"webiny": "./bin.js"
 	},
-	"author": "Pavel Denisjuk <pavel@webiny.com>",
-	"description": "A tool to bootstrap a Webiny project.",
+	"description": "A command line interface (CLI) for managing Webiny projects.",
+	"license": "MIT",
 	"dependencies": {
-		"@webiny/system-requirements": "6.0.0-alpha.5",
-		"@webiny/telemetry": "6.0.0-alpha.5",
-		"@webiny/wcp": "6.0.0-alpha.5",
-		"boolean": "3.2.0",
-		"camelcase": "6.3.0",
-		"chalk": "4.1.2",
-		"ci-info": "4.2.0",
-		"dotenv": "8.6.0",
+		"@webiny/cli-core": "6.0.0-rc.0",
+		"@webiny/system-requirements": "6.0.0-rc.0",
 		"execa": "5.1.1",
-		"fast-glob": "3.2.12",
-		"find-up": "5.0.0",
-		"fs-extra": "11.2.0",
-		"graphql-request": "3.7.0",
-		"inquirer": "8.2.6",
-		"ncp": "2.0.0",
-		"open": "8.4.2",
-		"pirates": "4.0.6",
-		"semver": "7.6.3",
-		"ts-morph": "11.0.3",
-		"typescript": "5.3.3",
-		"uniqid": "5.4.0",
-		"yargs": "17.7.2"
+		"tsx": "4.21.0"
+	},
+	"devDependencies": {
+		"@types/lodash": "4.17.23",
+		"@webiny/build-tools": "6.0.0-rc.0"
 	},
-	"license": "MIT",
 	"publishConfig": {
 		"access": "public",
 		"directory": "."
 	},
-	"adio": {
-		"ignoreDirs": [
-			"/create/template/",
-			"/node_modules/",
-			"/dist/"
-		],
-		"ignore": {
-			"src": [
-				"@webiny/project-utils",
-				"@webiny/api-file-manager",
-				"@webiny/cli-plugin-deploy-pulumi",
-				"@webiny/api",
-				"@webiny/handler-client",
-				"@webiny/api-elasticsearch",
-				"@webiny/api-tenancy",
-				"@webiny/api-security",
-				"@webiny/api-i18n",
-				"@webiny/api-i18n-content",
-				"@webiny/api-page-builder",
-				"@webiny/api-prerendering-service",
-				"@webiny/api-form-builder",
-				"@webiny/api-headless-cms"
-			]
-		}
-	},
-	"gitHead": "b7e120541b093e91f214904a9f13e4c2c4640978"
+	"gitHead": "0f2aa699f4642e550ab62c96fcd050e8d02345c9"
 }

package/commands/about/getDatabaseSetup.js

@@ -1,45 +0,0 @@
-const { getProject } = require("@webiny/cli/utils");
-const path = require("path");
-const fs = require("fs");
-
-const DATABASE_SETUPS = {
-    DDB: "ddb",
-    DDB_ES: "ddb-es",
-    DDB_OS: "ddb-os"
-};
-
-const DATABASE_SETUPS_LABELS = {
-    [DATABASE_SETUPS.DDB]: "Amazon DynamoDB",
-    [DATABASE_SETUPS.DDB_ES]: "Amazon DynamoDB + Amazon Elasticsearch Service",
-    [DATABASE_SETUPS.DDB_OS]: "Amazon DynamoDB + Amazon OpenSearch Service"
-};
-
-// In order to get the database setup, we check for existence of `elasticSearch`
-//  or `openSearch` strings within the `apps/core/webiny.application.ts` file.
-const getDatabaseSetup = () => {
-    const project = getProject();
-    const webinyAppTsPath = path.join(project.root, "apps", "core", "webiny.application.ts");
-
-    const webinyAppTs = fs.readFileSync(webinyAppTsPath, "utf8");
-    if (webinyAppTs.includes("elasticSearch")) {
-        return "ddb-es";
-    }
-
-    if (webinyAppTs.includes("openSearch")) {
-        return "ddb-os";
-    }
-
-    return "ddb";
-};
-
-const getDatabaseSetupLabel = () => {
-    const setup = getDatabaseSetup();
-    return DATABASE_SETUPS_LABELS[setup];
-};
-
-module.exports = {
-    getDatabaseSetup,
-    getDatabaseSetupLabel,
-    DATABASE_SETUPS,
-    DATABASE_SETUPS_LABELS
-};

package/commands/about/getNpmVersion.js

@@ -1,5 +0,0 @@
-const { SystemRequirements } = require("@webiny/system-requirements");
-
-module.exports.getNpmVersion = async () => {
-    return SystemRequirements.getNpmVersion();
-};

package/commands/about/getNpxVersion.js

@@ -1,5 +0,0 @@
-const { SystemRequirements } = require("@webiny/system-requirements");
-
-module.exports.getNpxVersion = async () => {
-    return SystemRequirements.getNpxVersion();
-};

package/commands/about/getPulumiVersions.js

@@ -1,43 +0,0 @@
-const execa = require("execa");
-
-module.exports.getPulumiVersions = async () => {
-    let pulumi, pulumiAws;
-
-    try {
-        {
-            const { stdout } = await execa("yarn", [
-                "info",
-                "@pulumi/pulumi",
-                "-A",
-                "-R",
-                "--name-only",
-                "--json"
-            ]);
-
-            const match = stdout.match(/npm:(.*?)"/);
-            if (match) {
-                pulumi = match[1];
-            }
-        }
-
-        {
-            const { stdout } = await execa("yarn", [
-                "info",
-                "@pulumi/aws",
-                "-A",
-                "-R",
-                "--name-only",
-                "--json"
-            ]);
-
-            const match = stdout.match(/npm:(.*?)"/);
-            if (match) {
-                pulumiAws = match[1];
-            }
-        }
-    } catch (err) {
-        return "";
-    }
-
-    return [pulumi, pulumiAws];
-};

package/commands/about/getYarnVersion.js

@@ -1,5 +0,0 @@
-const { SystemRequirements } = require("@webiny/system-requirements");
-
-module.exports.getYarnVersion = async () => {
-    return SystemRequirements.getYarnVersion();
-};

package/commands/about/index.js

@@ -1,97 +0,0 @@
-const NO_VALUE = "-";
-const { isCI } = require("ci-info");
-
-const getData = async context => {
-    const { getUser } = require("../wcp/utils");
-    const { getNpxVersion } = require("./getNpxVersion");
-    const { getNpmVersion } = require("./getNpmVersion");
-    const { getPulumiVersions } = require("./getPulumiVersions");
-    const { getYarnVersion } = require("./getYarnVersion");
-    const { getDatabaseSetupLabel } = require("./getDatabaseSetup");
-
-    const [pulumiVersion, pulumiAwsVersion] = await getPulumiVersions();
-
-    const wcpProjectId = process.env.WCP_PROJECT_ID;
-    const wcpUser = await getUser().catch(() => null);
-    const wcpUsingProjectEnvironmentApiKey = Boolean(process.env.WCP_ENVIRONMENT_API_KEY);
-
-    return [
-        {
-            sectionName: "Webiny Project",
-            data: {
-                Name: context.project.name,
-                Version: context.version,
-                "Database Setup": getDatabaseSetupLabel(),
-                "Debug Enabled": process.env.DEBUG === "true" ? "Yes" : "No",
-                "Feature Flags": process.env.WEBINY_FEATURE_FLAGS || "N/A"
-            }
-        },
-        {
-            sectionName: "Webiny Control Panel (WCP)",
-            data: {
-                "Project ID": wcpProjectId,
-                User: wcpUser?.email || "N/A",
-                "Using Project Environment API Key": wcpUsingProjectEnvironmentApiKey ? "Yes" : "No"
-            }
-        },
-        {
-            sectionName: "Host",
-            data: {
-                OS: `${process.platform} (${process.arch})`,
-                "Node.js": process.version,
-                NPM: await getNpmVersion(),
-                NPX: await getNpxVersion(),
-                Yarn: await getYarnVersion(),
-                "Is CI": isCI ? "Yes" : "No"
-            }
-        },
-        {
-            sectionName: "Pulumi",
-            data: {
-                "@pulumi/pulumi": pulumiVersion,
-                "@pulumi/aws": pulumiAwsVersion,
-                "Secrets Provider": process.env.PULUMI_SECRETS_PROVIDER,
-                "Using Password": process.env.PULUMI_CONFIG_PASSPHRASE ? "Yes" : "No"
-            }
-        }
-    ];
-};
-
-module.exports = {
-    type: "cli-command",
-    name: "cli-command-about",
-    create({ yargs, context }) {
-        yargs.command(
-            "about",
-            `Prints out information helpful for debugging purposes.`,
-            yargs => {
-                yargs.option("json", {
-                    describe: "Emit output as JSON.",
-                    type: "boolean",
-                    default: false
-                });
-            },
-            async yargs => {
-                const data = await getData(context);
-
-                if (yargs.json) {
-                    console.log(JSON.stringify(data, null, 2));
-                    return;
-                }
-
-                data.forEach(({ sectionName, data }, index) => {
-                    if (index > 0) {
-                        console.log();
-                    }
-
-                    const { bold } = require("chalk");
-                    console.log(bold(sectionName));
-
-                    Object.keys(data).forEach(key => {
-                        console.log(key.padEnd(36), data[key] || NO_VALUE);
-                    });
-                });
-            }
-        );
-    }
-};

package/commands/index.js

@@ -1,21 +0,0 @@
-const about = require("./about");
-const run = require("./run");
-const telemetry = require("./telemetry");
-const upgrade = require("./upgrade");
-
-module.exports.createCommands = async (yargs, context) => {
-    context.plugins.register(about, run, telemetry, upgrade);
-
-    try {
-        const wcp = require("./wcp");
-        context.plugins.register(wcp);
-    } catch {
-        // Skip WCP command
-    }
-
-    await context.loadUserPlugins();
-
-    context.plugins.byType("cli-command").forEach(plugin => {
-        plugin.create({ yargs, context });
-    });
-};

package/commands/run/index.js

@@ -1,38 +0,0 @@
-module.exports = {
-    type: "cli-command",
-    name: "cli-command-run",
-    create({ yargs, context }) {
-        yargs.command(
-            "run <command> [options]",
-            `Run command defined in webiny.config.{js,ts}.\nNote: run from folder containing webiny.config.{js,ts} file.`,
-            yargs => {
-                yargs.positional("command", {
-                    describe: `Command to run in webiny.config.{js,ts}`,
-                    type: "string"
-                });
-            },
-            async argv => {
-                const camelCase = require("camelcase");
-                const findUp = require("find-up");
-                const path = require("path");
-
-                const configFile = findUp.sync(["webiny.config.ts", "webiny.config.js"]);
-                let config = context.import(configFile);
-
-                const command = camelCase(argv.command);
-                if (typeof config === "function") {
-                    config = config({
-                        options: { ...argv, cwd: path.dirname(configFile) },
-                        context
-                    });
-                }
-
-                if (config.commands && typeof config.commands[command] === "function") {
-                    return await config.commands[command]({ ...argv }, context);
-                }
-
-                throw Error(`Command "${command}" is not defined in "${configFile}"!`);
-            }
-        );
-    }
-};

package/commands/telemetry/index.js

@@ -1,31 +0,0 @@
-module.exports = {
-    type: "cli-command",
-    name: "cli-command-telemetry",
-    create({ yargs, context }) {
-        yargs.command("enable-telemetry", "Enable anonymous telemetry.", async () => {
-            const telemetry = require("@webiny/telemetry/cli");
-
-            telemetry.enable();
-            await telemetry.sendEvent({ event: "enable-telemetry" });
-            context.info(
-                `Webiny telemetry is now %s! Thank you for helping us in making Webiny better!`,
-                "enabled"
-            );
-            context.info(
-                `For more information, please visit the following link: https://www.webiny.com/telemetry.`
-            );
-        });
-
-        yargs.command("disable-telemetry", "Disable anonymous telemetry.", async () => {
-            const telemetry = require("@webiny/telemetry/cli");
-
-            await telemetry.sendEvent({ event: "disable-telemetry" });
-            telemetry.disable();
-            context.info(`Webiny telemetry is now %s!`, "disabled");
-            context.info(
-                `Note that, in order to complete the process, you will also need to re-deploy your project, using the %s command.`,
-                "yarn webiny deploy"
-            );
-        });
-    }
-};

package/commands/upgrade/index.js

@@ -1,108 +0,0 @@
-module.exports = [
-    {
-        type: "cli-command",
-        name: "cli-command-upgrade",
-        create({ yargs, context }) {
-            yargs.example("$0 upgrade");
-            yargs.command(
-                "upgrade",
-                `Run an upgrade script for currently installed version of Webiny`,
-                yargs => {
-                    yargs.option("skip-checks", {
-                        describe: "Do not perform CLI version and Git tree checks.",
-                        type: "boolean",
-                        default: false
-                    });
-                    yargs.option("debug", {
-                        default: false,
-                        describe: `Turn on debug logs`,
-                        type: "boolean"
-                    });
-                    yargs.option("use-version", {
-                        describe:
-                            "Use upgrade script for a specific version. Should only be used for development/testing purposes.",
-                        type: "string"
-                    });
-                },
-                async argv => {
-                    const { red } = require("chalk");
-                    const execa = require("execa");
-                    const semver = require("semver");
-
-                    if (!argv.skipChecks) {
-                        // Before doing any upgrading, there must not be any active changes in the current branch.
-                        let gitStatus = "";
-                        try {
-                            let { stdout } = execa.sync("git", ["status", "--porcelain"]);
-                            gitStatus = stdout.trim();
-                        } catch {}
-
-                        if (gitStatus) {
-                            console.error(
-                                red(
-                                    "This git repository has untracked files or uncommitted changes:"
-                                ) +
-                                    "\n\n" +
-                                    gitStatus
-                                        .split("\n")
-                                        .map(line => line.match(/ .*/g)[0].trim())
-                                        .join("\n") +
-                                    "\n\n" +
-                                    red(
-                                        "Remove untracked files, stash or commit any changes, and try again."
-                                    )
-                            );
-                            process.exit(1);
-                        }
-                    }
-
-                    const defaultUpgradeTargetVersion = semver.coerce(context.version).version;
-
-                    const command = [
-                        "https://github.com/webiny/webiny-upgrades",
-                        argv.useVersion || defaultUpgradeTargetVersion
-                    ];
-
-                    if (yargs.argv.debug) {
-                        context.debug("npx", ...command);
-                    }
-
-                    const npx = execa("npx", command, {
-                        env: {
-                            FORCE_COLOR: true
-                        },
-                        stdin: process.stdin
-                    });
-
-                    npx.stdout.on("data", data => {
-                        const lines = data.toString().replace(/\n$/, "").split("\n");
-                        for (let i = 0; i < lines.length; i++) {
-                            const line = lines[i];
-                            try {
-                                const json = JSON.parse(line);
-                                if (json.type === "error") {
-                                    context.error(
-                                        "An error occurred while performing the upgrade."
-                                    );
-                                    console.log(json.message);
-                                    if (yargs.argv.debug) {
-                                        context.debug(json.data.stack);
-                                    }
-                                }
-                            } catch {
-                                // Not JSON, let's just print the line then.
-                                console.log(line);
-                            }
-                        }
-                    });
-
-                    npx.stderr.on("data", data => {
-                        console.log(data.toString());
-                    });
-
-                    await npx;
-                }
-            );
-        }
-    }
-];

package/commands/wcp/hooks.js

@@ -1,133 +0,0 @@
-const { encrypt, decrypt } = require("@webiny/wcp");
-const { getUser, getProjectEnvironment, updateUserLastActiveOn } = require("./utils");
-
-/**
- * The two environment variables we set via these hooks are the following:
- * - WCP_PROJECT_ENVIRONMENT - contains encrypted data about the deployed project environment
- * - WCP_PROJECT_ENVIRONMENT_API_KEY - for easier access, we also set the API key
- */
-
-/**
- * There are multiple ways the hooks below prepare the WCP-enabled project for deployment.
- * 1. If `WCP_PROJECT_ENVIRONMENT` metadata env var is defined, we decrypt it, retrieve the
- *    API key from it, and assign it as the `WCP_PROJECT_ENVIRONMENT_API_KEY` env var.
- * 2. If `WCP_PROJECT_ENVIRONMENT_API_KEY` env var is defined, then we use that as the
- *    project environment API key. We use that to load the project environment data
- *    and to also assign the `WCP_PROJECT_ENVIRONMENT` metadata env var.
- * 3. If none of the above is defined, we retrieve (or create) the project environment,
- *    retrieve its API key and again assign it as `WCP_PROJECT_ENVIRONMENT_API_KEY` env var.
- *    As in 2), we also assign the `WCP_PROJECT_ENVIRONMENT` metadata env var.
- */
-
-let projectEnvironment;
-
-const getEnvironmentHookHandler = async (args, context) => {
-    // If the project isn't linked with WCP, do nothing.
-    const wcpProjectId = context.project.config.id || process.env.WCP_PROJECT_ID;
-    if (!wcpProjectId) {
-        return;
-    }
-
-    // For development purposes, we allow setting the WCP_PROJECT_ENVIRONMENT env var directly.
-    if (process.env.WCP_PROJECT_ENVIRONMENT) {
-        // If we have WCP_PROJECT_ENVIRONMENT env var, we set the WCP_PROJECT_ENVIRONMENT_API_KEY too.
-        const decryptedProjectEnvironment = decrypt(process.env.WCP_PROJECT_ENVIRONMENT);
-        process.env.WCP_PROJECT_ENVIRONMENT_API_KEY = decryptedProjectEnvironment.apiKey;
-        return;
-    }
-
-    // The `id` has the orgId/projectId structure, for example `my-org-x/my-project-y`.
-    const [orgId, projectId] = wcpProjectId.split("/");
-
-    const apiKey = process.env.WCP_PROJECT_ENVIRONMENT_API_KEY;
-
-    let projectEnvironment;
-    if (apiKey) {
-        projectEnvironment = await getProjectEnvironment({ apiKey });
-    } else {
-        const isValidId = orgId && projectId;
-        if (!isValidId) {
-            throw new Error(
-                `It seems the project ID, specified in "webiny.project.ts" file, is invalid.`
-            );
-        }
-
-        // If there is no API key, that means we need to retrieve the currently logged-in user.
-        const user = await getUser();
-        const project = user.projects.find(item => item.id === projectId);
-        if (!project) {
-            throw new Error(
-                `It seems you don't belong to the current project or the current project has been deleted.`
-            );
-        }
-
-        projectEnvironment = await getProjectEnvironment({
-            orgId,
-            projectId,
-            userId: user.id,
-            environmentId: args.env
-        });
-    }
-
-    if (projectEnvironment.org.id !== orgId) {
-        throw new Error(
-            `Cannot proceed with the deployment because the "${projectEnvironment.name}" project environment doesn't belong to the "${orgId}" organization. Please check your WCP project ID (currently set to "${wcpProjectId}").`
-        );
-    }
-
-    if (projectEnvironment.project.id !== projectId) {
-        throw new Error(
-            `Cannot proceed with the deployment because the "${projectEnvironment.name}" project environment doesn't belong to the "${wcpProjectId}" project. Please check your WCP project ID (currently set to "${wcpProjectId}").`
-        );
-    }
-
-    if (projectEnvironment && projectEnvironment.status !== "enabled") {
-        throw new Error(
-            `Cannot proceed with the deployment because the "${projectEnvironment.name}" project environment has been disabled.`
-        );
-    }
-
-    // Assign `WCP_PROJECT_ENVIRONMENT` and `WCP_PROJECT_ENVIRONMENT_API_KEY`
-    const wcpProjectEnvironment = {
-        id: projectEnvironment.id,
-        apiKey: projectEnvironment.apiKey,
-        org: { id: projectEnvironment.org.id },
-        project: { id: projectEnvironment.project.id }
-    };
-
-    process.env.WCP_PROJECT_ENVIRONMENT = encrypt(wcpProjectEnvironment);
-    process.env.WCP_PROJECT_ENVIRONMENT_API_KEY = projectEnvironment.apiKey;
-};
-
-const updateLastActiveOnHookHandler = async () => {
-    if (!projectEnvironment) {
-        return;
-    }
-
-    // Is this a user environment? If so, let's update his "last active" field.
-    if (projectEnvironment.user) {
-        await updateUserLastActiveOn();
-    }
-};
-
-// Export hooks plugins for deploy and watch commands.
-module.exports = () => [
-    // Deploy hook handlers.
-    {
-        type: "hook-before-deploy",
-        name: "hook-before-deploy-environment-get-environment",
-        hook: getEnvironmentHookHandler
-    },
-    {
-        type: "hook-before-deploy",
-        name: "hook-before-deploy-update-last-active-on",
-        hook: updateLastActiveOnHookHandler
-    },
-
-    // Watch hook handlers.
-    {
-        type: "hook-before-watch",
-        name: "hook-before-watch-environment-get-environment",
-        hook: getEnvironmentHookHandler
-    }
-];

package/commands/wcp/index.js

@@ -1,8 +0,0 @@
-const { command: login } = require("./login");
-const { command: logout } = require("./logout");
-const { command: whoami } = require("./whoami");
-const { command: project } = require("./project");
-
-const hooks = require("./hooks");
-
-module.exports = [login(), logout(), whoami(), project(), hooks()];