@magnolia/cli-jumpstart-plugin 1.0.0-preview.9 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 1.0.1 (2024-10-15)
+* use @5 version of @magnolia/cli ([MGNLCLI-302](https://magnolia-cms.atlassian.net/browse/MGNLCLI-302))
+
+## 1.0.0 (2024-10-14)
+* introduce `@magnolia/cli-jumpstart-plugin` package

package/dist/jumpstart-plugin.d.ts

@@ -21,8 +21,6 @@ export default class JumpstartPlugin extends PluginTemplate {
     promptTemplateSelection(templates: Array<Template>, names?: string[]): Promise<TemplateWithoutChildren | undefined>;
     findTemplateByIdentifier(identifier: string): TemplateWithoutChildren | undefined;
     chooseTemplate(options: PluginOptions): Promise<void>;
-    private isFlag;
-    private checkFlagsArguments;
     init(winstonLogger: Logger): Promise<void>;
     start(options: PluginOptions): Promise<void>;
     stop(): Promise<void>;

package/dist/jumpstart-plugin.js

@@ -19,10 +19,14 @@ import { downloadBundle } from "./lib/download.js";
 import { PostCommands } from "./types/types.js";
 import { installDependencies } from "./lib/install.js";
 import path from "path";
-import { askForCredentials, handleLightModulesFolder, initI18n, initializeNodeProject } from "./lib/helper.js";
+import { askForCredentials, handleLightModulesFolder, initializeNodeProject } from "./lib/helper.js";
 import { compileCustomPrompts, evaluateCustomPrompts } from "./lib/extensions.js";
 import { addConfigProps } from "./lib/config-helper.js";
 import { installAdditionalPlugins } from "./lib/config-helper.js";
+import { checkFlagsValue, CreateError } from "@magnolia/cli-helper/general-utils";
+import { initI18n } from "@magnolia/cli-helper/i18n";
+import { fileURLToPath } from "url";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const extensionsPath = path.resolve("./extensions/extension.yaml");
 export let logger;
 export let i18nInstance = {
@@ -34,7 +38,7 @@ export default class JumpstartPlugin extends PluginTemplate {
         this.name = "jumpstart";
         this.version = pkg.version;
         this.usage = "[options]";
-        i18nInstance = initI18n(this.name);
+        i18nInstance = initI18n(this.name, "translation", path.join(__dirname, "lib/locales"));
         this.description = i18nInstance.t('description');
         this.options = [
             new Option('-m, --magnolia <version>', i18nInstance.t('option-magnolia-description')),
@@ -124,7 +128,7 @@ export default class JumpstartPlugin extends PluginTemplate {
             }
             catch (e) {
                 if (errorMsg) {
-                    throw new Error(errorMsg);
+                    throw new CreateError(errorMsg);
                 }
                 else {
                     console.error(i18nInstance.t("error-while-getting-projectTemplates"));
@@ -198,19 +202,6 @@ export default class JumpstartPlugin extends PluginTemplate {
             }
         });
     }
-    isFlag(value) {
-        return this.options.some(it => it.long === value || it.short === value);
-    }
-    checkFlagsArguments(options) {
-        Object.keys(options).forEach(key => {
-            const value = options[key];
-            if (this.isFlag(value)) {
-                const optionLong = "--" + key.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase();
-                const option = this.options.find(it => it.long === optionLong);
-                throw new Error(i18nInstance.t('error-option-param-is-flag', { option: option === null || option === void 0 ? void 0 : option.flags, value: value }));
-            }
-        });
-    }
     init(winstonLogger) {
         return __awaiter(this, void 0, void 0, function* () {
             logger = winstonLogger;
@@ -218,7 +209,7 @@ export default class JumpstartPlugin extends PluginTemplate {
     }
     start(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.checkFlagsArguments(options);
+            checkFlagsValue(this.options, options);
             yield this.setProjectTemplates(options);
             yield this.chooseTemplate(options);
             logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t('info-project-downloaded'));

package/dist/lib/config-helper.d.ts

@@ -1,4 +1,4 @@
-import { PluginRequirement } from "../types/types";
+import { PluginRequirement } from "../types/types.js";
 export declare const installAdditionalPlugins: (plugins: Array<PluginRequirement>) => Promise<void>;
 export declare const handleMGNLConfigFile: () => Promise<void>;
 export declare const addConfigProps: (vars: any) => Promise<void>;

package/dist/lib/config-helper.js

@@ -21,15 +21,8 @@ import _generate from "@babel/generator";
 import _traverse from "@babel/traverse";
 import { execa } from "execa";
 import JSON5 from "json5";
+import { BEAUTIFY_OPTIONS } from "@magnolia/cli-helper/general-utils";
 const { js_beautify } = beautifyModule;
-const BEAUTIFY_OPTIONS = {
-    indent_size: 2,
-    end_with_newline: true,
-    max_preserve_newlines: 2,
-    keep_array_indentation: false,
-    preserve_newlines: true,
-    wrap_line_length: 1
-};
 const getLocalConfigPath = () => path.join(process.cwd(), 'mgnl.config.js');
 const getPackageConfigPath = () => path.join(process.cwd(), 'node_modules/@magnolia/cli/mgnl.config.js');
 export const installAdditionalPlugins = (plugins) => __awaiter(void 0, void 0, void 0, function* () {
@@ -78,7 +71,6 @@ export const installAdditionalPlugins = (plugins) => __awaiter(void 0, void 0, v
             if (argsMsg) {
                 logger === null || logger === void 0 ? void 0 : logger.warn(argsMsg);
             }
-            logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t('info-plugin-installed', { plugin: plugin.plugin }));
         }
         catch (e) {
             logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t('error-while-add-plugin', { plugin: plugin.plugin, errorMsg: e.message }));
@@ -135,7 +127,7 @@ function getLoggerContent(logger) {
     ${logger},`;
 }
 const extractLoggerConfig = (content) => {
-    const loggerRegex = /(logger\s*:\s*{[^}]*})/s;
+    const loggerRegex = /(logger\s*:\s*{[^}]*})/;
     return loggerRegex.exec(content);
 };
 const writeConfigContent = (content, creating) => {

package/dist/lib/download.js

@@ -14,6 +14,7 @@ import inquirer from "inquirer";
 import { i18nInstance, logger } from "../jumpstart-plugin.js";
 import { askForCredentials } from "./helper.js";
 import axios from "axios";
+import { CreateError } from "@magnolia/cli-helper/general-utils";
 export const downloadBundle = (bundle, credentials, dest, options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         let url = bundle.url;
@@ -82,7 +83,7 @@ export const downloadBundle = (bundle, credentials, dest, options) => __awaiter(
     }
     catch (error) {
         logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t('error-while-downloading-bundle', { url: bundle.url }));
-        throw new Error(error);
+        throw new CreateError(error.message);
     }
 });
 export const getDownloadUrl = (bundle, credentials, options) => __awaiter(void 0, void 0, void 0, function* () {
@@ -104,7 +105,7 @@ export const getDownloadUrl = (bundle, credentials, options) => __awaiter(void 0
             if (options.snapshot || bundle.version.toLowerCase().includes("snapshot")) {
                 url.searchParams.set('prerelease', "true");
                 if (options.magnolia === undefined && !bundle.version.match(/^\d/)) {
-                    options.magnolia = "6.2";
+                    options.magnolia = "6.3";
                 }
             }
             if (options.magnolia) {
@@ -165,11 +166,11 @@ export const getDownloadUrl = (bundle, credentials, options) => __awaiter(void 0
             }));
             logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-unable-to-get-local-issuer-certificate"));
         }
-        throw new Error(error.message);
+        throw new CreateError(error.message);
     }
 });
 export const selectTag = (url, credentials) => __awaiter(void 0, void 0, void 0, function* () {
-    var _g;
+    var _a;
     const opts = {
         method: 'get',
         headers: {
@@ -180,8 +181,8 @@ export const selectTag = (url, credentials) => __awaiter(void 0, void 0, void 0,
         opts.auth = credentials;
     }
     const res = yield get(url, opts, credentials);
-    if (!((_g = res.data) === null || _g === void 0 ? void 0 : _g.values) || res.data.values.length <= 0) {
-        throw new Error(i18nInstance.t("error-no-tags"));
+    if (!((_a = res.data) === null || _a === void 0 ? void 0 : _a.values) || res.data.values.length <= 0) {
+        throw new CreateError(i18nInstance.t("error-no-tags"));
     }
     const { tag } = yield inquirer
         .prompt([

package/dist/lib/extract.js

@@ -16,6 +16,7 @@ import url from "url";
 import { i18nInstance } from "../jumpstart-plugin.js";
 import { handleMicroprofileConfig } from "./handleMicroprofileConfig.js";
 import ora from "ora";
+import { CreateError } from "@magnolia/cli-helper/general-utils";
 export const extract = (bundle, file, command) => __awaiter(void 0, void 0, void 0, function* () {
     var _a;
     const spinner = ora().start(i18nInstance.t("ora-start-extracting"));
@@ -62,7 +63,7 @@ export const findExtractedApacheTomcatDir = (p) => {
             next();
         });
         walker.on('end', function () {
-            return reject(new Error(i18nInstance.t("error-apache-tomcat-not-found")));
+            return reject(new CreateError(i18nInstance.t("error-apache-tomcat-not-found")));
         });
     });
 };

package/dist/lib/handleMicroprofileConfig.d.ts

@@ -1,3 +1,3 @@
-import { Bundle } from "../types/types";
+import { Bundle } from "../types/types.js";
 export declare const handleMicroprofileConfig: (bundle: Bundle, dest: string) => Promise<void>;
 export declare function convertObjectToProperties(obj: any): any[];

package/dist/lib/helper.d.ts

@@ -1,6 +1,4 @@
 import { Credentials } from "../types/types.js";
-import { i18n } from "i18next";
-export declare function initI18n(pluginName: string, namespace?: string): i18n;
 export declare const handleLightModulesFolder: () => Promise<void>;
 export declare const findLightModulesFolder: (p: string) => Promise<unknown>;
 export declare const findWebAppsList: (apacheTomcatPath: string) => string[];

package/dist/lib/helper.js

@@ -9,8 +9,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { handleMGNLConfigFile } from "./config-helper.js";
 import { handlePackageJSON } from "./pj-helper.js";
-import i18next from "i18next";
-import Backend from 'i18next-fs-backend';
 import ora from "ora";
 import { execa } from "execa";
 import path from "path";
@@ -18,41 +16,8 @@ import fs from "fs-extra";
 import { findExtractedApacheTomcatDir } from "./extract.js";
 import walk from "walk";
 import { i18nInstance, logger } from "../jumpstart-plugin.js";
-import { fileURLToPath } from "url";
 import inquirer from "inquirer";
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-export function initI18n(pluginName, namespace = "translation") {
-    const lng = 'en';
-    const localesPath = path.join(__dirname, `locales/${lng}`);
-    const namespaces = fs.readdirSync(localesPath)
-        .filter(file => file.endsWith('.json'))
-        .map(file => file.replace('.json', ''));
-    if (!namespaces.includes(namespace)) {
-        console.warn(`${pluginName}: Requested translation file "${namespace}" not found at "${localesPath}".\n`);
-        if (namespaces.length > 0) {
-            console.warn(`Using "${namespaces[0]}" instead.\n`);
-        }
-        namespace = namespaces[0];
-    }
-    const newI18nInstance = i18next.createInstance();
-    newI18nInstance
-        .use(Backend)
-        .init({
-        joinArrays: '\n',
-        lng: lng,
-        fallbackLng: 'en',
-        ns: namespaces,
-        defaultNS: namespace,
-        initImmediate: false,
-        interpolation: {
-            escapeValue: false,
-        },
-        backend: {
-            loadPath: path.join(__dirname, 'locales/{{lng}}/{{ns}}.json')
-        }
-    });
-    return newI18nInstance;
-}
+import { CreateError } from "@magnolia/cli-helper/general-utils";
 export const handleLightModulesFolder = () => __awaiter(void 0, void 0, void 0, function* () {
     let lightModulesPath;
     try {
@@ -143,7 +108,7 @@ export const findLightModulesFolder = (p) => {
             next();
         });
         walker.on('end', function () {
-            return reject(new Error(i18nInstance.t("error-lm-not-found")));
+            return reject(new CreateError(i18nInstance.t("error-lm-not-found")));
         });
     });
 };
@@ -164,7 +129,7 @@ export const initializeNodeProject = () => __awaiter(void 0, void 0, void 0, fun
     yield handleMGNLConfigFile();
 });
 export const installCLI = () => __awaiter(void 0, void 0, void 0, function* () {
-    return yield installPackage(determinePackageManager(), "@magnolia/cli@preview", "mgnl-cli");
+    return yield installPackage(determinePackageManager(), "@magnolia/cli@5", "mgnl-cli");
 });
 export const installPackage = (packageManager, packageReference, packageName) => __awaiter(void 0, void 0, void 0, function* () {
     if (!packageName) {

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

@@ -18,7 +18,6 @@
   "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",
   "info-registered-commands": "Run \"npm run mgnl\" to see the list of registered commands",
   "info-start-project": "Start the project using: \"npm run mgnl -- start\"",
   "info-add-plugin-plugin": "If the \"StartPlugin\" is not available, install it using: \"npm run mgnl -- add-plugin @magnolia/cli-start-plugin\"",
@@ -47,7 +46,6 @@
   "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}}",

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magnolia/cli-jumpstart-plugin",
-  "version": "1.0.0-preview.9",
+  "version": "1.0.1",
   "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": {
@@ -31,7 +31,8 @@
     "@babel/parser": "^7.23.6",
     "@babel/traverse": "^7.24.1",
     "@babel/types": "^7.23.6",
-    "@magnolia/cli-plugin-template": "^1.1.0",
+    "@magnolia/cli-helper": "^1.0.0",
+    "@magnolia/cli-plugin-template": "^1.1.2",
     "axios": "^1.4.0",
     "commander": "^11.0.0",
     "decompress": "^4.2.1",
@@ -39,8 +40,6 @@
     "execa": "^7.2.0",
     "fs-extra": "^11.1.1",
     "glob": "^10.3.10",
-    "i18next": "^23.8.2",
-    "i18next-fs-backend": "^2.3.1",
     "inquirer": "^9.2.8",
     "js-beautify": "^1.14.9",
     "json5": "^2.2.3",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magnolia/cli-jumpstart-plugin",
-  "version": "1.0.0-preview.9",
+  "version": "1.0.1",
   "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": {
@@ -31,7 +31,8 @@
     "@babel/parser": "^7.23.6",
     "@babel/traverse": "^7.24.1",
     "@babel/types": "^7.23.6",
-    "@magnolia/cli-plugin-template": "^1.1.0",
+    "@magnolia/cli-helper": "^1.0.0",
+    "@magnolia/cli-plugin-template": "^1.1.2",
     "axios": "^1.4.0",
     "commander": "^11.0.0",
     "decompress": "^4.2.1",
@@ -39,8 +40,6 @@
     "execa": "^7.2.0",
     "fs-extra": "^11.1.1",
     "glob": "^10.3.10",
-    "i18next": "^23.8.2",
-    "i18next-fs-backend": "^2.3.1",
     "inquirer": "^9.2.8",
     "js-beautify": "^1.14.9",
     "json5": "^2.2.3",