@webiny/cli 6.0.0-beta.0 → 6.0.0-rc.0

package/index.js

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

package/package.json

@@ -1,69 +1,30 @@
 {
 	"name": "@webiny/cli",
-	"version": "6.0.0-beta.0",
+	"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/telemetry": "6.0.0-beta.0",
-		"@webiny/wcp": "6.0.0-beta.0",
-		"boolean": "3.2.0",
-		"camelcase": "5.3.1",
-		"chalk": "4.1.2",
-		"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": "9.1.0",
-		"graphql-request": "3.7.0",
-		"inquirer": "7.3.3",
-		"is-ci": "3.0.1",
-		"ncp": "2.0.0",
-		"open": "8.4.0",
-		"pirates": "4.0.5",
-		"semver": "7.5.4",
-		"ts-morph": "11.0.3",
-		"typescript": "4.7.4",
-		"uniqid": "5.4.0",
-		"yargs": "17.6.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": "aa8dbfbbd5ad13ec271adba6f2431e02991a300f"
+	"gitHead": "0f2aa699f4642e550ab62c96fcd050e8d02345c9"
 }

package/utils/ensureSameWebinyPackageVersions.js

@@ -0,0 +1,99 @@
+const execa = require("execa");
+const logger = require("./log");
+
+const DEBUG_FLAG = "--debug";
+const usingDebugFlag = process.argv.includes(DEBUG_FLAG);
+
+const SKIP_WEBINY_VERSIONS_CHECK_FLAG = "--no-package-versions-check";
+const skippingWebinyVersionsCheck = process.argv.includes(SKIP_WEBINY_VERSIONS_CHECK_FLAG);
+
+function listWebinyPackageVersions() {
+    const { stdout } = execa.sync("yarn", ["info", "@webiny/*", "--name-only", "--all", "--json"], {
+        encoding: "utf-8"
+    });
+
+    // Each line is a JSON string, so parse them individually
+    const lines = stdout
+        .trim()
+        .split("\n")
+        .map(line => JSON.parse(line));
+
+    const versionMap = new Map();
+
+    for (const entry of lines) {
+        // An example entry: "@webiny/cli@npm:5.42.3"
+        const match = entry.match(/^(@webiny\/[^@]+)@npm:(.+)$/);
+        if (!match) {
+            continue;
+        }
+
+        const [, pkg, version] = match;
+        if (!versionMap.has(pkg)) {
+            versionMap.set(pkg, new Set());
+        }
+
+        versionMap.get(pkg).add(version);
+    }
+
+    return versionMap;
+}
+
+function ensureSameWebinyPackageVersions() {
+    // Just in case, we want to allow users to skip the check.
+    if (skippingWebinyVersionsCheck) {
+        return;
+    }
+
+    let webinyVersions;
+    try {
+        webinyVersions = listWebinyPackageVersions();
+    } catch (e) {
+        const message = ["Failed to inspect Webiny package versions."];
+
+        if (!usingDebugFlag) {
+            message.push(
+                `For more information, try running with ${logger.warning.hl(DEBUG_FLAG)}.`
+            );
+        }
+
+        message.push("Learn more: https://webiny.link/webiny-package-versions-check");
+
+        logger.warning(message.join(" "));
+        if (usingDebugFlag) {
+            logger.debug(e);
+        }
+
+        console.log();
+        return;
+    }
+
+    let hasMismatch = false;
+    const mismatchedPackages = [];
+    for (const [pkg, versions] of webinyVersions.entries()) {
+        if (versions.size > 1) {
+            hasMismatch = true;
+            mismatchedPackages.push([pkg, versions]);
+        }
+    }
+
+    if (hasMismatch) {
+        const message = [
+            "The following Webiny packages have mismatched versions:",
+            "",
+            ...mismatchedPackages.map(([pkg, versions]) => {
+                return `‣ ${pkg}: ${Array.from(versions).join(", ")}`;
+            }),
+            "",
+            `Please ensure all Webiny packages are using the same version. If you think this is a mistake, you can also skip this check by appending the ${logger.error.hl(
+                SKIP_WEBINY_VERSIONS_CHECK_FLAG
+            )} flag. Learn more: https://webiny.link/webiny-package-versions-check`
+        ];
+
+        logger.error(message.join("\n"));
+        process.exit(1);
+    }
+}
+
+module.exports = {
+    ensureSameWebinyPackageVersions
+};

package/utils/suppressPunycodeWarnings.js

@@ -0,0 +1,7 @@
+const originalConsoleError = console.error;
+console.error = (message, ...args) => {
+    if (typeof message === "string" && message.includes("punycode")) {
+        return;
+    }
+    originalConsoleError.call(console, message, ...args);
+};

package/cli.js

@@ -1,93 +0,0 @@
-#!/usr/bin/env node
-const yargs = require("yargs");
-
-// Disable help processing until after plugins are imported.
-yargs.help(false);
-
-// Loads environment variables from multiple sources.
-require("./utils/loadEnvVariables");
-
-const { blue, red, bold, bgYellow } = require("chalk");
-const context = require("./context");
-const { createCommands } = require("./commands");
-
-yargs
-    .usage("Usage: $0 <command> [options]")
-    .demandCommand(1)
-    .recommendCommands()
-    .scriptName("webiny")
-    .epilogue(
-        `To find more information, docs and tutorials, see ${blue("https://www.webiny.com/docs")}.`
-    )
-    .epilogue(`Want to contribute? ${blue("https://github.com/webiny/webiny-js")}.`)
-    .fail(function (msg, error, yargs) {
-        if (msg) {
-            if (msg.includes("Not enough non-option arguments")) {
-                console.log();
-                context.error(red("Command was not invoked as expected!"));
-                context.info(
-                    `Some non-optional arguments are missing. See the usage examples printed below.`
-                );
-                console.log();
-                yargs.showHelp();
-                return;
-            }
-
-            if (msg.includes("Missing required argument")) {
-                const args = msg
-                    .split(":")[1]
-                    .split(",")
-                    .map(v => v.trim());
-
-                console.log();
-                context.error(red("Command was not invoked as expected!"));
-                context.info(
-                    `Missing required argument(s): ${args
-                        .map(arg => red(arg))
-                        .join(", ")}. See the usage examples printed below.`
-                );
-                console.log();
-                yargs.showHelp();
-                return;
-            }
-            console.log();
-            context.error(red("Command execution was aborted!"));
-            context.error(msg);
-            console.log();
-
-            process.exit(1);
-        }
-
-        console.log();
-        // Unfortunately, yargs doesn't provide passed args here, so we had to do it via process.argv.
-        const debugEnabled = process.argv.includes("--debug");
-        if (debugEnabled) {
-            context.debug(error);
-        } else {
-            context.error(error.message);
-        }
-
-        const gracefulError = error.cause?.gracefulError;
-        if (gracefulError instanceof Error) {
-            console.log();
-            console.log(bgYellow(bold("💡 How can I resolve this?")));
-            console.log(gracefulError.message);
-        }
-
-        const plugins = context.plugins.byType("cli-command-error");
-        for (let i = 0; i < plugins.length; i++) {
-            const plugin = plugins[i];
-            plugin.handle({
-                error,
-                context
-            });
-        }
-
-        process.exit(1);
-    });
-
-(async () => {
-    await createCommands(yargs, context);
-    // Enable help and run the CLI.
-    yargs.help().argv;
-})();

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,10 +0,0 @@
-const execa = require("execa");
-
-module.exports.getNpmVersion = async () => {
-    try {
-        const { stdout } = await execa("npm", ["--version"]);
-        return stdout;
-    } catch (err) {
-        return "";
-    }
-};

package/commands/about/getNpxVersion.js

@@ -1,10 +0,0 @@
-const execa = require("execa");
-
-module.exports.getNpxVersion = async () => {
-    try {
-        const { stdout } = await execa("npx", ["--version"]);
-        return stdout;
-    } catch (err) {
-        return "";
-    }
-};

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,10 +0,0 @@
-const execa = require("execa");
-
-module.exports.getYarnVersion = async () => {
-    try {
-        const { stdout } = await execa("yarn", ["--version"]);
-        return stdout;
-    } catch (err) {
-        return "";
-    }
-};

package/commands/about/index.js

@@ -1,97 +0,0 @@
-const NO_VALUE = "-";
-const isCI = require("is-ci");
-
-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"
-            );
-        });
-    }
-};