@magnolia/cli-jumpstart-plugin 1.0.0-preview.6 → 1.0.0-preview.8

package/dist/lib/locales/en/translation.json

@@ -1,77 +1,86 @@
 {
-  "cmd-option-description": "download and set up a new headless or freemarker-based project with Magnolia webapp",
-  "cmd-option-template": "choose a template from available project templates",
-  "cmd-option-project-templates-path": "specify the path to load project templates from",
-  "cmd-option-magnolia-version": "set the Magnolia version; defaults to the latest stable version",
-  "cmd-option-snapshot": "download the latest snapshot version of the specified or latest stable webapp",
+  "description": "download and set up a new headless or freemarker-based project with Magnolia webapp",
+  "option-template-description": "choose a template from available project templates",
+  "option-projectTemplates-description": "specify the source to load project templates from",
+  "option-magnolia-description": "set the Magnolia version; defaults to the latest stable version",
+  "option-snapshot-description": "download the latest snapshot version of the specified or latest stable webapp",
 
-  "prompt-enter-credentials": "Please enter credentials for {{bundle}}",
-
-  "info-template_not_found": "The '{{template}}' template was not found.",
-  "info-jumpstart_started": "'JumpstartPlugin' plugin started successfully.",
-  "info-jumpstart_stopped": "'JumpstartPlugin' stopped",
-  "info-config-h-will-install-missing-plugins": "Will attempt to install missing plugins",
-  "info-config-h-mgnl-config-updated": "mgnl.config.js updated",
-  "info-config-h-mgnl-vars-added": "Shared variables added to mgnl.config.js",
-  "info-download-preparing": "Preparing to download {{url}}",
+  "info-enter-credentials": "Enter the credentials for \"{{bundle}}\"",
+  "info-template-not-found": "Template \"{{template}}\" not found",
+  "info-download-preparing": "Retrieving download URL from: {{url}}",
   "info-download-starting": "Starting download from: {{downloadUrl}}",
-  "info-download-finished": "Download finished",
-  "info-download-status-error": "Failed to download from: {{downloadUrl}}. Expected 200, but received: {{status}}.",
-  "info-extensions-calling-fn": "Calling Function {{name}}.",
-  "info-extensions-install-done": "Installing Extension Dependencies. Done.",
-  "info-extract-extracting": "Extracting...",
-  "info-install-dep": "Dependencies installed",
-  "info-pj-helper-npm-done": "Running 'npm install' done",
-  "info-pj-helper-pj-created": "package.json created",
-  "info-pj-helper-add-mgnl-to-pj": "Adding \"mgnl\" script to package.json",
-  "info-helper-found-lm": "Found existing light-modules path at '{{lightModulesPath}}'",
-  "info-helper-no-lm-found": "No light-modules folder found. Attempting to create one.",
-  "info-helper-lm-created": "light-modules folder created at '{{lightModulesPath}}'.",
-  "info-helper-webapp-prop-setting": "Setting {{key}} to: {{propsKey}} in {{filePath}}",
-  "info-helper-package-installed": "{{packageName}} installed",
+  "info-extensions-calling-fn": "Calling function \"{{name}}\"",
+  "info-add-mgnl-to-pj": "Added \"mgnl\" script to package.json",
+  "info-found-lm": "Found existing \"light-modules\" directory at: \"{{lightModulesPath}}\"",
+  "info-lm-created": "New \"light-modules\" directory created at: \"{{lightModulesPath}}\"",
+  "info-webapp-prop-setting": "Set \"{{key}}\" to: \"{{propsKey}}\" in \"{{filePath}}\"",
+  "info-project-downloaded": "Project successfully downloaded",
+  "info-microprofile-exists": "File \"microprofile-config.properties\" already exists",
+  "info-created-microprofile": "Created \"microprofile-config.properties\" at: {{file}}",
+  "info-no-node_modules": "Didn't find \"node_modules\" directory",
+  "info-plugin-installed": "\"{{plugin}}\" successfully installed",
+
+  "warn-install-plugins-manually": "Please install following plugins:\n{{installPluginsText}}and register them in \"mgnl.config.js\" file",
+  "warn-changed-type": "Changed 'type' property to \"module\" in \"package.json\"",
+  "warn-webapp-props-not-exist": "File \"{{filePath}}\" not found; skipping configuration",
+  "warn-cannot-modify-webapp": "An error occurred while modifying webapps:\n{{errorMsg}}",
+  "warn-cannot-parse-plugin-args": "The provided object:\n{{pluginArgs}}\nis not a valid JSON5 object; arguments will not be added to the plugin: \"{{plugin}}\"",
+
+  "error-no-tags": "No available tags found",
+  "error-problem-accessing-url": "A problem occurred while accessing: {{url}}",
+  "error-unable-to-get-local-issuer-certificate": ["The \"unable to get local issuer certificate\" error indicates that something in your infrastructure is preventing the CLI from downloading the Magnolia artifacts", "This is not a bug in the CLI", "For example, you may be behind a proxy that requires certain certificates", "You might be able to ask your infrastructure team to allow requests to the Magnolia artifact repository: https://nexus.magnolia-cms.com/", "Please search the web on \"unable to get local issuer certificate\" for more information"],
+  "error-no-artifact-available": "No Magnolia bundle with version \"{{version}}\" is available",
+  "error-while-getting-projectTemplates": "An error occurred while getting \"projectTemplates\":",
+  "error-no-projectTemplates-from-url": "Cannot fetch remote projectTemplates file located at: \"{{url}}\"; are you connected to the internet? does it point to a JSON file?",
+  "error-no-projectTemplates-from-path": "Cannot read projectTemplates from a local file located at: \"{{path}}\"; is it a JSON file?",
+  "error-no-projectTemplates-from-default": "Cannot fetch default projectTemplates; are you connected to the internet?",
+  "error-extensions-calling-fn-retry": "Error calling function: \"{{name}}\"; {{retry}}/{{maxRetry}}; waiting {{delay}}ms before retry",
+  "error-extensions-fn-not-found": "\"{{function}}\" function not found",
+  "error-apache-tomcat-not-found": "\"apache-tomcat\" was not found",
+  "error-lm-not-found": "\"light-modules\" was not found",
+  "error-pj-mod-fail": "An error occurred while modifying \"package.json\":\n{{errorMsg}}",
+  "error-lm-create-fail": "An error occurred while creating \"light-modules\" directory:\n{{errorMsg}}",
+  "error-webapp-props-update-error": "An error occurred while updating \"magnolia.properties\" in {{path}} file:\n{{errorMsg}}",
+  "error-while-adding-vars": "An error occurred while adding variables to \"mgnl.config.js\":\n{{errorMsg}}",
+  "error-while-add-plugin": "An error occurred while installing plugin \"{{plugin}}\":\n{{errorMsg}}",
+  "error-option-param-is-flag": "Option \"{{option}}\" argument missing; provided value: \"{{value}}\" is a flag",
+  "error-mgnl-cli-not-installed": "The \"@magnolia/cli\" package is not installed; try installing it manually: 'npm install @magnolia/cli'",
+  "error-download-fail-status": "Download failed from: {{downloadUrl}}; expected status \"200\"; received: \"{{status}}\"",
+  "error-while-downloading-bundle": "An error occurred while downloading bundle from: {{url}}",
+  "error-auth-fail": "Authentication failed for {{url}}; received 401 status; verify your credentials and try again",
+
+  "inquirer-prompt-select-tag": "Choose a tag",
+  "inquirer-prompt-choose-template": "Choose a template",
+
+  "ora-start-checking-add-plugin": "Looking for \"@magnolia/cli add-plugin\" command...",
+  "ora-start-extracting": "Extracting...",
+  "ora-start-creating-config": "Creating \"mgnl.config.js\"...",
+  "ora-start-updating-config": "Updating \"mgnl.config.js\"...",
+  "ora-start-adding-shared-vars": "Adding variables to \"mgnl.config.js\"...",
+  "ora-start-installing-ext-dep": "Installing extension dependencies...",
+  "ora-start-running-pm-install": "Running '{{packageManager}} install'...",
+  "ora-start-creating-pj": "Creating package.json...",
+  "ora-start-installing-package": "Installing \"{{packageName}}\"...",
 
-  "warn-config-h-could-not-install-cli": "Couldn't install @magnolia/cli",
-  "warn-config-h-no-add-plugin": "Cannot find add-plugin command. Please update @magnolia/cli package.",
-  "warn-config-h-install-plugins-manually": "Please install following plugins:\n{{installPluginsText}}and add them to mgnl.config.js manually.",
-  "warn-pj-helper-changing-type": "Changing 'type' to \"module\"",
-  "warn-helper-webapp-props-not-exist": "File {{filePath}} doesn't exists, skipping configuration.",
-  "warn-helper-cannot-modify-webapp": "Cannot modify webapps: {{errorMsg}}",
-  "warn-config-h-error-cannot-parse-plugin-args": "Provided plugin argument:\n{{pluginArgs}}\nis not a valid JSON5 object.",
+  "ora-succeed-pj-created": "\"package.json\" created",
+  "ora-succeed-extracted-to": "Extracted to {{path}}",
+  "ora-succeed-shared-vars-added": "Added shared variables to \"mgnl.config.js\"",
+  "ora-succeed-extensions-install-done": "Extension dependencies installed",
+  "ora-succeed-pm-install": "Completed running '{{packageManager}} install'",
+  "ora-succeed-config-created": "Created \"mgnl.config.js\" with logger and plugins properties",
+  "ora-succeed-config-updated": "Updated \"mgnl.config.js\" with logger property",
+  "ora-succeed-package-installed": "\"{{packageName}}\" installed",
 
-  "error-config-h-could-not-read-mgnl-config": "Couldn't read {{configPath}}",
-  "error-config-h-could-not-parse-mgnl-config": "Couldn't parse {{configPath}}, please check the file for issues",
-  "error-config-h-while-updating-mgnl-config": "Error occurred while updating mgnl.config.js",
-  "error-config-h-while-adding-vars": "Error occurred while adding variables to mgnl.config.js",
-  "error-config-h-while-add-plugin": "An error occurred while installing following plugin: {{plugin}}",
-  "error-download-no-tags": "There are no available tags",
-  "error-download-problem-accessing-url": "A problem was detected while accessing: {{url}}.",
-  "error-download-unable-to-get-local-issuer-certificate": "The \"unable to get local issuer certificate\" error indicates that something in your infrastructure is preventing the CLI from downloading the Magnolia artifacts. This is not a bug in the CLI. For example, you may be behind a proxy that requires certain certificates. You might be able to ask your infrastructure team to allow requests to the Magnolia artifact repository: https://nexus.magnolia-cms.com/ Please search the web on \"unable to get local issuer certificate\" for more information.",
-  "error-download-no-artifact-available": "No Magnolia bundle with \"{{version}}\" version is available.",
-  "error-extensions-calling-fn-retry": "Error Calling Function {{name}}. {{retry}}/{{maxRetry}}. Waiting {{delay}}ms before retry.",
-  "error-extensions-fn-not-found": "{{function}} Function not found",
-  "error-extensions-path-not-found": "{{extensionsPath}} not found. Could not evaluate custom prompts.",
-  "error-extensions-install-fail": "'{{packageManager}} install' has failed",
-  "error-extract-apache-tomcat-not-found": "apache-tomcat was not found.",
-  "error-install-dep-fail": "Failed to install dependencies",
-  "error-pj-helper-npm-fail": "'npm install' has failed",
-  "error-pj-helper-pj-mod-fail": "Failed to modify package.json",
-  "error-pj-helper-pj-create-fail": "Failed to create package.json",
-  "error-helper-lm-create-fail": "Failed to create 'light-modules' folder: {{errorMsg}}",
-  "error-helper-webapp-props-update-error": "An error occurred while updating 'magnolia.properties': {{errorMsg}}",
-  "error-helper-lm-not-found": "light-modules was not found",
-  "error-helper-fail-to-install-package": "Failed to install {{packageName}}",
-  "error-option-param-is-flag": "option \"{{option}}\" argument missing. Provided value: \"{{value}}\" is a flag",
+  "ora-warn-no-add-plugin": "Cannot find \"@magnolia/cli add-plugin\" command; you may need to update \"@magnolia/cli\" package",
 
-  "ora-updating-mgnl-config": "Updating mgnl.config.js",
-  "ora-adding-shared-vars": "Adding variables to mgnl.config.js",
-  "ora-installing-ext-dep": "Installing Extension Dependencies",
-  "ora-installing-dep": "Installing dependencies",
-  "ora-running-npm-install": "Didn't find 'node_modules' folder. Running 'npm install'",
-  "ora-creating-pj": "Creating package.json",
-  "ora-installing-package": "Installing {{packageName}}",
+  "ora-fail-pm-install": "An error occurred while running '{{packageManager}} install':\n{{errorMsg}}",
+  "ora-fail-creating-config": "An error occurred while creating \"mgnl.config.js\":\n{{errorMsg}}",
+  "ora-fail-updating-config": "An error occurred while updating \"mgnl.config.js\":\n{{errorMsg}}",
+  "ora-fail-creating-pj": "An error occurred while creating \"package.json\":\n{{errorMsg}}",
+  "ora-fail-installing-package": "An error occurred while installing \"{{packageName}}\":\n{{errorMsg}}",
+  "ora-fail-while-add-plugin-check": "An error occurred while looking for \"@magnolia/cli add-plugin\" command:\n{{errorMsg}}",
 
-  "install-plugin-with-args-text": "\twith following args: {{pluginArgs}}\n",
+  "progress-bar-downloading": "Downloading",
 
-  "create-microprofile--info-file-exists-skipping": "File microprofile-config.properties already exists. Skipping...",
-  "create-microprofile--info-creating-file": "Creating microprofile-config.properties at {{file}}"
+  "text-install-plugin-with-args": "\twith following arguments: {{pluginArgs}}\n"
 }

package/dist/lib/pj-helper.js

@@ -11,7 +11,7 @@ import path from "path";
 import ora from "ora";
 import fs from "fs-extra";
 import { execa } from "execa";
-import { determinePackageManager, installPackage } from "./helper.js";
+import { determinePackageManager, installCLI } from "./helper.js";
 import { i18nInstance, logger } from "../jumpstart-plugin.js";
 export const handlePackageJSON = () => __awaiter(void 0, void 0, void 0, function* () {
     const pjPath = path.join(process.cwd(), 'package.json');
@@ -24,27 +24,27 @@ export const modifyPackageJSON = (pjPath) => __awaiter(void 0, void 0, void 0, f
     let pj = JSON.parse(fs.readFileSync(pjPath, 'utf8'));
     let isMgnlCliInstalled = (pj === null || pj === void 0 ? void 0 : pj.dependencies) && (pj === null || pj === void 0 ? void 0 : pj.dependencies['@magnolia/cli']);
     if (!isMgnlCliInstalled) {
-        isMgnlCliInstalled = yield installPackage(determinePackageManager(), "@magnolia/cli@preview", "mgnl-cli");
+        isMgnlCliInstalled = yield installCLI();
         if (isMgnlCliInstalled) {
             pj = JSON.parse(fs.readFileSync(pjPath, 'utf8'));
         }
     }
     const nodeModulesPath = path.join(process.cwd(), "node_modules");
     if (!fs.existsSync(nodeModulesPath)) {
-        const npmISpinner = ora().start(i18nInstance.t("ora-running-npm-install"));
+        logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t('info-no-node_modules'));
+        const pm = determinePackageManager();
+        const npmISpinner = ora().start(i18nInstance.t("ora-start-running-pm-install", { packageManager: pm }));
         try {
-            yield execa(determinePackageManager(), ["install"], {
+            yield execa(pm, ["install"], {
                 buffer: true,
                 cwd: process.cwd()
             });
+            npmISpinner.succeed(i18nInstance.t("ora-succeed-pm-install", { packageManager: pm }));
         }
         catch (e) {
-            npmISpinner.stop();
-            logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-pj-helper-npm-fail"));
+            npmISpinner.fail(i18nInstance.t("ora-fail-pm-install", { packageManager: pm, errorMsg: e.message }));
             return;
         }
-        npmISpinner.stop();
-        logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-pj-helper-npm-done"));
     }
     if (isMgnlCliInstalled) {
         const mgnlScript = { "mgnl": "node node_modules/@magnolia/cli" };
@@ -53,39 +53,40 @@ export const modifyPackageJSON = (pjPath) => __awaiter(void 0, void 0, void 0, f
             pj.scripts = {};
         }
         if (!pj.scripts[scriptKey] || pj.scripts[scriptKey] !== mgnlScript[scriptKey]) {
-            logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-pj-helper-add-mgnl-to-pj"));
             pj.scripts[scriptKey] = mgnlScript[scriptKey];
         }
     }
+    let changedTypeMsg;
     if (!pj.type) {
         pj.type = "module";
     }
     else if (pj.type !== "module") {
-        logger === null || logger === void 0 ? void 0 : logger.warn(i18nInstance.t("warn-pj-helper-changing-type"));
+        changedTypeMsg = "warn-changed-type";
         pj.type = "module";
     }
     try {
         fs.writeFileSync(pjPath, JSON.stringify(pj, null, '\t'), 'utf8');
+        logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-add-mgnl-to-pj"));
+        if (changedTypeMsg) {
+            logger === null || logger === void 0 ? void 0 : logger.warn(i18nInstance.t(changedTypeMsg));
+        }
     }
     catch (e) {
-        logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-pj-helper-pj-mod-fail"));
+        logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-pj-mod-fail", { errorMsg: e.message }));
         return;
     }
 });
 export const initPackageJSON = () => __awaiter(void 0, void 0, void 0, function* () {
-    const pjSpinner = ora().start(i18nInstance.t("ora-creating-pj"));
+    const pjSpinner = ora().start(i18nInstance.t("ora-start-creating-pj"));
     try {
         yield execa(determinePackageManager(), ['init', '-y'], {
             buffer: true,
             cwd: process.cwd()
         });
+        pjSpinner.succeed(i18nInstance.t("ora-succeed-pj-created"));
     }
     catch (e) {
-        pjSpinner.stop();
-        logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-pj-helper-pj-create-fail"));
-        console.error(e);
+        pjSpinner.fail(i18nInstance.t("ora-fail-creating-pj", { errorMsg: e.message }));
         return;
     }
-    pjSpinner.stop();
-    logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-pj-helper-pj-created"));
 });

package/dist/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magnolia/cli-jumpstart-plugin",
-  "version": "1.0.0-preview.6",
-  "description": "Plugin to set up new projects using predefined templates and bundles. Easily select and configure project templates, and let the plugin handle bundle downloads, extraction, and post-command execution.",
+  "version": "1.0.0-preview.8",
+  "description": "A plugin for Magnolia CLI to download and set up a new headless or freemarker-based project with Magnolia webapp",
   "main": "dist/index.js",
   "scripts": {
     "test": "npm run build && node --experimental-vm-modules node_modules/jest/bin/jest.js",
@@ -21,7 +21,6 @@
     "@types/progress": "^2.0.5",
     "@types/underscore": "^1.11.14",
     "@types/walk": "^2.3.1",
-    "@types/yauzl": "^2.10.1",
     "cpy-cli": "^5.0.0",
     "jest": "^29.6.2",
     "standard": "^17.1.0",
@@ -34,7 +33,6 @@
     "@babel/types": "^7.23.6",
     "@magnolia/cli-plugin-template": "^1.1.0",
     "axios": "^1.4.0",
-    "chalk": "^5.3.0",
     "commander": "^11.0.0",
     "decompress": "^4.2.1",
     "dotenv": "^16.3.1",

package/dist/types/types.d.ts

@@ -1,7 +1,7 @@
 export interface PluginOptions {
     template: string | boolean;
-    projectTemplatesPath: string;
-    magnoliaVersion?: string;
+    projectTemplates: string;
+    magnolia?: string;
     snapshot?: boolean;
 }
 export interface Bundle {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magnolia/cli-jumpstart-plugin",
-  "version": "1.0.0-preview.6",
-  "description": "Plugin to set up new projects using predefined templates and bundles. Easily select and configure project templates, and let the plugin handle bundle downloads, extraction, and post-command execution.",
+  "version": "1.0.0-preview.8",
+  "description": "A plugin for Magnolia CLI to download and set up a new headless or freemarker-based project with Magnolia webapp",
   "main": "dist/index.js",
   "scripts": {
     "test": "npm run build && node --experimental-vm-modules node_modules/jest/bin/jest.js",
@@ -21,7 +21,6 @@
     "@types/progress": "^2.0.5",
     "@types/underscore": "^1.11.14",
     "@types/walk": "^2.3.1",
-    "@types/yauzl": "^2.10.1",
     "cpy-cli": "^5.0.0",
     "jest": "^29.6.2",
     "standard": "^17.1.0",
@@ -34,7 +33,6 @@
     "@babel/types": "^7.23.6",
     "@magnolia/cli-plugin-template": "^1.1.0",
     "axios": "^1.4.0",
-    "chalk": "^5.3.0",
     "commander": "^11.0.0",
     "decompress": "^4.2.1",
     "dotenv": "^16.3.1",