@scandipwa/magento-scripts 1.12.0-alpha.0 → 1.13.0-alpha.0

package/lib/config/check-configuration-file.js

@@ -11,18 +11,12 @@ const setConfigFile = require('../util/set-config');
  */
 const checkConfigurationFile = () => ({
     title: 'Checking configuration file',
-    task: async (ctx) => {
+    task: async (ctx, task) => {
         const { projectPath = process.cwd() } = ctx;
         const { cacheDir, templateDir } = getBaseConfig(projectPath);
         const configJSFilePath = path.join(projectPath, 'cma.js');
         const magentoConfigFilePath = path.join(cacheDir, 'app-config.json');
 
-        if (ctx.edition) {
-            if (!['community', 'enterprise'].includes(ctx.edition)) {
-                throw new Error(`Magento edition "${ctx.edition}" does not exists or not supported!`);
-            }
-        }
-
         if (!await pathExists(configJSFilePath)) {
             const legacyMagentoConfigExists = await pathExists(magentoConfigFilePath);
 
@@ -35,8 +29,16 @@ const checkConfigurationFile = () => ({
 
                 magentoConfiguration = legacyMagentoConfig.magento || legacyMagentoConfig;
             } else {
+                const magentoEdition = await task.prompt({
+                    type: 'Select',
+                    message: `Please select Magento edition you want to install.
+
+Note that Enterprise edition requires Magento Enterprise License keys.`,
+                    choices: ['Community', 'Enterprise']
+                });
+
                 magentoConfiguration = deepmerge(defaultMagentoConfig, {
-                    edition: ctx.edition || 'community'
+                    edition: magentoEdition.toLowerCase()
                 });
             }
 

package/lib/config/dependencies-for-platforms.js

@@ -86,7 +86,6 @@ const dependenciesForPlatforms = {
             'libreadline-dev',
             'libsodium-dev',
             'libsqlite3-dev',
-            'libssl-dev',
             'libxml2-dev',
             ['libxslt-dev', 'libxslt1-dev'],
             'libonig-dev',

package/lib/config/index.js

@@ -4,10 +4,10 @@ const {
     getConfigurations,
     defaultConfiguration
 } = require('./versions');
-const getPhpConfig = require('./php');
+const getPhpConfig = require('./php-config');
 const getComposerConfig = require('./composer');
 const { getMagentoConfig } = require('./magento-config');
-const { getPhpStormConfig } = require('./php-storm');
+const { getPhpStormConfig } = require('./phpstorm/debug-config');
 const resolveConfigurationWithOverrides = require('../util/resolve-configuration-with-overrides');
 const { getPrefix, folderName } = require('../util/prefix');
 

package/lib/config/phpbrew.js

@@ -0,0 +1,12 @@
+const os = require('os');
+const path = require('path');
+
+const homePath = process.env.PHPBREW_HOME || path.join(os.homedir(), '.phpbrew');
+const phpbrewConfig = {
+    homePath,
+    buildPath: path.join(homePath, 'build'),
+    phpPath: path.join(homePath, 'php'),
+    bashrcPath: path.join(homePath, 'bashrc')
+};
+
+module.exports = phpbrewConfig;

package/lib/config/templates/vscode-launch.template.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Listen for XDebug",
+            "type": "php",
+            "request": "launch",
+            "port": <%~ it.XDebugPort %>,
+            "runtimeExecutable": "<%~ it.PHPBinPath %>"
+        }
+    ]
+}

package/lib/config/versions/magento-2.3.0.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.1.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.2-p2.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.2.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.3-p1.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.3.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.4-p2.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.4.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.5-p1.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.5-p2.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.5.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.6-p1.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.6.js

@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.7-p1.js

@@ -5,7 +5,7 @@ module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.7-p1',
     configuration: {
         php: {
-            version: '7.4.13',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.3.7.js

@@ -5,7 +5,7 @@ module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.3.7',
     configuration: {
         php: {
-            version: '7.4.13',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '2.9.8'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.0-p1.js

@@ -5,7 +5,7 @@ module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.0-p1',
     configuration: {
         php: {
-            version: '7.4.16',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.0.js

@@ -5,7 +5,7 @@ module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.0',
     configuration: {
         php: {
-            version: '7.4.16',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.1-p1.js

@@ -6,7 +6,7 @@ module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.1-p1',
     configuration: {
         php: {
-            version: '7.4.16',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -17,7 +17,7 @@ module.exports = ({ templateDir } = {}) => ({
                 SimpleXML: {},
                 libsodium,
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.1.js

@@ -5,7 +5,7 @@ module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.1',
     configuration: {
         php: {
-            version: '7.4.13',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -15,7 +15,7 @@ module.exports = ({ templateDir } = {}) => ({
                 sockets: {},
                 SimpleXML: {},
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.2-p1.js

@@ -7,7 +7,7 @@ module.exports = ({ templateDir } = {}) => ({
     isDefault: true,
     configuration: {
         php: {
-            version: '7.4.18',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -19,7 +19,7 @@ module.exports = ({ templateDir } = {}) => ({
                 libsodium,
                 fileinfo: {},
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.2-p2.js

@@ -7,7 +7,7 @@ module.exports = ({ templateDir } = {}) => ({
     isDefault: true,
     configuration: {
         php: {
-            version: '7.4.18',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -19,7 +19,7 @@ module.exports = ({ templateDir } = {}) => ({
                 libsodium,
                 fileinfo: {},
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.2.js

@@ -6,7 +6,7 @@ module.exports = ({ templateDir } = {}) => ({
     magentoVersion: '2.4.2',
     configuration: {
         php: {
-            version: '7.4.18',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -18,7 +18,7 @@ module.exports = ({ templateDir } = {}) => ({
                 libsodium,
                 fileinfo: {},
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.3-p1.js

@@ -7,7 +7,7 @@ module.exports = ({ templateDir } = {}) => ({
     isDefault: true,
     configuration: {
         php: {
-            version: '7.4.18',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -19,7 +19,7 @@ module.exports = ({ templateDir } = {}) => ({
                 libsodium,
                 fileinfo: {},
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/config/versions/magento-2.4.3.js

@@ -7,7 +7,7 @@ module.exports = ({ templateDir } = {}) => ({
     isDefault: true,
     configuration: {
         php: {
-            version: '7.4.18',
+            version: '7.4.27',
             configTemplate: path.join(templateDir || '', 'php.template.ini'),
             extensions: {
                 gd: {},
@@ -19,7 +19,7 @@ module.exports = ({ templateDir } = {}) => ({
                 libsodium,
                 fileinfo: {},
                 xdebug: {
-                    version: '3.0.4'
+                    version: '3.1.2'
                 }
             }
         },

package/lib/tasks/composer/index.js

@@ -1,4 +1,5 @@
 const fs = require('fs');
+const path = require('path');
 const semver = require('semver');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const downloadFile = require('../../util/download-file');
@@ -8,6 +9,7 @@ const safeRegexExtract = require('../../util/safe-regex-extract');
 const installPrestissimo = require('./install-prestissimo');
 
 /**
+ * @param {import('../../../typings/context').ListrContext['config']} param0
  * @returns {Promise<string>}
  */
 const getComposerVersion = async ({ composer, php }) => {
@@ -17,13 +19,23 @@ const getComposerVersion = async ({ composer, php }) => {
         string: composerVersionOutput,
         regex: /Composer version ([\d.]+)/i,
         onNoMatch: () => {
-            throw new Error(`No composer version found in composer version output!\n\n${composerVersionOutput}`);
+            throw new Error(`
+No composer version found in composer version output!\n\n${composerVersionOutput}
+
+Follow steps below to resolve this issue:
+1. Check ${logger.style.file(path.relative(process.cwd(), composer.binPath))} file content, inside this file should be Composer PHP code.
+2. If file content is not correct, try deleting this file and run ${logger.style.command('start')} command again, CMA will try re-download this file.
+3. If steps above didn't help, manually download Composer version ${composer.version} from ${logger.style.code('https://getcomposer.org/download/')} and put it inside cache directory ${logger.style.file(path.relative(process.cwd(), composer.dirPath))} with ${logger.style.code('composer.phar')} file name.
+`);
         }
     });
 
     return composerVersion;
 };
 
+/**
+ * @param {import('../../../typings/context').ListrContext['config']} param0
+ */
 const createComposerDir = async ({ composer }) => {
     const dirExists = await pathExists(composer.dirPath);
     if (!dirExists) {
@@ -31,9 +43,16 @@ const createComposerDir = async ({ composer }) => {
     }
 };
 
+/**
+ * @param {import('../../../typings/context').ListrContext['config']} param0
+ */
 const downloadComposerBinary = async ({ composer }) => {
+    const composerVersion = /^\d$/.test(composer.version)
+        ? `latest-${composer.version}.x`
+        : composer.version;
+
     try {
-        await downloadFile(`https://getcomposer.org/download/latest-${composer.version}.x/composer.phar`, {
+        await downloadFile(`https://getcomposer.org/download/${composerVersion}/composer.phar`, {
             destination: composer.binPath
         });
     } catch (e) {
@@ -59,11 +78,14 @@ const installComposer = () => ({
             await downloadComposerBinary({ composer });
         } else {
             const currentComposerVersion = await getComposerVersion({ composer, php });
+            const expectedComposerVersion = /^\d$/.test(composer.version)
+                ? `${composer.version}.x`
+                : composer.version;
 
-            if (!semver.satisfies(currentComposerVersion, `${composer.version}.x`)) {
+            if (!semver.satisfies(currentComposerVersion, expectedComposerVersion)) {
                 const continueComposerBinaryVersionSwitch = await task.prompt({
                     type: 'Select',
-                    message: `You have Composer ${logger.style.misc(`${currentComposerVersion}`)} while your Magento version requires ${logger.style.misc(`${composer.version}.x`)}!`,
+                    message: `You have Composer ${logger.style.misc(`${currentComposerVersion}`)} while your Magento version requires ${logger.style.misc(expectedComposerVersion)}!`,
                     choices: [
                         {
                             message: `Continue with current installed version (${logger.style.misc(`${currentComposerVersion}`)})`,
@@ -86,7 +108,7 @@ const installComposer = () => ({
                     break;
                 }
                 case 'exit': {
-                    throw new Error(`Current composer version ${logger.style.misc(`v${currentComposerVersion}`)} is not compatible with version ${logger.style.misc(`${composer.version}.x`)}!`);
+                    throw new Error(`Current composer version ${logger.style.misc(`v${currentComposerVersion}`)} is not compatible with version ${logger.style.misc(expectedComposerVersion)}!`);
                 }
                 case 'continue':
                 default: {

package/lib/tasks/file-system/create-vscode-config.js

@@ -0,0 +1,111 @@
+const path = require('path');
+const semver = require('semver');
+const fs = require('fs');
+const os = require('os');
+const hjson = require('hjson');
+const pathExists = require('../../util/path-exists');
+const setConfigFile = require('../../util/set-config');
+
+const phpXDebug2port = 9111;
+const phpXDebug3port = 9003;
+const listenForXDebugConfigName = 'Listen for XDebug';
+
+const vscodeLaunchConfigPath = path.join(process.cwd(), '.vscode', 'launch.json');
+
+/**
+ * @param {import('../../../typings/context').ListrContext['config']['php']} php
+ */
+const getCurrentXDebugPort = (php) => (semver.satisfies(php.extensions.xdebug.version, '>=3')
+    ? phpXDebug3port
+    : phpXDebug2port);
+
+/**
+ * @param {import('../../../typings/context').ListrContext['config']['php']} php
+ */
+const getPHPBinPathWithHomeVariable = (php) => php.binPath.replace(os.homedir(), '$HOME');
+/**
+ * @param {import('../../../typings/context').ListrContext['config']['php']} php
+ */
+const addPHPDebugConfig = (vscodeLaunchConfig, php) => {
+    const phpXDebugConfig = vscodeLaunchConfig.configurations.find(
+        ({ name }) => name === listenForXDebugConfigName
+    );
+
+    const phpXDebugPort = getCurrentXDebugPort(php);
+    const phpBingPath = getPHPBinPathWithHomeVariable(php);
+
+    if (!phpXDebugConfig) {
+        vscodeLaunchConfig.configurations.push({
+            name: listenForXDebugConfigName,
+            type: 'php',
+            request: 'launch',
+            port: phpXDebugPort,
+            runtimeExecutable: phpBingPath
+        });
+
+        return true;
+    }
+
+    if (
+        phpXDebugConfig.port !== phpXDebugPort
+        && phpXDebugConfig.runtimeExecutable !== phpBingPath
+    ) {
+        phpXDebugConfig.port = phpXDebugPort;
+        phpXDebugConfig.runtimeExecutable = phpBingPath;
+
+        return true;
+    }
+
+    return false;
+};
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const createPhpFpmConfig = () => ({
+    title: 'Setting VSCode config',
+    task: async ({ config: { php, baseConfig } }, task) => {
+        if (await pathExists(vscodeLaunchConfigPath)) {
+            const vscodeLaunchConfig = hjson.parse(await fs.promises.readFile(vscodeLaunchConfigPath, 'utf-8'), {
+                keepWsc: true
+            });
+
+            const vscodeConfigEdited = addPHPDebugConfig(vscodeLaunchConfig, php);
+
+            // if vscode config is up-to-date, skip task
+            if (!vscodeConfigEdited) {
+                task.skip();
+                return;
+            }
+
+            await fs.promises.writeFile(vscodeLaunchConfigPath, hjson.stringify(vscodeLaunchConfig));
+
+            return;
+        }
+
+        if (!await pathExists(path.join(process.cwd(), '.vscode'))) {
+            try {
+                await fs.promises.mkdir(path.join(process.cwd(), '.vscode'));
+            } catch (e) {
+                throw new Error(`Unable to creade .vscode directory in your project!\n\n${e}`);
+            }
+        }
+
+        try {
+            const phpXDebugPort = getCurrentXDebugPort(php);
+            const vscodeLaunchConfigTemplatePath = path.join(baseConfig.templateDir, 'vscode-launch.template.json');
+            await setConfigFile({
+                template: vscodeLaunchConfigTemplatePath,
+                configPathname: vscodeLaunchConfigPath,
+                templateArgs: {
+                    XDebugPort: phpXDebugPort,
+                    PHPBinPath: getPHPBinPathWithHomeVariable(php)
+                }
+            });
+        } catch (e) {
+            throw new Error(`Unexpected error accrued during launch.json config creation!\n\n${e}`);
+        }
+    }
+});
+
+module.exports = createPhpFpmConfig;