@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/config/port-config.js

@@ -1,10 +1,10 @@
-const fs = require('fs');
-const path = require('path');
-const { findAPortNotInUse } = require('../util/portscanner');
-const { baseConfig } = require('.');
-const { deepmerge } = require('../util/deepmerge');
-const getJsonfileData = require('../util/get-jsonfile-data');
-const { getProjects } = require('./config');
+const fs = require('fs')
+const path = require('path')
+const { findAPortNotInUse } = require('../util/portscanner')
+const { baseConfig } = require('.')
+const { deepmerge } = require('../util/deepmerge')
+const getJsonfileData = require('../util/get-jsonfile-data')
+const { getProjects } = require('./config')
 
 /**
  * Get ports that are used by other CMA instances
@@ -14,43 +14,57 @@ const getUsedByOtherCMAProjectsPorts = async () => {
     const portConfigs = await Promise.all(
         Object.keys(getProjects())
             .filter((projectPath) => projectPath !== process.cwd())
-            .map((projectPath) => getJsonfileData(path.join(projectPath, 'node_modules', '.create-magento-app-cache', 'port-config.json')))
-    );
+            .map((projectPath) =>
+                getJsonfileData(
+                    path.join(
+                        projectPath,
+                        'node_modules',
+                        '.create-magento-app-cache',
+                        'port-config.json'
+                    )
+                )
+            )
+    )
 
-    const mappedPorts = portConfigs.filter(Boolean).map((portConfig) => Object.values(portConfig));
+    const mappedPorts = portConfigs
+        .filter(Boolean)
+        .map((portConfig) => Object.values(portConfig))
 
-    return Array.from(new Set(mappedPorts.reduce((acc, val) => acc.concat(val), [])));
-};
+    return Array.from(
+        new Set(mappedPorts.reduce((acc, val) => acc.concat(val), []))
+    )
+}
 
 /**
  * @param {Number} port
- * @param {Object} options
- * @param {Number[]} options.portIgnoreList
- * @returns {Promise<Number>}
+ * @param {Object} [options]
+ * @param {Number[]} [options.portIgnoreList]
+ * @returns {Promise<number | false>}
  */
 const getPort = async (port, options = {}) => {
-    const {
-        portIgnoreList = []
-    } = options;
-    const startPort = port;
-    const endPort = port + 999;
+    const { portIgnoreList = [] } = options
+    const startPort = port
+    const endPort = port + 999
 
     const availablePort = await findAPortNotInUse({
         startPort,
         endPort,
         portIgnoreList
-    });
+    })
 
-    return availablePort;
-};
+    return availablePort
+}
 
+/**
+ * @param {Record<string, number>} ports
+ */
 const savePortsConfig = async (ports) => {
     await fs.promises.writeFile(
         path.join(baseConfig.cacheDir, 'port-config.json'),
         JSON.stringify(ports, null, 2),
         { encoding: 'utf8' }
-    );
-};
+    )
+}
 
 // Map of default ports (key:value)
 const defaultPorts = {
@@ -63,39 +77,44 @@ const defaultPorts = {
     elasticsearch: 9200,
     maildevSMTP: 1025,
     maildevWeb: 1080
-};
+}
 
 /**
  * Get available port configuration
  * @param {Record<string, number>} ports
- * @param {Object} options
- * @param {boolean} options.useNonOverlappingPorts
+ * @param {Object} [options]
+ * @param {boolean} [options.useNonOverlappingPorts]
  * @returns {Promise<Record<string, number>>}
  */
 const getPortsConfig = async (ports, options = {}) => {
-    const { useNonOverlappingPorts } = options;
-    const mergedPorts = deepmerge(defaultPorts, ports || {});
-    let p = [];
+    const { useNonOverlappingPorts } = options
+    const mergedPorts = deepmerge(defaultPorts, ports || {})
+    /**
+     * @type {number[]}
+     */
+    let p = []
 
     if (useNonOverlappingPorts) {
-        p = p.concat(await getUsedByOtherCMAProjectsPorts());
+        p = p.concat(await getUsedByOtherCMAProjectsPorts())
     }
-    const availablePorts = Object.fromEntries(await Promise.all(
-        Object.entries(mergedPorts).map(async ([name, port]) => {
-            const availablePort = await getPort(port, {
-                portIgnoreList: p
-            });
+    const availablePorts = Object.fromEntries(
+        await Promise.all(
+            Object.entries(mergedPorts).map(async ([name, port]) => {
+                const availablePort = await getPort(port, {
+                    portIgnoreList: p
+                })
 
-            return [name, availablePort];
-        })
-    ));
+                return [name, availablePort]
+            })
+        )
+    )
 
-    return availablePorts;
-};
+    return availablePorts
+}
 
 module.exports = {
     defaultPorts,
     getPortsConfig,
     getPort,
     savePortsConfig
-};
+}

package/lib/config/save-config.js

@@ -1,17 +1,17 @@
-const { savePortsConfig } = require('./port-config');
+const { savePortsConfig } = require('./port-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const saveConfiguration = () => ({
     title: 'Saving configuration',
     task: async (ctx) => {
-        const { ports } = ctx;
+        const { ports } = ctx
 
-        await savePortsConfig(ports);
+        await savePortsConfig(ports)
     }
-});
+})
 
 module.exports = {
     saveConfiguration
-};
+}

package/lib/config/scandipwa-versions.js

@@ -11,6 +11,6 @@ const scandipwaMagentoVersionMapping = {
     '2.4.2': '4.3.0 - 5.0.3',
     '2.4.3': '5.0.4 - 5.2.7',
     '2.4.4': '5.3.0+'
-};
+}
 
-module.exports = scandipwaMagentoVersionMapping;
+module.exports = scandipwaMagentoVersionMapping

package/lib/config/services/composer/versions/composer-1.js

@@ -8,6 +8,6 @@ const composer1 = () => ({
             enabled: true
         }
     }
-});
+})
 
-module.exports = composer1;
+module.exports = composer1

package/lib/config/services/composer/versions/composer-2.js

@@ -3,6 +3,6 @@
  */
 const composer2 = () => ({
     version: '2'
-});
+})
 
-module.exports = composer2;
+module.exports = composer2

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

@@ -1,4 +1,4 @@
 module.exports = {
     composer1: require('./composer-1'),
     composer2: require('./composer-2')
-};
+}

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

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

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

@@ -1,6 +1,9 @@
+/**
+ * @type {Record<string, unknown>}
+ */
 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

@@ -1,19 +1,22 @@
-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');
+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}
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
  */
-const elasticsearch68 = ({
-    image = `${ repo }:elasticsearch-6.8`
-} = {}) => ({
+const elasticsearch68 = ({ image = `${repo}:elasticsearch-6.8` } = {}) => ({
     image,
-    env: deepmerge(defaultEnv, os.platform() === 'darwin' && getArchSync() === 'arm64' ? {
-        'xpack.ml.enabled': false
-    } : {})
-});
+    env: deepmerge(
+        defaultEnv,
+        os.platform() === 'darwin' && getArchSync() === 'arm64'
+            ? {
+                  'xpack.ml.enabled': false
+              }
+            : {}
+    )
+})
 
-module.exports = elasticsearch68;
+module.exports = elasticsearch68

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

@@ -1,11 +1,11 @@
-const defaultEnv = require('../default-es-env');
+const defaultEnv = require('../default-es-env')
 
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
  */
 const elasticsearch710 = () => ({
     image: 'elasticsearch:7.10.1',
     env: defaultEnv
-});
+})
 
-module.exports = elasticsearch710;
+module.exports = elasticsearch710

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

@@ -1,11 +1,11 @@
-const defaultEnv = require('../default-es-env');
+const defaultEnv = require('../default-es-env')
 
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
  */
 const elasticsearch712 = () => ({
     image: 'elasticsearch:7.12.1',
     env: defaultEnv
-});
+})
 
-module.exports = elasticsearch712;
+module.exports = elasticsearch712

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

@@ -1,11 +1,11 @@
-const defaultEnv = require('../default-es-env');
+const defaultEnv = require('../default-es-env')
 
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
  */
 const elasticsearch716 = () => ({
     image: 'elasticsearch:7.16.3',
     env: defaultEnv
-});
+})
 
-module.exports = elasticsearch716;
+module.exports = elasticsearch716

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

@@ -1,11 +1,11 @@
-const defaultEnv = require('../default-es-env');
+const defaultEnv = require('../default-es-env')
 
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
  */
 const elasticsearch717 = () => ({
     image: 'elasticsearch:7.17.6',
     env: defaultEnv
-});
+})
 
-module.exports = elasticsearch717;
+module.exports = elasticsearch717

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

@@ -1,11 +1,11 @@
-const defaultEnv = require('../default-es-env');
+const defaultEnv = require('../default-es-env')
 
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
  */
 const elasticsearch76 = () => ({
     image: 'elasticsearch:7.6.2',
     env: defaultEnv
-});
+})
 
-module.exports = elasticsearch76;
+module.exports = elasticsearch76

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

@@ -1,11 +1,11 @@
-const defaultEnv = require('../default-es-env');
+const defaultEnv = require('../default-es-env')
 
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
  */
 const elasticsearch77 = () => ({
     image: 'elasticsearch:7.7.1',
     env: defaultEnv
-});
+})
 
-module.exports = elasticsearch77;
+module.exports = elasticsearch77

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

@@ -1,11 +1,11 @@
-const defaultEnv = require('../default-es-env');
+const defaultEnv = require('../default-es-env')
 
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').ElasticSearchConfiguration}
  */
 const elasticsearch79 = () => ({
     image: 'elasticsearch:7.9.3',
     env: defaultEnv
-});
+})
 
-module.exports = elasticsearch79;
+module.exports = elasticsearch79

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

@@ -1,11 +1,11 @@
-const elasticsearch68 = require('./elasticsearch-6.8');
-const elasticsearch76 = require('./elasticsearch-7.6');
-const elasticsearch77 = require('./elasticsearch-7.7');
-const elasticsearch79 = require('./elasticsearch-7.9');
-const elasticsearch710 = require('./elasticsearch-7.10');
-const elasticsearch712 = require('./elasticsearch-7.12');
-const elasticsearch716 = require('./elasticsearch-7.16');
-const elasticsearch717 = require('./elasticsearch-7.17');
+const elasticsearch68 = require('./elasticsearch-6.8')
+const elasticsearch76 = require('./elasticsearch-7.6')
+const elasticsearch77 = require('./elasticsearch-7.7')
+const elasticsearch79 = require('./elasticsearch-7.9')
+const elasticsearch710 = require('./elasticsearch-7.10')
+const elasticsearch712 = require('./elasticsearch-7.12')
+const elasticsearch716 = require('./elasticsearch-7.16')
+const elasticsearch717 = require('./elasticsearch-7.17')
 
 module.exports = {
     elasticsearch68,
@@ -16,4 +16,4 @@ module.exports = {
     elasticsearch712,
     elasticsearch716,
     elasticsearch717
-};
+}

package/lib/config/services/maildev/index.js

@@ -1,7 +1,10 @@
+/**
+ * @returns {import('../../../../typings/index').ServiceWithImage}
+ */
 const maildev = () => ({
     image: 'maildev/maildev'
-});
+})
 
 module.exports = {
     maildev
-};
+}

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

@@ -2,4 +2,4 @@ module.exports = {
     mariadb102: require('./mariadb-10.2'),
     mariadb103: require('./mariadb-10.3'),
     mariadb104: require('./mariadb-10.4')
-};
+}

package/lib/config/services/mariadb/versions/mariadb-10.2.js

@@ -1,8 +1,9 @@
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').MariaDBConfiguration}
  */
 const mariadb102 = () => ({
-    version: '10.2'
-});
+    image: 'mariadb:10.2',
+    useOptimizerSwitch: false
+})
 
-module.exports = mariadb102;
+module.exports = mariadb102

package/lib/config/services/mariadb/versions/mariadb-10.3.js

@@ -1,8 +1,9 @@
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').MariaDBConfiguration}
  */
 const mariadb103 = () => ({
-    version: '10.3'
-});
+    image: 'mariadb:10.3',
+    useOptimizerSwitch: false
+})
 
-module.exports = mariadb103;
+module.exports = mariadb103

package/lib/config/services/mariadb/versions/mariadb-10.4.js

@@ -1,8 +1,9 @@
 /**
- * @returns {import('../../../../../typings/index').ServiceWithImage}
+ * @returns {import('../../../../../typings/index').MariaDBConfiguration}
  */
 const mariadb104 = () => ({
-    version: '10.4'
-});
+    image: 'mariadb:10.4',
+    useOptimizerSwitch: true
+})
 
-module.exports = mariadb104;
+module.exports = mariadb104

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

@@ -1,3 +1,3 @@
 module.exports = {
     nginx118: require('./nginx-1.18')
-};
+}

package/lib/config/services/nginx/versions/nginx-1.18.js

@@ -1,11 +1,12 @@
-const path = require('path');
+const path = require('path')
 
 /**
+ * @param {{ templateDir: string }} param0
  * @returns {import('../../../../../typings/index').NginxConfiguration}
  */
 const nginx118 = ({ templateDir }) => ({
-    version: '1.18.0',
+    image: 'nginx:1.18.0',
     configTemplate: path.join(templateDir || '', 'nginx.template.conf')
-});
+})
 
-module.exports = nginx118;
+module.exports = nginx118

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

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

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

@@ -1,12 +1,12 @@
 /* eslint-disable max-len */
 /**
- * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ * @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/services/php/extensions/bcmath.js

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

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

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

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

@@ -1,9 +1,10 @@
 /**
- * @type {import('../../../../typings/index').PHPExtensionInstallationInstruction}
+ * @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',
+    command:
+        'docker-php-ext-configure gd --with-freetype --with-jpeg --with-webp && docker-php-ext-install gd',
     dependencies: [
         'freetype-dev',
         'libjpeg-turbo-dev',
@@ -11,4 +12,4 @@ module.exports = {
         'zlib-dev',
         'libwebp-dev'
     ]
-};
+}

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

@@ -1,20 +1,21 @@
-const path = require('path');
-const fs = require('fs');
+const path = require('path')
+const fs = require('fs')
 
 /**
- * @type {Record<string, import('../../../../typings/index').PHPExtensionInstallationInstruction>}
+ * @type {Record<string, import('../../../../../typings/index').PHPExtensionInstallationInstruction>}
  */
-const phpExtensionInstallationInstructions = fs.readdirSync(__dirname, {
-    withFileTypes: true
-})
+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 }), {});
+    .reduce((acc, val) => ({ ...acc, [val.name]: val.extension }), {})
 
 module.exports = {
     phpExtensionInstallationInstructions
-};
+}

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

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

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

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

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

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