create-webiny-project 5.40.0-beta.2 → 5.40.0-beta.3

package/bin.js

@@ -8,18 +8,17 @@ const getNpmVersion = require("./utils/getNpmVersion");
 const verifyConfig = require("./utils/verifyConfig");
 
 (async () => {
-    const minNodeVersion = "16";
     const minNpmVersion = "10";
     const minYarnVersion = "1.22.21";
     /**
      * Node
      */
     const nodeVersion = process.versions.node;
-    if (!semver.satisfies(nodeVersion, `>=${minNodeVersion}`)) {
+    if (!semver.satisfies(nodeVersion, `^18 || ^20`)) {
         console.error(
             chalk.red(
                 [
-                    `You are running Node.js ${nodeVersion}, but Webiny requires version ${minNodeVersion} or higher.`,
+                    `You are running Node.js ${nodeVersion}, but Webiny requires version 18 or 20.`,
                     `Please switch to one of the required versions and try again.`,
                     "For more information, please visit https://docs.webiny.com/docs/tutorials/install-webiny#prerequisites."
                 ].join(" ")

package/index.js

@@ -71,12 +71,18 @@ yargs.command(
         });
         yargs.option("log", {
             describe:
-                "Creates a log file to see output of installation. Defaults to creating cwp-logs.txt in current directory",
+                "Creates a log file to see output of installation. Defaults to create-webiny-project-logs.txt in current directory",
             alias: "l",
-            default: "cwp-logs.txt",
+            default: "create-webiny-project-logs.txt",
             type: "string",
             demandOption: false
         });
+        yargs.option("debug", {
+            describe: "Turn on debug logs",
+            default: false,
+            type: "boolean",
+            demandOption: false
+        });
         yargs.option("cleanup", {
             describe: "If an error occurs upon project creation, deletes all generated files",
             alias: "c",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-webiny-project",
-	"version": "5.40.0-beta.2",
+	"version": "5.40.0-beta.3",
 	"description": "Webiny project bootstrap tool.",
 	"main": "index.js",
 	"scripts": {
@@ -13,7 +13,7 @@
 	"author": "Webiny Ltd.",
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/telemetry": "5.40.0-beta.2",
+		"@webiny/telemetry": "5.40.0-beta.3",
 		"chalk": "4.1.2",
 		"execa": "5.1.1",
 		"find-up": "5.0.0",
@@ -21,10 +21,10 @@
 		"js-yaml": "3.14.1",
 		"listr": "0.14.3",
 		"load-json-file": "6.2.0",
-		"node-fetch": "2.6.9",
+		"node-fetch": "2.7.0",
 		"os": "0.1.1",
 		"p-retry": "4.6.2",
-		"rimraf": "3.0.2",
+		"rimraf": "5.0.5",
 		"semver": "7.5.4",
 		"uuid": "8.3.2",
 		"validate-npm-package-name": "3.0.0",
@@ -35,5 +35,5 @@
 		"access": "public",
 		"directory": "."
 	},
-	"gitHead": "15e414a228687140ce2f30bd2f55763368e99827"
+	"gitHead": "638d8b84063906cd1aa979ed6e0487ad26fbcf2f"
 }

package/utils/GracefulError.d.ts

@@ -0,0 +1 @@
+export class GracefulError extends Error {}

package/utils/GracefulError.js

@@ -0,0 +1,3 @@
+class GracefulError extends Error {}
+
+module.exports = { GracefulError };

package/utils/GracefulYarnError.d.ts

@@ -0,0 +1,3 @@
+export class GracefulYarnError extends Error {
+    static from(e: Error, context: Record<string, any>): GracefulYarnError | undefined;
+}

package/utils/GracefulYarnError.js

@@ -0,0 +1,31 @@
+const { GracefulError } = require("./GracefulError");
+const gracefulYarnErrorHandlers = require("./gracefulYarnErrorHandlers");
+
+class GracefulYarnError extends GracefulError {
+    static from(e, context) {
+        if (e instanceof GracefulError) {
+            return e;
+        }
+
+        for (const handler of gracefulYarnErrorHandlers) {
+            const result = handler({ error: e, context });
+            if (!result) {
+                continue;
+            }
+
+            let errorMessage = result;
+            if (typeof result === "object") {
+                const { message, learnMore } = result;
+
+                errorMessage = message;
+                if (learnMore) {
+                    errorMessage += ` Learn more: ${learnMore}.`;
+                }
+            }
+
+            return new GracefulYarnError(errorMessage, { cause: e });
+        }
+    }
+}
+
+module.exports = { GracefulYarnError };

package/utils/createProject.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-const { yellow, red, green, gray } = require("chalk");
+const { yellow, red, green, gray, bold } = require("chalk");
 const execa = require("execa");
 const fs = require("fs-extra");
 const Listr = require("listr");
@@ -8,11 +8,20 @@ const writeJson = require("write-json-file");
 const rimraf = require("rimraf");
 const { sendEvent } = require("@webiny/telemetry/cli");
 const getPackageJson = require("./getPackageJson");
-const checkProjectName = require("./checkProjectName");
+const validateProjectName = require("./validateProjectName");
 const yaml = require("js-yaml");
 const findUp = require("find-up");
+const { GracefulError } = require("./GracefulError");
 
 const NOT_APPLICABLE = gray("N/A");
+const HL = bold(gray("—")).repeat(30);
+
+const sleep = () =>
+    new Promise(resolve => {
+        setTimeout(() => {
+            resolve();
+        }, 500);
+    });
 
 module.exports = async function createProject({
     projectName,
@@ -20,6 +29,7 @@ module.exports = async function createProject({
     template,
     tag,
     log,
+    debug,
     cleanup,
     interactive,
     templateOptions,
@@ -91,6 +101,8 @@ module.exports = async function createProject({
         // @webiny/cli is not installed globally
     }
 
+    validateProjectName(projectName);
+
     console.log(`Initializing a new Webiny project in ${green(projectRoot)}...`);
 
     await sendEvent({ event: "create-webiny-project-start" });
@@ -109,7 +121,6 @@ module.exports = async function createProject({
                 // Creates root package.json.
                 title: "Prepare project folder",
                 task: () => {
-                    checkProjectName(projectName);
                     fs.ensureDirSync(projectName);
                     writeJson.sync(
                         path.join(projectRoot, "package.json"),
@@ -119,7 +130,7 @@ module.exports = async function createProject({
             },
             {
                 // Setup yarn
-                title: "Setup yarn",
+                title: "Setup Yarn",
                 task: async () => {
                     const yarnVersion = "3.6.4";
                     const yarnFile = `yarn-${yarnVersion}.cjs`;
@@ -137,18 +148,22 @@ module.exports = async function createProject({
                     if (!fs.existsSync(source)) {
                         throw new Error(`No yarn binary source file: ${source}`);
                     }
+
                     const target = path.join(projectRoot, yarnReleasesFilePath);
                     fs.copyFileSync(source, target);
 
-                    const yamlPath = path.join(projectRoot, ".yarnrc.yml");
-                    if (!fs.existsSync(yamlPath)) {
-                        fs.writeFileSync(yamlPath, `yarnPath: ${yarnReleasesFilePath}`, "utf-8");
+                    // `.yarnrc.yml` file is created here.
+                    const yarnRcPath = path.join(projectRoot, ".yarnrc.yml");
+
+                    let rawYarnRc = `yarnPath: ${yarnReleasesFilePath}`;
+                    if (fs.existsSync(yarnRcPath)) {
+                        rawYarnRc = fs.readFileSync(yarnRcPath, "utf-8");
                     }
 
-                    const parsedYaml = yaml.load(fs.readFileSync(yamlPath, "utf-8"));
+                    const parsedYarnRc = yaml.load(rawYarnRc);
 
-                    // Default settings are applied here. Currently we only apply the `nodeLinker` param.
-                    parsedYaml.nodeLinker = "node-modules";
+                    // Default settings are applied here. Currently, we only apply the `nodeLinker` param.
+                    parsedYarnRc.nodeLinker = "node-modules";
 
                     // Enables adding additional params into the `.yarnrc.yml` file.
                     if (assignToYarnRc) {
@@ -162,15 +177,15 @@ module.exports = async function createProject({
                         }
 
                         if (parsedAssignToYarnRc) {
-                            Object.assign(parsedYaml, parsedAssignToYarnRc);
+                            Object.assign(parsedYarnRc, parsedAssignToYarnRc);
                         }
                     }
 
-                    fs.writeFileSync(yamlPath, yaml.dump(parsedYaml));
+                    fs.writeFileSync(yarnRcPath, yaml.dump(parsedYarnRc));
                 }
             },
             {
-                // "yarn adds" given template which can be either a real package or a path of a local package.
+                // Yarn adds given template which can be either a real package or a path of a local package.
                 title: `Install template package`,
                 task: async context => {
                     let add;
@@ -179,6 +194,7 @@ module.exports = async function createProject({
                     if (template.startsWith(".") || template.startsWith("file:")) {
                         templateName =
                             "file:" + path.relative(projectName, template.replace("file:", ""));
+                        templateName = `@webiny/cwp-template-aws@` + templateName;
                         add = templateName;
                     } else {
                         add = `${templateName}@${tag}`;
@@ -218,10 +234,9 @@ module.exports = async function createProject({
         await tasks.run(context);
 
         let templateName = context.templateName;
-
-        console.log(`Starting ${green(templateName)} template ...`);
-        if (templateName.startsWith("file:")) {
-            templateName = templateName.replace("file:", "");
+        if (templateName.includes("file:")) {
+            const [, templatePath] = templateName.match(/.*?file\:(.*)/);
+            templateName = templatePath;
         }
 
         const templatePath = path.dirname(
@@ -230,11 +245,7 @@ module.exports = async function createProject({
             })
         );
 
-        await new Promise(resolve => {
-            setTimeout(() => {
-                resolve();
-            }, 500);
-        });
+        await sleep();
 
         let parsedTemplateOptions = {};
         if (templateOptions) {
@@ -246,25 +257,36 @@ module.exports = async function createProject({
         }
 
         console.log();
+
         await require(templatePath)({
             log,
             isGitAvailable,
             projectName,
             projectRoot,
             interactive,
+            debug,
             templateOptions: parsedTemplateOptions
         });
 
         await sendEvent({ event: "create-webiny-project-end" });
     } catch (err) {
-        await sendEvent({
-            event: "create-webiny-project-error",
-            properties: {
-                errorMessage: err.message,
-                errorStack: err.stack
-            }
-        });
-
+        if (err instanceof GracefulError) {
+            await sendEvent({
+                event: "create-webiny-project-error-graceful",
+                properties: {
+                    errorMessage: err.message,
+                    errorStack: err.stack
+                }
+            });
+        } else {
+            await sendEvent({
+                event: "create-webiny-project-error",
+                properties: {
+                    errorMessage: err.message,
+                    errorStack: err.stack
+                }
+            });
+        }
         const node = process.versions.node;
         const os = process.platform;
 
@@ -311,18 +333,18 @@ module.exports = async function createProject({
         console.log(
             [
                 "",
-                `${green("ERROR OUTPUT: ")}`,
-                "----------------------------------------",
+                `${bold("Error Logs")}`,
+                HL,
                 err.message,
                 "",
-                `${green("SYSTEM INFORMATION: ")}`,
-                "----------------------------------------",
+                `${bold("System Information")}`,
+                HL,
+                `create-webiny-project: ${cwp}`,
                 `Operating System: ${os}`,
                 `Node: ${node}`,
                 `Yarn: ${yarn}`,
                 `Npm: ${npm}`,
                 `Npx: ${npx}`,
-                `create-webiny-project: ${cwp}`,
                 `Template: ${cwpTemplate}`,
                 `Template Options: ${templateOptionsJson}`,
                 "",
@@ -332,18 +354,17 @@ module.exports = async function createProject({
             ].join("\n")
         );
 
-        console.log(`Writing log to ${green(path.resolve(log))}...`);
+        console.log(`Writing logs to ${green(path.resolve(log))}...`);
         fs.writeFileSync(path.resolve(log), err.toString());
 
+        console.log();
         if (cleanup) {
-            console.log("Cleaning up generated files and folders...");
+            console.log("Deleting created files and folders...");
             rimraf.sync(projectRoot);
-            console.log("Done.");
         } else {
             console.log("Project cleanup skipped.");
         }
 
-        await sendEvent({ event: "create-webiny-project-end" });
         process.exit(1);
     }
 };

package/utils/gracefulYarnErrorHandlers/index.js

@@ -0,0 +1 @@
+module.exports = [];