@scandipwa/magento-scripts 1.16.1 → 2.0.0-alpha.10

package/lib/config/index.js

@@ -5,7 +5,6 @@ const {
     defaultConfiguration
 } = require('./versions');
 const getPhpConfig = require('./php-config');
-const getComposerConfig = require('./composer');
 const { getMagentoConfig } = require('./magento-config');
 const resolveConfigurationWithOverrides = require('../util/resolve-configuration-with-overrides');
 const { getPrefix, folderName } = require('../util/prefix');
@@ -15,11 +14,12 @@ const platforms = ['linux', 'darwin'];
 const darwinMinimalVersion = '10.5';
 
 /**
- * @returns {{prefix: string,magentoDir: string,templateDir: string,cacheDir: string}}
+ * @returns {import('../../typings/context').ListrContext['config']['baseConfig']}
  */
 const getBaseConfig = (projectPath = process.cwd(), prefix = folderName) => ({
     prefix: getPrefix(prefix),
     magentoDir: projectPath,
+    containerMagentoDir: projectPath,
     templateDir: path.join(__dirname, 'templates'),
     cacheDir: path.join(projectPath, 'node_modules', '.create-magento-app-cache')
 });
@@ -27,14 +27,19 @@ const getBaseConfig = (projectPath = process.cwd(), prefix = folderName) => ({
 const baseConfig = getBaseConfig();
 
 const magento = {
-    binPath: path.join(baseConfig.magentoDir, 'bin', 'magento')
+    binPath: path.join(baseConfig.magentoDir, 'bin', 'magento'),
+    containerBinPath: path.join(baseConfig.containerMagentoDir, 'bin', 'magento')
 };
 
 module.exports = {
     /**
      * @param {string} magentoVersion
      */
-    async getConfigFromMagentoVersion(magentoVersion, projectPath = process.cwd(), prefix = folderName) {
+    async getConfigFromMagentoVersion(ctx, {
+        magentoVersion,
+        projectPath = process.cwd(),
+        prefix = folderName
+    }) {
         const newBaseConfig = getBaseConfig(projectPath, prefix);
         const configurations = getConfigurations(newBaseConfig);
         if (!configurations[magentoVersion]) {
@@ -52,8 +57,7 @@ module.exports = {
 
         return {
             php: getPhpConfig(overridenConfiguration.configuration, newBaseConfig),
-            docker: await getDockerConfig(overridenConfiguration, newBaseConfig),
-            composer: getComposerConfig(overridenConfiguration.configuration, newBaseConfig),
+            docker: await getDockerConfig(ctx, overridenConfiguration, newBaseConfig),
             magentoConfiguration: getMagentoConfig(overridenConfiguration.magento),
             baseConfig: newBaseConfig,
             overridenConfiguration,
@@ -65,7 +69,6 @@ module.exports = {
     getBaseConfig,
     magento,
     platforms,
-    docker: getDockerConfig(defaultConfiguration, baseConfig),
     darwinMinimalVersion,
     defaultConfiguration
 };

package/lib/config/magento/required-php-extensions/index.js

@@ -0,0 +1,29 @@
+const magento23RequiredPHPExtensions = require('./magento-2.3');
+const magento24RequiredPHPExtensions = require('./magento-2.4');
+
+const { phpExtensionInstallationInstructions } = require('../../php/extensions');
+
+/**
+ * @param {string[]} requiredPHPExtensions
+ * @returns {Record<string, import('../../../../typings/index').PHPExtensionInstallationInstruction>}
+ */
+const mapMagentoRequiredExtensionsToInstructions = (requiredPHPExtensions) => requiredPHPExtensions.map((extensionName) => {
+    if (phpExtensionInstallationInstructions[extensionName]) {
+        return phpExtensionInstallationInstructions[extensionName];
+    }
+
+    for (const [extensionName, extensionData] of Object.entries(phpExtensionInstallationInstructions)) {
+        if (extensionData.alternativeName && extensionData.alternativeName.includes(extensionName)) {
+            return extensionData;
+        }
+    }
+
+    return {
+        name: extensionName
+    };
+}).reduce((acc, val) => ({ ...acc, [val.name]: val }), {});
+
+module.exports = {
+    magento23PHPExtensionList: mapMagentoRequiredExtensionsToInstructions(magento23RequiredPHPExtensions),
+    magento24PHPExtensionList: mapMagentoRequiredExtensionsToInstructions(magento24RequiredPHPExtensions)
+};

package/lib/config/magento/required-php-extensions/magento-2.3.js

@@ -0,0 +1,19 @@
+const magento23RequiredPHPExtensions = [
+    'bcmath',
+    'ctype',
+    'curl',
+    'dom',
+    'gd',
+    'hash',
+    'iconv',
+    'intl',
+    'mbstring',
+    'openssl',
+    'pdo_mysql',
+    'simplexml',
+    'soap',
+    'xsl',
+    'zip'
+];
+
+module.exports = magento23RequiredPHPExtensions;

package/lib/config/magento/required-php-extensions/magento-2.4.js

@@ -0,0 +1,29 @@
+const magento24RequiredPHPExtensions = [
+    'bcmath',
+    'ctype',
+    'curl',
+    'dom',
+    'fileinfo',
+    'gd',
+    'hash',
+    'iconv',
+    'intl',
+    'json',
+    'libxml',
+    'mbstring',
+    'openssl',
+    'pcre',
+    'pdo_mysql',
+    'simplexml',
+    'soap',
+    'sockets',
+    'sodium',
+    'tokenizer',
+    'xmlwriter',
+    'xsl',
+    'zip',
+    'libxml',
+    'openssl'
+];
+
+module.exports = magento24RequiredPHPExtensions;

package/lib/config/php/base-repo.js

@@ -0,0 +1,3 @@
+module.exports = {
+    repo: 'ghcr.io/scandipwa/create-magento-app'
+};

package/lib/config/php/extensions/apcu.js

@@ -0,0 +1,12 @@
+/* eslint-disable max-len */
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'apcu',
+    // eslint-disable-next-line quotes
+    command: `apk add --no-cache --virtual .build-deps \\$PHPIZE_DEPS \
+&& pecl install apcu \
+&& docker-php-ext-enable apcu \
+&& apk del -f .build-deps`
+};

package/lib/config/php/extensions/bcmath.js

@@ -0,0 +1,7 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'bcmath',
+    command: 'docker-php-ext-install bcmath'
+};

package/lib/config/php/extensions/curl.js

@@ -0,0 +1,11 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'curl',
+    command: 'docker-php-ext-install curl',
+    dependencies: [
+        'curl-dev',
+        'libcurl'
+    ]
+};

package/lib/config/php/extensions/gd.js

@@ -0,0 +1,14 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'gd',
+    command: 'docker-php-ext-configure gd --with-freetype --with-jpeg --with-webp && docker-php-ext-install gd',
+    dependencies: [
+        'freetype-dev',
+        'libjpeg-turbo-dev',
+        'libpng-dev',
+        'zlib-dev',
+        'libwebp-dev'
+    ]
+};

package/lib/config/php/extensions/index.js

@@ -1,4 +1,20 @@
+const path = require('path');
+const fs = require('fs');
+
+/**
+ * @type {Record<string, import('../../../../typings/index').PHPExtensionInstallationInstruction>}
+ */
+const phpExtensionInstallationInstructions = fs.readdirSync(__dirname, {
+    withFileTypes: true
+})
+    .filter((f) => f.isFile())
+    .filter((f) => f.name !== 'index.js')
+    .map((f) => ({
+        name: path.parse(f.name).name,
+        extension: require(path.join(__dirname, f.name))
+    }))
+    .reduce((acc, val) => ({ ...acc, [val.name]: val.extension }), {});
+
 module.exports = {
-    libsodium: require('./libsodium'),
-    xdebug: require('./xdebug')
+    phpExtensionInstallationInstructions
 };

package/lib/config/php/extensions/intl.js

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'intl',
+    command: 'docker-php-ext-install intl',
+    dependencies: [
+        'icu-dev'
+    ]
+};

package/lib/config/php/extensions/opcache.js

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'opcache',
+    alternativeName: [
+        'Zend OPcache'
+    ],
+    command: 'docker-php-ext-install opcache'
+};

package/lib/config/php/extensions/pdo_mysql.js

@@ -0,0 +1,7 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'pdo_mysql',
+    command: 'docker-php-ext-install pdo_mysql'
+};

package/lib/config/php/extensions/soap.js

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'soap',
+    command: 'docker-php-ext-install soap',
+    dependencies: [
+        'libxml2-dev'
+    ]
+};

package/lib/config/php/extensions/sodium.js

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'sodium',
+    command: 'docker-php-ext-install sodium',
+    dependencies: [
+        'libsodium-dev'
+    ]
+};

package/lib/config/php/extensions/xdebug.js

@@ -1,9 +1,12 @@
+/* eslint-disable max-len */
 /**
- * @type {import('../../../../typings/index').PHPExtension}
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
  */
-const xdebugExtension = {
-    extensionName: 'xdebug',
+module.exports = {
+    name: 'xdebug',
+    command: ({ version = '' } = {}) => `apk add --no-cache --virtual .build-deps \\$PHPIZE_DEPS \
+&& pecl install xdebug${version ? `-${version}` : ''} \
+&& docker-php-ext-enable xdebug \
+&& apk del -f .build-deps`,
     version: '3.1.5'
 };
-
-module.exports = xdebugExtension;

package/lib/config/php/extensions/xsl.js

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'xsl',
+    command: 'docker-php-ext-install xsl',
+    dependencies: [
+        'libxslt-dev'
+    ]
+};

package/lib/config/php/extensions/zip.js

@@ -0,0 +1,10 @@
+/**
+ * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ */
+module.exports = {
+    name: 'zip',
+    command: 'docker-php-ext-install zip',
+    dependencies: [
+        'libzip-dev'
+    ]
+};

package/lib/config/php/versions/php-7.2.js

@@ -0,0 +1,23 @@
+const path = require('path');
+const { repo } = require('../base-repo');
+const xdebug = require('../extensions/xdebug');
+
+/**
+ * @returns {import('../../../../typings/index').PHPConfiguration}
+ */
+const php72 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${ repo }:php-7.2`
+} = {}) => ({
+    baseImage,
+    debugImage: `${ baseImage }-debug`,
+    configTemplate: path.join(templateDir || '', 'php.template.ini'),
+    fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    extensions: {
+        xdebug,
+        ...extensions
+    }
+});
+
+module.exports = php72;

package/lib/config/php/versions/php-7.3.js

@@ -0,0 +1,23 @@
+const path = require('path');
+const { repo } = require('../base-repo');
+const xdebug = require('../extensions/xdebug');
+
+/**
+ * @returns {import('../../../../typings/index').PHPConfiguration}
+ */
+const php73 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${ repo }:php-7.3`
+} = {}) => ({
+    baseImage,
+    debugImage: `${ baseImage }-debug`,
+    configTemplate: path.join(templateDir || '', 'php.template.ini'),
+    fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    extensions: {
+        xdebug,
+        ...extensions
+    }
+});
+
+module.exports = php73;

package/lib/config/php/versions/php-7.4.js

@@ -0,0 +1,23 @@
+const path = require('path');
+const { repo } = require('../base-repo');
+const xdebug = require('../extensions/xdebug');
+
+/**
+ * @returns {import('../../../../typings/index').PHPConfiguration}
+ */
+const php74 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${ repo }:php-7.4`
+} = {}) => ({
+    baseImage,
+    debugImage: `${ baseImage }-debug`,
+    configTemplate: path.join(templateDir || '', 'php.template.ini'),
+    fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    extensions: {
+        xdebug,
+        ...extensions
+    }
+});
+
+module.exports = php74;

package/lib/config/php/versions/php-8.1.js

@@ -0,0 +1,23 @@
+const path = require('path');
+const { repo } = require('../base-repo');
+const xdebug = require('../extensions/xdebug');
+
+/**
+ * @returns {import('../../../../typings/index').PHPConfiguration}
+ */
+const php81 = ({
+    templateDir,
+    extensions = {},
+    baseImage = `${ repo }:php-8.1`
+} = {}) => ({
+    baseImage,
+    debugImage: `${ baseImage }-debug`,
+    configTemplate: path.join(templateDir || '', 'php.template.ini'),
+    fpmConfigTemplate: path.join(templateDir || '', 'php-fpm.template.conf'),
+    extensions: {
+        xdebug,
+        ...extensions
+    }
+});
+
+module.exports = php81;

package/lib/config/php-config.js

@@ -1,23 +1,19 @@
 const path = require('path');
-const phpbrewConfig = require('./phpbrew');
 
-module.exports = (app, config) => {
-    const { php } = app;
+/**
+ * @param {import('../../typings/context').ListrContext['config']['overridenConfiguration']} overridenConfiguration
+ * @param {import('../../typings/context').ListrContext['config']['baseConfig']} baseConfig
+ */
+module.exports = (overridenConfiguration, baseConfig) => {
+    const { php } = overridenConfiguration;
 
-    const { cacheDir } = config;
-
-    const phpVersionDir = path.join(
-        phpbrewConfig.phpPath,
-        `php-${ php.version }`
-    );
+    const { cacheDir } = baseConfig;
 
     const phpConfiguration = {
-        binPath: path.join(phpVersionDir, 'bin', 'php'),
         iniPath: path.join(cacheDir, 'php.ini'),
         iniTemplatePath: php.configTemplate,
-        fpmBinPath: path.join(phpVersionDir, 'sbin', 'php-fpm'),
+        fpmTemplatePath: php.fpmConfigTemplate,
         fpmConfPath: path.join(cacheDir, 'php-fpm.conf'),
-        fpmPidFilePath: path.join(cacheDir, 'php-fpm.pid'),
         extensions: php.extensions,
         version: php.version
     };

package/lib/config/port-config.js

@@ -58,8 +58,7 @@ const defaultPorts = {
     varnish: 8080,
     sslTerminator: 80,
     fpm: 9000,
-    xdebug: 9111,
-    mysql: 3306,
+    mariadb: 3306,
     redis: 6379,
     elasticsearch: 9200
 };
@@ -74,10 +73,7 @@ const defaultPorts = {
 const getPortsConfig = async (ports, options = {}) => {
     const { useNonOverlappingPorts } = options;
     const mergedPorts = deepmerge(defaultPorts, ports || {});
-    let p = [
-        9003,
-        9111
-    ];
+    let p = [];
 
     if (useNonOverlappingPorts) {
         p = p.concat(await getUsedByOtherCMAProjectsPorts());

package/lib/config/services/elasticsearch/base-repo.js

@@ -0,0 +1,3 @@
+module.exports = {
+    repo: 'ghcr.io/scandipwa/create-magento-app'
+};

package/lib/config/services/elasticsearch/default-es-env.js

@@ -0,0 +1,6 @@
+module.exports = {
+    'bootstrap.memory_lock': true,
+    'xpack.security.enabled': false,
+    'discovery.type': 'single-node',
+    ES_JAVA_OPTS: '-Xms512m -Xmx512m'
+};

package/lib/config/services/elasticsearch/versions/elasticsearch-6.8.js

@@ -0,0 +1,19 @@
+const os = require('os');
+const { getArchSync } = require('../../../../util/arch');
+const { deepmerge } = require('../../../../util/deepmerge');
+const { repo } = require('../base-repo');
+const defaultEnv = require('../default-es-env');
+
+/**
+ * @returns {import('../../../../../typings/index').ServiceWithImage}
+ */
+const elasticsearch68 = ({
+    image = `${ repo }:elasticsearch-6.8`
+} = {}) => ({
+    image,
+    env: deepmerge(defaultEnv, os.platform() === 'darwin' && getArchSync() === 'arm64' ? {
+        'xpack.ml.enabled': false
+    } : {})
+});
+
+module.exports = elasticsearch68;

package/lib/config/services/elasticsearch/versions/index.js

@@ -0,0 +1,5 @@
+const elasticsearch68 = require('./elasticsearch-6.8');
+
+module.exports = {
+    elasticsearch68
+};

package/lib/config/templates/magentorc.template

@@ -2,16 +2,16 @@ RED='\033[0;31m'
 GREEN='\033[0;32m'
 NC='\033[0m' # No Color
 
-alias php="$HOME/.phpbrew/php/php-<%= it.php.version %>/bin/php -c $PWD/node_modules/.create-magento-app-cache/php.ini"
-alias magento="php $PWD/bin/magento"
+alias php="node ./node_modules/.bin/magento-scripts-exec php php"
+alias magento="php bin/magento"
 alias magneto="echo -e 'Not ${RED}magneto${NC} but ${GREEN}magento${NC} please! or at least ${GREEN}m${NC}!' && magento"
 alias m="magento"
-alias composer="php $PWD/node_modules/.create-magento-app-cache/composer/composer.phar"
+alias composer="node ./node_modules/.bin/magento-scripts-exec php composer"
 alias c="composer"
 <% if (it.varnishEnabled) { %>
-alias cvc="npm run exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
+alias cvc="node ./node_modules/.bin/magento-scripts-exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
 <% } %>
-alias mysql="npm run exec mysql 'mysql -umagento -pmagento'"
-alias mysqlroot="npm run exec mysql 'mysql -uroot -pscandipwa'"
+alias mariadb="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -umagento -pmagento'"
+alias mariadbroot="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -uroot -pscandipwa'"
 
 export BASH_SILENCE_DEPRECATION_WARNING=1