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

package/README.md

@@ -27,21 +27,23 @@ When run, the plugin will prompt the user to select a template. It will then pro
 ### **command-line options**
 
 You can customize the **jumpstart** plugin's actions using these command-line options:
-- `-t, --template <name>`:  Choose template.
-- `-p, --projectTemplatesPath <path>`: Specify from where the projectTemplates should be loaded.
+- `-t, --template <name>`, choose a template from available project templates
+- `-p, --project-templates-path <path>`, specify the path to load project templates from
+- `-m, --magnolia-version <version>`, set the Magnolia version; defaults to the latest stable version
+- `-s, --snapshot`, download the latest snapshot version of the specified or latest stable webapp
 
 **Template option:**
 
 With this option, you can specify which template to use:
 
 ```bash
-magnolia-cli jumpstart --template "headless/minimal-headless-spa-demos/dx-core/latest"
+magnolia-cli jumpstart --template "headless/minimal-headless-spa-demos/dx-core"
 ```
 
 
 **Project templates list:**
 
-The **jumpstart** plugin relies on a list of predefined project templates stored in an external [repository](https://git.magnolia-cms.com/projects/SERVICES/repos/cli-project-templates/raw/projectTemplates.json). 
+The **jumpstart** plugin relies on a list of predefined project templates stored in an external [repository](https://bitbucket.org/magnolia-cms/cli-project-templates/raw/HEAD/projectTemplates.json). 
 You can specify your own project templates list with the *--project-templates-path* command:
 
 ```bash

package/dist/jumpstart-plugin.d.ts

@@ -9,10 +9,10 @@ export declare let i18nInstance: {
 export default class JumpstartPlugin extends PluginTemplate {
     name: string;
     version: any;
-    description: any;
     projectTemplates?: Array<Template>;
     options: Option[];
     credentials?: Credentials;
+    description: string;
     constructor();
     executePostCommands(bundle: Bundle, file: string): Promise<void>;
     handleTemplate(template: TemplateWithoutChildren, options: PluginOptions): Promise<void>;
@@ -20,6 +20,8 @@ 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,8 +19,10 @@ 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, installAdditionalPlugins } from "./lib/helper.js";
+import { askForCredentials, handleLightModulesFolder, initI18n, 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";
 const extensionsPath = path.resolve("./extensions/extension.yaml");
 export let logger;
 export let i18nInstance = {
@@ -31,11 +33,13 @@ export default class JumpstartPlugin extends PluginTemplate {
         super();
         this.name = "jumpstart";
         this.version = pkg.version;
-        this.description = pkg.description;
         i18nInstance = initI18n(this.name);
+        this.description = i18nInstance.t('cmd-option-description');
         this.options = [
             new Option('-t, --template <name>', i18nInstance.t("cmd-option-template")),
-            new Option('-p, --project-templates-path <path>', i18nInstance.t("cmd-option-project-templates-path"))
+            new Option('-p, --project-templates-path <path>', i18nInstance.t("cmd-option-project-templates-path")),
+            new Option('-m, --magnolia-version <version>', i18nInstance.t('cmd-option-magnolia-version')),
+            new Option('-s, --snapshot', i18nInstance.t('cmd-option-snapshot'))
         ];
     }
     executePostCommands(bundle, file) {
@@ -46,6 +50,7 @@ export default class JumpstartPlugin extends PluginTemplate {
                 switch (command) {
                     case PostCommands.Extract:
                     case PostCommands.ExtractAndOverride:
+                    case PostCommands.ExtractAndUnfold:
                         yield extract(bundle, file, command);
                         break;
                     case PostCommands.NpmInstall:
@@ -72,10 +77,10 @@ export default class JumpstartPlugin extends PluginTemplate {
                             bundle: bundle.name ? bundle.name : bundle.url
                         }));
                         const bundleCredentials = yield askForCredentials();
-                        file = yield downloadBundle(bundle, bundleCredentials, undefined);
+                        file = yield downloadBundle(bundle, bundleCredentials, undefined, options);
                     }
                     else {
-                        file = yield downloadBundle(bundle, this.credentials, undefined);
+                        file = yield downloadBundle(bundle, this.credentials, undefined, options);
                     }
                     if (file) {
                         yield this.executePostCommands(bundle, file);
@@ -88,7 +93,10 @@ export default class JumpstartPlugin extends PluginTemplate {
             yield handleLightModulesFolder();
             yield initializeNodeProject();
             if (template.plugins) {
-                yield installAdditionalPlugins(template.plugins, this.credentials);
+                yield installAdditionalPlugins(template.plugins);
+            }
+            if (template.configVars) {
+                yield addConfigProps(template.configVars);
             }
             const extensions = yield evaluateCustomPrompts(extensionsPath);
             if (extensions === null || extensions === void 0 ? void 0 : extensions.answers) {
@@ -104,22 +112,14 @@ export default class JumpstartPlugin extends PluginTemplate {
             var _a;
             try {
                 if ((_a = options.projectTemplatesPath) === null || _a === void 0 ? void 0 : _a.startsWith("http", 0)) {
-                    logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t('prompt-project-templates-credentials'));
-                    this.credentials = yield askForCredentials();
-                    const res = yield axios.get(options.projectTemplatesPath, {
-                        auth: this.credentials
-                    });
+                    const res = yield axios.get(options.projectTemplatesPath);
                     this.projectTemplates = res.data.projectTemplates;
                 }
                 else if (options.projectTemplatesPath) {
                     this.projectTemplates = requireFn(path.resolve(options.projectTemplatesPath)).projectTemplates;
                 }
                 else {
-                    logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t('prompt-project-templates-credentials'));
-                    this.credentials = yield askForCredentials();
-                    const res = yield axios.get("https://git.magnolia-cms.com/rest/api/latest/projects/SERVICES/repos/cli-project-templates/raw/projectTemplates.json", {
-                        auth: this.credentials
-                    });
+                    const res = yield axios.get("https://bitbucket.org/magnolia-cms/cli-project-templates/raw/HEAD/projectTemplates.json");
                     this.projectTemplates = res.data.projectTemplates;
                 }
             }
@@ -193,6 +193,19 @@ 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;
@@ -201,6 +214,7 @@ export default class JumpstartPlugin extends PluginTemplate {
     start(options) {
         return __awaiter(this, void 0, void 0, function* () {
             logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-jumpstart_started"));
+            this.checkFlagsArguments(options);
             yield this.setProjectTemplates(options);
             yield this.chooseTemplate(options);
         });

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

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

package/dist/lib/config-helper.js

@@ -10,21 +10,64 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import fs from "fs-extra";
 import parser from "@babel/parser";
 import t from "@babel/types";
+const generate = _generate.default;
+const traverse = _traverse.default;
 import beautifyModule from "js-beautify";
 import path from "path";
-import { determinePackageManager, extractRepoName, installPackage, isValidURL } from "./helper.js";
+import { determinePackageManager, installPackage } from "./helper.js";
 import ora from "ora";
 import { i18nInstance, logger } from "../jumpstart-plugin.js";
+import _generate from "@babel/generator";
+import _traverse from "@babel/traverse";
+import { execa } from "execa";
+import JSON5 from "json5";
 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
+    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* () {
+    const pm = determinePackageManager();
+    const addPluginExists = yield execa(pm, 'run mgnl -s -- add-plugin -v'.split(' '), { cwd: process.cwd() });
+    if (addPluginExists.exitCode !== 0 || !addPluginExists.stdout.match(/(\d.)+(\d).*/)) {
+        logger.warn(i18nInstance.t("warn-config-h-no-add-plugin"));
+        let installPluginsText = "";
+        plugins.forEach(plugin => {
+            installPluginsText = `${installPluginsText} - ${plugin.plugin}\n`;
+            if (plugin.pluginArgs) {
+                installPluginsText = `${installPluginsText}${i18nInstance.t("install-plugin-with-args-text", { pluginArgs: JSON5.stringify(plugin.pluginArgs) })}`;
+            }
+        });
+        logger.warn(i18nInstance.t("warn-config-h-install-plugins-manually", { installPluginsText: installPluginsText }));
+        return;
+    }
+    for (const plugin of plugins) {
+        try {
+            const addPluginArgs = `run mgnl -s -- add-plugin ${plugin.plugin}`.split(' ');
+            try {
+                if (plugin.pluginArgs !== undefined && plugin.pluginArgs !== 'undefined' && plugin.pluginArgs !== '') {
+                    addPluginArgs.push(JSON5.stringify(JSON5.parse(JSON5.stringify(plugin.pluginArgs))));
+                }
+            }
+            catch (e) {
+                logger.warn(i18nInstance.t('warn-config-h-error-cannot-parse-plugin-args', { pluginArgs: plugin.pluginArgs }));
+            }
+            yield execa(pm, addPluginArgs, {
+                stdio: 'inherit',
+                cwd: process.cwd()
+            });
+        }
+        catch (e) {
+            logger.error(i18nInstance.t('error-config-h-while-add-plugin', { plugin: plugin }));
+        }
+    }
+});
 export const handleMGNLConfigFile = () => __awaiter(void 0, void 0, void 0, function* () {
     let isMgnlCliInstalled = true;
     if (!fs.existsSync(getPackageConfigPath())) {
@@ -44,18 +87,6 @@ export const handleMGNLConfigFile = () => __awaiter(void 0, void 0, void 0, func
         // the mgnl.config.js exist, do not do anything
     }
 });
-export const installAndConfigPlugins = (plugins, credentials) => __awaiter(void 0, void 0, void 0, function* () {
-    const localConfig = parseConfigFile(getLocalConfigPath());
-    if (!localConfig)
-        return;
-    const missingPlugins = findMissingPlugins(plugins, localConfig);
-    if (missingPlugins.length === 0)
-        return;
-    logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-config-h-will-install-missing-plugins"));
-    const installedPlugins = yield installPlugins(missingPlugins, credentials);
-    const pluginsConfig = createCustomConfigForPlugins(installedPlugins);
-    updateLocalConfig(pluginsConfig, localConfig);
-});
 const handleExistingConfigFile = () => {
     const localConfigContent = fs.readFileSync(getLocalConfigPath(), "utf8");
     const packageConfigContent = fs.readFileSync(getPackageConfigPath(), "utf8");
@@ -77,7 +108,7 @@ function createMgnlConfigFile() {
         : '';
     const mgnlConfigSufix = `
     // Here you can add plugins you want to use with MGNL CLI
-    commands: []
+    plugins: []
     };`;
     const mgnlConfigContent = mgnlConfigPrefix + logger + mgnlConfigSufix;
     writeConfigContent(mgnlConfigContent);
@@ -86,7 +117,7 @@ function createSimpleMgnlConfigFile() {
     const mgnlConfigContent = `
     export default {
     // Here you can add plugins you want to use with MGNL CLI
-    commands: []
+    plugins: []
     };`;
     writeConfigContent(mgnlConfigContent);
 }
@@ -100,141 +131,80 @@ const extractLoggerConfig = (content) => {
     const loggerRegex = /(logger\s*:\s*{[^}]*})/s;
     return loggerRegex.exec(content);
 };
-const findMissingPlugins = (plugins, config) => {
-    return plugins.filter(plugin => {
-        let packageName = plugin.name;
-        return !config.imports.some(customImport => customImport.importedNames === packageName);
-    });
-};
-const installPlugins = (plugins, credentials) => __awaiter(void 0, void 0, void 0, function* () {
-    const packageManager = determinePackageManager();
-    let installedPlugins = [];
-    for (const plugin of plugins) {
-        const installed = yield installPackage(packageManager, plugin.installReference, plugin.name, credentials);
-        if (installed)
-            installedPlugins.push(plugin);
-    }
-    return installedPlugins;
-});
-const extractPackageName = (installReference) => {
-    // Use a regular expression to match the package name.
-    const regex = /^(?:@([^/]+)\/)?([^@]+)/;
-    const match = installReference.match(regex);
-    if (!match)
-        return null;
-    // Construct package name. If it's a scoped package, prepend the scope.
-    return match[1] ? `@${match[1]}/${match[2]}` : match[2];
-};
-const createCustomConfigForPlugins = (plugins) => {
-    const defaultConfig = { configContent: "", imports: [], commands: [] };
-    plugins.forEach(plugin => {
-        let importSource;
-        if (isValidURL(plugin.installReference)) {
-            importSource = extractRepoName(plugin.installReference);
-        }
-        if (!importSource) {
-            importSource = plugin.installReference;
-        }
-        defaultConfig.imports.push({ importedNames: plugin.name, importSource: extractPackageName(importSource) || importSource });
-        defaultConfig.commands.push({ commandName: plugin.name, options: plugin.options });
-    });
-    return defaultConfig;
-};
-const parseConfigFile = (configPath) => {
-    let configContent;
-    try {
-        configContent = fs.readFileSync(configPath, 'utf-8');
-    }
-    catch (e) {
-        logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-config-h-could-not-read-mgnl-config", {
-            configPath: configPath
-        }));
-        console.error(e);
-        return null;
-    }
-    let parsedConfig;
+const writeConfigContent = (content) => {
+    const spinner = ora().start(i18nInstance.t("ora-updating-mgnl-config"));
     try {
-        parsedConfig = parser.parse(configContent, { sourceType: 'module' });
+        fs.writeFileSync(getLocalConfigPath(), js_beautify(content.trim(), BEAUTIFY_OPTIONS), 'utf-8');
     }
     catch (e) {
-        logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-config-h-could-not-parse-mgnl-config", {
-            configPath: configPath
-        }));
+        spinner.stop();
+        logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-config-h-while-updating-mgnl-config"));
         console.error(e);
-        return null;
     }
-    if (!parsedConfig)
-        return null;
-    const { imports, commands } = extractImportsAndCommands(parsedConfig);
-    return { configContent, imports, commands };
+    spinner.stop();
+    logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-config-h-mgnl-config-updated"));
 };
-const extractImportsAndCommands = (ast) => {
-    const imports = [];
-    const commands = [];
-    ast.program.body.forEach(node => {
-        if (t.isImportDeclaration(node)) {
-            imports.push({
-                importedNames: node.specifiers.map(specifier => specifier.local.name).join(', '),
-                importSource: node.source.value
-            });
-        }
-        if (t.isExportDefaultDeclaration(node) && t.isObjectExpression(node.declaration)) {
-            node.declaration.properties.forEach(property => {
-                if (t.isObjectProperty(property) && t.isArrayExpression(property.value)) {
-                    property.value.elements.forEach(element => {
-                        if (t.isNewExpression(element) && t.isIdentifier(element.callee)) {
-                            commands.push({ commandName: element.callee.name });
+export const addConfigProps = (vars) => __awaiter(void 0, void 0, void 0, function* () {
+    const spinner = ora().start(i18nInstance.t("ora-adding-shared-vars"));
+    try {
+        const filePath = getLocalConfigPath();
+        let content = fs.readFileSync(filePath, 'utf-8');
+        const valueToAstNode = (value) => {
+            if (typeof value === 'string') {
+                return t.stringLiteral(value);
+            }
+            else if (typeof value === 'boolean') {
+                return t.booleanLiteral(value);
+            }
+            else if (typeof value === 'number') {
+                return t.numericLiteral(value);
+            }
+            else if (Array.isArray(value)) {
+                return t.arrayExpression(value.map(item => valueToAstNode(item)));
+            }
+            else if (typeof value === 'object') {
+                return t.objectExpression(Object.entries(value).map(([key, val]) => t.objectProperty(t.isValidIdentifier(key)
+                    ? t.identifier(key)
+                    : t.stringLiteral(key), valueToAstNode(val))));
+            }
+            else {
+                throw new TypeError('Unsupported type');
+            }
+        };
+        const ast = parser.parse(content, {
+            sourceType: 'module',
+            plugins: ['typescript'], // if you're using TypeScript
+            attachComment: true
+        });
+        let modificationsMade = false;
+        traverse(ast, {
+            ExportDefaultDeclaration({ node }) {
+                if (t.isObjectExpression(node.declaration)) {
+                    // Check each required property to see if it exists in the declaration
+                    Object.entries(vars).forEach(([key, value]) => {
+                        let propExists = node.declaration.properties.some((property) => t.isObjectProperty(property) &&
+                            ((t.isIdentifier(property.key) && property.key.name === key) ||
+                                (t.isStringLiteral(property.key) && property.key.value === key)));
+                        if (!propExists) {
+                            // If the property doesn't exist, add it
+                            node.declaration.properties.push(t.objectProperty(t.isValidIdentifier(key)
+                                ? t.identifier(key) : t.stringLiteral(key), valueToAstNode(value)));
+                            modificationsMade = true;
                         }
                     });
                 }
-            });
+            },
+        });
+        if (modificationsMade) {
+            const output = generate(ast, {}, content);
+            fs.writeFileSync(getLocalConfigPath(), js_beautify(output.code.trim(), BEAUTIFY_OPTIONS), 'utf-8');
+            spinner.stop();
+            logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-config-h-mgnl-vars-added"));
         }
-    });
-    return { imports, commands };
-};
-const updateLocalConfig = (defaultConfig, localConfig) => {
-    const getMissingItems = (defaultItems, customItems, comparator) => {
-        return defaultItems.filter(defaultItem => !customItems.some(customItem => comparator(defaultItem, customItem)));
-    };
-    const mergeImports = (customImports, missingImports) => {
-        return customImports.concat(missingImports)
-            .map(i => `import ${i.importedNames} from "${i.importSource}";`).join('\n');
-    };
-    const missingImports = getMissingItems(defaultConfig.imports, localConfig.imports, (a, b) => a.importSource === b.importSource);
-    const missingCommands = getMissingItems(defaultConfig.commands, localConfig.commands, (a, b) => a.commandName === b.commandName);
-    const mergedImports = mergeImports(localConfig.imports, missingImports);
-    const updatedConfigContent = mergeCommandsWithConfigContent(localConfig.configContent, missingCommands);
-    writeToLocalConfigFile(mergedImports, updatedConfigContent);
-};
-const formatOptions = (options) => {
-    if (!options)
-        return '()';
-    const formattedOptions = JSON.stringify(options, null);
-    return `(${formattedOptions})`;
-};
-const mergeCommandsWithConfigContent = (configContent, missingCommands) => {
-    const missingCommandsStr = missingCommands.map(c => `new ${c.commandName}${formatOptions(c.options)}`).join(',\n');
-    const commandsPattern = /(commands\s*:\s*\[)([^\]]*?)(,\s*)?(\])/;
-    return configContent.replace(commandsPattern, (match, p1, p2, p3, p4) => {
-        const separator = (p2.trim() !== "" && missingCommandsStr.trim() !== "") ? "," : "";
-        return `${p1}${p2}${separator}${missingCommandsStr}${p4}`;
-    });
-};
-const writeToLocalConfigFile = (mergedImports, updatedConfigContent) => {
-    const importPattern = /import .* from ['"].*['"];\s*/g;
-    const configContentWithImports = `${mergedImports}\n\n${updatedConfigContent.replace(importPattern, '')}`;
-    writeConfigContent(configContentWithImports);
-};
-const writeConfigContent = (content) => {
-    const spinner = ora().start(i18nInstance.t("ora-updating-mgnl-config"));
-    try {
-        fs.writeFileSync(getLocalConfigPath(), js_beautify(content.trim(), BEAUTIFY_OPTIONS), 'utf-8');
     }
     catch (e) {
         spinner.stop();
-        logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-config-h-while-updating-mgnl-config"));
+        logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-config-h-while-adding-vars"));
         console.error(e);
     }
-    spinner.stop();
-    logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-config-h-mgnl-config-updated"));
-};
+});

package/dist/lib/download.d.ts

@@ -1,4 +1,4 @@
-import { Bundle, Credentials } from "../types/types.js";
-export declare const downloadBundle: (bundle: Bundle, credentials: Credentials, dest: string | undefined) => Promise<string>;
-export declare const getDownloadUrl: (bundle: Bundle, credentials: Credentials) => Promise<string>;
+import { Bundle, Credentials, PluginOptions } from "../types/types.js";
+export declare const downloadBundle: (bundle: Bundle, credentials: Credentials, dest: string | undefined, options: PluginOptions) => Promise<string>;
+export declare const getDownloadUrl: (bundle: Bundle, credentials: Credentials, options: PluginOptions) => Promise<string>;
 export declare const selectTag: (url: string, credentials: Credentials) => Promise<string>;

package/dist/lib/download.js

@@ -13,7 +13,7 @@ import axios from "axios";
 import ProgressBar from "progress";
 import inquirer from "inquirer";
 import { i18nInstance, logger } from "../jumpstart-plugin.js";
-export const downloadBundle = (bundle, credentials, dest) => __awaiter(void 0, void 0, void 0, function* () {
+export const downloadBundle = (bundle, credentials, dest, options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         let url = bundle.url;
         const downloadDest = dest ? dest : "./download-" + new Date().getTime();
@@ -25,7 +25,7 @@ export const downloadBundle = (bundle, credentials, dest) => __awaiter(void 0, v
             downloadUrl = yield selectTag(url, credentials);
         }
         else if (url.includes('https://nexus.magnolia-cms.com/service/rest/v1/search')) {
-            downloadUrl = yield getDownloadUrl(bundle, credentials);
+            downloadUrl = yield getDownloadUrl(bundle, credentials, options);
         }
         else {
             downloadUrl = url;
@@ -84,7 +84,8 @@ export const downloadBundle = (bundle, credentials, dest) => __awaiter(void 0, v
         throw new Error(error);
     }
 });
-export const getDownloadUrl = (bundle, credentials) => __awaiter(void 0, void 0, void 0, function* () {
+export const getDownloadUrl = (bundle, credentials, options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d, _e;
     const opts = {
         method: 'get',
         responseType: 'json',
@@ -96,11 +97,54 @@ export const getDownloadUrl = (bundle, credentials) => __awaiter(void 0, void 0,
         opts.auth = credentials;
     }
     try {
-        const response = yield axios.get(bundle.url + '&prerelease=false', opts);
+        const url = new URL(bundle.url);
+        url.searchParams.set('prerelease', "false");
+        if (bundle.version) {
+            if (options.snapshot || bundle.version.toLowerCase().includes("snapshot")) {
+                url.searchParams.set('prerelease', "true");
+            }
+            if (options.magnoliaVersion) {
+                bundle.version = options.magnoliaVersion;
+                if (bundle.version.startsWith('6.3') && bundle.alternative) {
+                    url.searchParams.set('maven.groupId', bundle.alternative.groupId);
+                    url.searchParams.set('maven.artifactId', bundle.alternative.artifactId);
+                }
+            }
+            if (bundle.version.toLowerCase() !== "latest" && bundle.version.toLowerCase() !== "alpha" && bundle.version.toLowerCase() !== "beta") {
+                url.searchParams.set('maven.baseVersion', options.snapshot ? bundle.version + "-SNAPSHOT" : bundle.version);
+            }
+        }
+        const response = yield axios.get(url.toString(), opts);
         const params = new URLSearchParams(bundle.url.split("?")[1]);
-        let downloadUrl = response.data.items[0].downloadUrl;
+        let item = response.data.items[0];
+        if (((_a = bundle.version) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === "latest") {
+            item = response.data.items.find((item) => {
+                var _a;
+                const itemVersion = (_a = item === null || item === void 0 ? void 0 : item.maven2) === null || _a === void 0 ? void 0 : _a.version;
+                return !(itemVersion === null || itemVersion === void 0 ? void 0 : itemVersion.includes("-alpha")) && !(itemVersion === null || itemVersion === void 0 ? void 0 : itemVersion.includes("-beta"));
+            });
+        }
+        else if (((_b = bundle.version) === null || _b === void 0 ? void 0 : _b.toLowerCase()) === "alpha") {
+            item = response.data.items.find((item) => {
+                var _a;
+                const itemVersion = (_a = item === null || item === void 0 ? void 0 : item.maven2) === null || _a === void 0 ? void 0 : _a.version;
+                return itemVersion === null || itemVersion === void 0 ? void 0 : itemVersion.includes("-alpha");
+            });
+        }
+        else if (((_c = bundle.version) === null || _c === void 0 ? void 0 : _c.toLowerCase()) === "beta") {
+            item = response.data.items.find((item) => {
+                var _a;
+                const itemVersion = (_a = item === null || item === void 0 ? void 0 : item.maven2) === null || _a === void 0 ? void 0 : _a.version;
+                return itemVersion === null || itemVersion === void 0 ? void 0 : itemVersion.includes("-beta");
+            });
+        }
+        if (!item) {
+            throw new Error(i18nInstance.t('error-download-no-artifact-available', { version: bundle.version, interpolation: { escapeValue: false } }));
+        }
+        bundle.version = (_e = (_d = item === null || item === void 0 ? void 0 : item.maven2) === null || _d === void 0 ? void 0 : _d.version) !== null && _e !== void 0 ? _e : bundle.version;
+        let downloadUrl = item.downloadUrl;
         downloadUrl = downloadUrl === null || downloadUrl === void 0 ? void 0 : downloadUrl.split('/magnolia.');
-        downloadUrl = downloadUrl && `${downloadUrl[0]}/${params.get('repository')}/${response.data.items[0].path}`;
+        downloadUrl = downloadUrl && `${downloadUrl[0]}/${params.get('repository')}${item.path}`;
         return downloadUrl;
     }
     catch (error) {
@@ -110,11 +154,11 @@ export const getDownloadUrl = (bundle, credentials) => __awaiter(void 0, void 0,
             }));
             logger === null || logger === void 0 ? void 0 : logger.error(i18nInstance.t("error-download-unable-to-get-local-issuer-certificate"));
         }
-        throw new Error(error);
+        throw new Error(error.message);
     }
 });
 export const selectTag = (url, credentials) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
+    var _f;
     const opts = {
         method: 'get',
         headers: {
@@ -125,7 +169,7 @@ export const selectTag = (url, credentials) => __awaiter(void 0, void 0, void 0,
         opts.auth = credentials;
     }
     const res = yield axios.get(url, opts);
-    if (!((_a = res.data) === null || _a === void 0 ? void 0 : _a.values) || res.data.values.length <= 0) {
+    if (!((_f = res.data) === null || _f === void 0 ? void 0 : _f.values) || res.data.values.length <= 0) {
         throw new Error(i18nInstance.t("error-download-no-tags"));
     }
     const { tag } = yield inquirer

package/dist/lib/extract.js

@@ -14,6 +14,7 @@ import fs from "fs-extra";
 import { PostCommands } from "../types/types.js";
 import url from "url";
 import { i18nInstance, logger } from "../jumpstart-plugin.js";
+import { handleMicroprofileConfig } from "./handleMicroprofileConfig.js";
 export const extract = (bundle, file, command) => __awaiter(void 0, void 0, void 0, function* () {
     var _a;
     logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t("info-extract-extracting"));
@@ -28,7 +29,16 @@ export const extract = (bundle, file, command) => __awaiter(void 0, void 0, void
         yield extractApacheTomcat(dest, unzipFolder);
     }
     else {
-        fs.copySync(unzipFolder, dest, { overwrite: true });
+        let sourceFolder = unzipFolder;
+        if (command === PostCommands.ExtractAndUnfold) {
+            const firstDir = fs.readdirSync(unzipFolder).find(item => {
+                const itemPath = path.join(unzipFolder, item);
+                return fs.statSync(itemPath).isDirectory();
+            });
+            sourceFolder = firstDir ? path.join(unzipFolder, firstDir) : unzipFolder;
+        }
+        fs.copySync(sourceFolder, dest, { overwrite: true });
+        yield handleMicroprofileConfig(bundle, dest);
     }
     fs.rmSync(unzipFolder, { recursive: true, force: true });
     fs.rmSync(path.dirname(file), { recursive: true, force: true });

package/dist/lib/handleMicroprofileConfig.d.ts

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

package/dist/lib/handleMicroprofileConfig.js

@@ -0,0 +1,61 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fs from "fs";
+import path from "path";
+import { getMicroprofileConfigLocation } from "./helper.js";
+import { i18nInstance, logger } from "../jumpstart-plugin.js";
+export const handleMicroprofileConfig = (bundle, dest) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    if (!((_a = bundle.version) === null || _a === void 0 ? void 0 : _a.startsWith("6.3")))
+        return;
+    const tomcatPath = path.join(path.resolve(dest), '../../');
+    const webappName = path.basename(dest);
+    const pathToMicroprofileConfig = getMicroprofileConfigLocation(tomcatPath, webappName);
+    processMicroprofileConfigFile(pathToMicroprofileConfig);
+});
+export function convertObjectToProperties(obj) {
+    const props = [];
+    Object.keys(obj).forEach((key) => {
+        const val = obj[key];
+        if (val && typeof val === 'object' && !Array.isArray(val)) {
+            const children = convertObjectToProperties(val);
+            for (const child of children) {
+                props.push(key + '.' + child);
+            }
+        }
+        else {
+            props.push(key + '=' + val);
+        }
+    });
+    return props;
+}
+function createMicroprofileConfigFile(file) {
+    const microprofileConfig = {
+        magnolia: {
+            publishing: {
+                'receivers[0]': {
+                    name: 'magnoliaPublic8080',
+                    url: 'http://localhost:8080/magnoliaPublic',
+                    enabled: true
+                }
+            }
+        }
+    };
+    logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t('create-microprofile--info-creating-file', { file }));
+    return fs.writeFileSync(file, convertObjectToProperties(microprofileConfig).join('\n'), 'utf8');
+}
+function processMicroprofileConfigFile(file) {
+    if (fs.existsSync(file)) {
+        logger === null || logger === void 0 ? void 0 : logger.info(i18nInstance.t('create-microprofile--info-file-exists-skipping'));
+    }
+    else {
+        createMicroprofileConfigFile(file);
+    }
+}

package/dist/lib/helper.d.ts

@@ -1,13 +1,14 @@
-import { Credentials, PluginRequirement } from "../types/types.js";
+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[];
-export declare const installAdditionalPlugins: (plugins: Array<PluginRequirement>, credentials?: Credentials) => Promise<void>;
 export declare const initializeNodeProject: () => Promise<void>;
 export declare const installPackage: (packageManager: string, packageReference: string, packageName?: string, credentials?: Credentials) => Promise<boolean>;
 export declare const isValidURL: (str: string) => boolean;
 export declare const extractRepoName: (gitUrl: string) => string | null;
 export declare const determinePackageManager: (baseDirectory?: string) => "yarn" | "npm";
 export declare const askForCredentials: () => Promise<Credentials>;
+export declare function getWebAppConfigDefaultFolderLocation(tomcatFolder: string, instance: string): string;
+export declare function getMicroprofileConfigLocation(tomcatFolder: string, instance: string): string;

package/dist/lib/helper.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { handleMGNLConfigFile, installAndConfigPlugins } from "./config-helper.js";
+import { handleMGNLConfigFile } from "./config-helper.js";
 import { handlePackageJSON } from "./pj-helper.js";
 import i18next from "i18next";
 import Backend from 'i18next-fs-backend';
@@ -160,9 +160,6 @@ export const findWebAppsList = (apacheTomcatPath) => {
     }
     return webApps;
 };
-export const installAdditionalPlugins = (plugins, credentials) => __awaiter(void 0, void 0, void 0, function* () {
-    yield installAndConfigPlugins(plugins, credentials);
-});
 export const initializeNodeProject = () => __awaiter(void 0, void 0, void 0, function* () {
     yield handlePackageJSON();
     yield handleMGNLConfigFile();
@@ -238,3 +235,9 @@ export const askForCredentials = () => __awaiter(void 0, void 0, void 0, functio
         }
     ]);
 });
+export function getWebAppConfigDefaultFolderLocation(tomcatFolder, instance) {
+    return path.join(tomcatFolder, 'webapps', instance, 'WEB-INF', 'config', 'default');
+}
+export function getMicroprofileConfigLocation(tomcatFolder, instance) {
+    return path.join(getWebAppConfigDefaultFolderLocation(tomcatFolder, instance), 'microprofile-config.properties');
+}

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

@@ -1,15 +1,18 @@
 {
-  "cmd-option-template": "Choose template",
-  "cmd-option-project-templates-path": "Specify from where the projectTemplates should be loaded",
+  "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",
 
   "prompt-enter-credentials": "Please enter credentials for {{bundle}}",
-  "prompt-project-templates-credentials": "Please enter credentials",
 
   "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-download-starting": "Starting download from: {{downloadUrl}}",
   "info-download-finished": "Download finished",
@@ -28,16 +31,22 @@
   "info-helper-package-installed": "{{packageName}} installed",
 
   "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.",
 
   "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.",
@@ -51,11 +60,18 @@
   "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-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-installing-package": "Installing {{packageName}}",
+
+  "install-plugin-with-args-text": "\twith following args: {{pluginArgs}}\n",
+
+  "create-microprofile--info-file-exists-skipping": "File microprofile-config.properties already exists. Skipping...",
+  "create-microprofile--info-creating-file": "Creating microprofile-config.properties at {{file}}"
 }

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magnolia/cli-jumpstart-plugin",
-  "version": "1.0.0-preview.4",
+  "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.",
   "main": "dist/index.js",
   "scripts": {
@@ -28,7 +28,9 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
+    "@babel/generator": "^7.24.4",
     "@babel/parser": "^7.23.6",
+    "@babel/traverse": "^7.24.1",
     "@babel/types": "^7.23.6",
     "@magnolia/cli-plugin-template": "^1.1.0",
     "axios": "^1.4.0",
@@ -43,6 +45,7 @@
     "i18next-fs-backend": "^2.3.1",
     "inquirer": "^9.2.8",
     "js-beautify": "^1.14.9",
+    "json5": "^2.2.3",
     "ora": "^7.0.1",
     "progress": "^2.0.3",
     "underscore": "^1.13.6",

package/dist/types/types.d.ts

@@ -1,6 +1,8 @@
 export interface PluginOptions {
     template: string | boolean;
     projectTemplatesPath: string;
+    magnoliaVersion?: string;
+    snapshot?: boolean;
 }
 export interface Bundle {
     url: string;
@@ -10,6 +12,11 @@ export interface Bundle {
     dest?: string;
     downloadDest?: string;
     name?: string;
+    version?: string;
+    alternative: {
+        groupId: string;
+        artifactId: string;
+    };
 }
 export interface TemplateBase {
     name: string;
@@ -19,28 +26,33 @@ export interface TemplateWithChildren extends TemplateBase {
     children: Array<Template>;
     bundles?: never;
     plugins?: never;
+    configVars?: never;
 }
 export interface TemplateWithBundles extends TemplateBase {
     bundles: Array<Bundle>;
     children?: never;
     plugins?: never;
+    configVars?: never;
 }
 export interface TemplateWithPlugins extends TemplateBase {
     plugins: Array<PluginRequirement>;
     bundles?: never;
     children?: never;
+    configVars?: never;
 }
 export interface TemplateWithBundlesAndPlugins extends TemplateBase {
     bundles: Array<Bundle>;
     plugins: Array<PluginRequirement>;
     children?: never;
+    configVars?: {
+        [key: string]: any;
+    };
 }
 export type TemplateWithoutChildren = TemplateWithBundles | TemplateWithPlugins | TemplateWithBundlesAndPlugins;
 export type Template = TemplateWithChildren | TemplateWithoutChildren;
 export interface PluginRequirement {
-    name: string;
-    installReference: string;
-    options?: any;
+    plugin: string;
+    pluginArgs?: any;
 }
 export type Credentials = {
     username: string;
@@ -49,26 +61,10 @@ export type Credentials = {
 export declare enum PostCommands {
     Extract = "extract",
     ExtractAndOverride = "extract and override",
+    ExtractAndUnfold = "extract and unfold",
     NpmInstall = "npm install",
     YarnInstall = "yarn install"
 }
-export interface PluginRequirement {
-    name: string;
-    installReference: string;
-}
-export type ImportItem = {
-    importedNames: string;
-    importSource: string;
-};
-export interface CommandItem {
-    commandName: string;
-    options?: any;
-}
-export type ParsedConfigData = {
-    configContent: string;
-    imports: ImportItem[];
-    commands: CommandItem[];
-};
 export interface PostCommandFunction {
     function: string;
     delay: number;

package/dist/types/types.js

@@ -2,6 +2,7 @@ export var PostCommands;
 (function (PostCommands) {
     PostCommands["Extract"] = "extract";
     PostCommands["ExtractAndOverride"] = "extract and override";
+    PostCommands["ExtractAndUnfold"] = "extract and unfold";
     PostCommands["NpmInstall"] = "npm install";
     PostCommands["YarnInstall"] = "yarn install";
 })(PostCommands || (PostCommands = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magnolia/cli-jumpstart-plugin",
-  "version": "1.0.0-preview.4",
+  "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.",
   "main": "dist/index.js",
   "scripts": {
@@ -28,7 +28,9 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
+    "@babel/generator": "^7.24.4",
     "@babel/parser": "^7.23.6",
+    "@babel/traverse": "^7.24.1",
     "@babel/types": "^7.23.6",
     "@magnolia/cli-plugin-template": "^1.1.0",
     "axios": "^1.4.0",
@@ -43,6 +45,7 @@
     "i18next-fs-backend": "^2.3.1",
     "inquirer": "^9.2.8",
     "js-beautify": "^1.14.9",
+    "json5": "^2.2.3",
     "ora": "^7.0.1",
     "progress": "^2.0.3",
     "underscore": "^1.13.6",