@scandipwa/magento-scripts 2.0.3 → 2.0.4

package/lib/tasks/docker/volume/volume-api.js

@@ -1,119 +1,102 @@
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const { execAsyncSpawn } = require('../../../util/exec-async-command')
 
 /**
  * @param {import('./volume-api').VolumeCreateOptions} options
  * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
  */
 const create = async (options, execOptions = {}) => {
-    const {
-        driver,
-        label,
-        opt,
-        name
-    } = options;
-
-    const driverArg = driver && `--driver=${driver}`;
-    const labelArg = label && `--label=${label}`;
-    const optArg = opt && Object.entries(opt).map(([name, value]) => `--opt ${name}="${value}"`).join(' ');
-
-    const args = [
-        driverArg,
-        labelArg,
-        optArg,
-        name
-    ].filter(Boolean).join(' ');
-
-    return execAsyncSpawn(`docker volume create ${args}`, execOptions);
-};
+    const { driver, label, opt, name } = options
+
+    const driverArg = driver && `--driver=${driver}`
+    const labelArg = label && `--label=${label}`
+    const optArg =
+        opt &&
+        Object.entries(opt)
+            .map(([name, value]) => `--opt ${name}="${value}"`)
+            .join(' ')
+
+    const args = [driverArg, labelArg, optArg, name].filter(Boolean).join(' ')
+
+    return execAsyncSpawn(`docker volume create ${args}`, execOptions)
+}
 
 /**
  * @param {import('./volume-api').VolumeLsOptions} options
  * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
  */
 const ls = async (options, execOptions = {}) => {
-    const {
-        filter,
-        format,
-        formatToJSON = false,
-        quiet
-    } = options;
-
-    const formatArg = !formatToJSON && format
-        ? `--format=${format}`
-        : formatToJSON && '--format=\'{{json .}}\'';
-    const filterArg = filter && typeof filter === 'string'
-        ? `--filter=${filter}`
-        : filter && Array.isArray(filter) && filter.every((f) => typeof f === 'string') && filter.map((f) => `--filter=${f}`).join(' ');
-    const quietArg = quiet && '--quiet';
-
-    const args = [
-        filterArg,
-        formatArg,
-        quietArg
-    ].filter(Boolean).join(' ');
+    const { filter, format, formatToJSON = false, quiet } = options
+
+    const formatArg =
+        !formatToJSON && format
+            ? `--format=${format}`
+            : formatToJSON && "--format='{{json .}}'"
+    const filterArg =
+        filter && typeof filter === 'string'
+            ? `--filter=${filter}`
+            : filter &&
+              Array.isArray(filter) &&
+              filter.every((f) => typeof f === 'string') &&
+              filter.map((f) => `--filter=${f}`).join(' ')
+    const quietArg = quiet && '--quiet'
+
+    const args = [filterArg, formatArg, quietArg].filter(Boolean).join(' ')
 
     if (formatToJSON) {
-        const result = await execAsyncSpawn(`docker volume ls ${args}`, execOptions);
-        return JSON.parse(`[${result.split('\n').join(', ')}]`);
+        const result = await execAsyncSpawn(
+            `docker volume ls ${args}`,
+            execOptions
+        )
+        return JSON.parse(`[${result.split('\n').join(', ')}]`)
     }
 
-    return execAsyncSpawn(`docker volume ls ${args}`, execOptions);
-};
+    return execAsyncSpawn(`docker volume ls ${args}`, execOptions)
+}
 
 /**
  * @param {import('./volume-api').VolumeRmOptions} options
  * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
  */
 const rm = async (options, execOptions = {}) => {
-    const {
-        force,
-        volumes
-    } = options;
+    const { force, volumes } = options
 
-    const forceArg = force && '--force';
+    const forceArg = force && '--force'
 
-    const command = [
-        'docker',
-        'volume',
-        'rm',
-        forceArg,
-        ...volumes
-    ].filter(Boolean).join(' ');
+    const command = ['docker', 'volume', 'rm', forceArg, ...volumes]
+        .filter(Boolean)
+        .join(' ')
 
-    return execAsyncSpawn(command, execOptions);
-};
+    return execAsyncSpawn(command, execOptions)
+}
 
 /**
  * @param {import('./volume-api').VolumeInspectOptions} options
  * @param {import('../../../util/exec-async-command').ExecAsyncSpawnOptions} execOptions
  */
 const inspect = async (options, execOptions = {}) => {
-    const {
-        volume,
-        format,
-        formatToJSON = false
-    } = options;
+    const { volume, format, formatToJSON = false } = options
 
-    const formatArg = !formatToJSON && format
-        ? `--format=${format}`
-        : formatToJSON && '--format=\'{{json .}}\'';
+    const formatArg =
+        !formatToJSON && format
+            ? `--format=${format}`
+            : formatToJSON && "--format='{{json .}}'"
 
-    const args = [
-        formatArg,
-        volume
-    ].filter(Boolean).join(' ');
+    const args = [formatArg, volume].filter(Boolean).join(' ')
 
     if (formatToJSON) {
-        const result = await execAsyncSpawn(`docker volume inspect ${args}`, execOptions);
-        return JSON.parse(result);
+        const result = await execAsyncSpawn(
+            `docker volume inspect ${args}`,
+            execOptions
+        )
+        return JSON.parse(result)
     }
 
-    return execAsyncSpawn(`docker volume inspect ${args}`, execOptions);
-};
+    return execAsyncSpawn(`docker volume inspect ${args}`, execOptions)
+}
 
 module.exports = {
     create,
     ls,
     rm,
     inspect
-};
+}

package/lib/tasks/execute.js

@@ -1,61 +1,78 @@
-const { Listr } = require('listr2');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { checkRequirements } = require('./requirements');
-const getMagentoVersionConfig = require('../config/get-magento-version-config');
-const checkConfigurationFile = require('../config/check-configuration-file');
-const getProjectConfiguration = require('../config/get-project-configuration');
-const { getCachedPorts } = require('../config/get-port-config');
-const { executeInContainer, runInContainer } = require('../util/execute-in-container');
-const { containerApi } = require('./docker/containers');
-const dockerNetwork = require('./docker/network');
-const KnownError = require('../errors/known-error');
+const { Listr } = require('listr2')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { checkRequirements } = require('./requirements')
+const getMagentoVersionConfig = require('../config/get-magento-version-config')
+const checkConfigurationFile = require('../config/check-configuration-file')
+const getProjectConfiguration = require('../config/get-project-configuration')
+const { getCachedPorts } = require('../config/get-port-config')
+const {
+    executeInContainer,
+    runInContainer
+} = require('../util/execute-in-container')
+const { containerApi } = require('./docker/containers')
+const dockerNetwork = require('./docker/network')
+const KnownError = require('../errors/known-error')
 
 /**
  *
- * @param {{ containername: string, commands?: string[] }} argv
+ * @param {{ containername: string, commands: string[] }} argv
  * @returns
  */
 const executeTask = async (argv) => {
-    const tasks = new Listr([
-        checkRequirements(),
-        getMagentoVersionConfig(),
-        checkConfigurationFile(),
-        getProjectConfiguration(),
-        getCachedPorts(),
-        dockerNetwork.tasks.createNetwork()
-    ], {
-        concurrent: false,
-        exitOnError: true,
-        ctx: { throwMagentoVersionMissing: true },
-        rendererOptions: { collapse: false, clearOutput: true }
-    });
-
-    let ctx;
+    const tasks = new Listr(
+        [
+            checkRequirements(),
+            getMagentoVersionConfig(),
+            checkConfigurationFile(),
+            getProjectConfiguration(),
+            getCachedPorts(),
+            dockerNetwork.tasks.createNetwork()
+        ],
+        {
+            concurrent: false,
+            exitOnError: true,
+            ctx: { throwMagentoVersionMissing: true },
+            rendererOptions: { collapse: false, clearOutput: true }
+        }
+    )
+
+    let ctx
     try {
-        ctx = await tasks.run();
+        ctx = await tasks.run()
     } catch (e) {
-        logger.error(e.message || e);
-        process.exit(1);
+        logger.error(e.message || e)
+        process.exit(1)
     }
-    const containers = ctx.config.docker.getContainers(ctx.ports);
-    const services = Object.keys(containers);
-
-    if (services.includes(argv.containername) || services.some((service) => service.includes(argv.containername))) {
-        /**
-         * @type {import('./docker/containers/container-api').ContainerRunOptions}
-         */
-        const container = containers[argv.containername]
+    const containers = ctx.config.docker.getContainers(ctx.ports)
+    const services = Object.keys(containers)
+
+    if (
+        services.includes(argv.containername) ||
+        services.some((service) => service.includes(argv.containername))
+    ) {
+        const containerResult = containers[argv.containername]
             ? containers[argv.containername]
-            : Object.entries(containers).find(([key]) => key.includes(argv.containername))[1];
+            : Object.entries(containers).find(([key]) =>
+                  key.includes(argv.containername)
+              )
+
+        if (!containerResult) {
+            logger.error(`No container found "${argv.containername}"`)
+            process.exit(1)
+        }
+
+        const container =
+            containerResult && Array.isArray(containerResult)
+                ? containerResult[1]
+                : containerResult
 
         if (argv.commands.length === 0) {
-        // if we have default connect command then use it
+            // if we have default connect command then use it
             if (container.connectCommand) {
-            // eslint-disable-next-line no-param-reassign
-                argv.commands = container.connectCommand;
+                argv.commands = container.connectCommand
             } else {
-            // otherwise fall back to bash (if it exists inside container)
-                argv.commands.push('bash');
+                // otherwise fall back to bash (if it exists inside container)
+                argv.commands.push('bash')
             }
         }
 
@@ -63,38 +80,57 @@ const executeTask = async (argv) => {
             formatToJSON: true,
             all: true,
             filter: `name=${container.name}`
-        });
+        })
 
         if (containerList.length > 0) {
-            logger.logN(`Executing container ${logger.style.misc(container._)} (command: ${logger.style.command(argv.commands.join(' '))})`);
+            if (process.stdout.isTTY) {
+                logger.logN(
+                    `Executing container ${logger.style.misc(
+                        container._
+                    )} (command: ${logger.style.command(
+                        argv.commands.join(' ')
+                    )})`
+                )
+            }
+
             const result = await executeInContainer({
                 containerName: container.name,
                 commands: argv.commands,
                 user: container.user
-            });
+            })
 
-            return result;
+            return result
         }
 
         if (container.name.endsWith('php')) {
-            logger.logN(`Starting container ${logger.style.misc(container._)} with command: ${logger.style.command(argv.commands.join(' '))}`);
+            if (process.stdout.isTTY) {
+                logger.logN(
+                    `Starting container ${logger.style.misc(
+                        container._
+                    )} with command: ${logger.style.command(
+                        argv.commands.join(' ')
+                    )}`
+                )
+            }
+
             const result = await runInContainer(
                 {
                     ...container,
                     name: `${container.name}_exec-${Date.now()}`
                 },
                 argv.commands
-            );
+            )
 
-            return result;
+            return result
         }
 
-        throw new KnownError(`Container ${container.name} is not running!`);
+        throw new KnownError(`Container ${container.name} is not running!`)
     }
 
-    logger.error(`No container found "${argv.containername}"`);
-};
+    logger.error(`No container found "${argv.containername}"`)
+    process.exit(1)
+}
 
 module.exports = {
     executeTask
-};
+}

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

@@ -1,23 +1,31 @@
-const path = require('path');
-const UnknownError = require('../../errors/unknown-error');
-const setConfigFile = require('../../util/set-config');
+const path = require('path')
+const UnknownError = require('../../errors/unknown-error')
+const setConfigFile = require('../../util/set-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createMariaDBConfig = () => ({
     title: 'Setting MariaDB config',
     task: async (ctx) => {
         try {
             await setConfigFile({
-                configPathname: path.join(ctx.config.baseConfig.cacheDir, 'mariadb.cnf'),
-                template: path.join(ctx.config.baseConfig.templateDir, 'mariadb.template.cnf'),
+                configPathname: path.join(
+                    ctx.config.baseConfig.cacheDir,
+                    'mariadb.cnf'
+                ),
+                template: path.join(
+                    ctx.config.baseConfig.templateDir,
+                    'mariadb.template.cnf'
+                ),
                 overwrite: true
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during php-fpm config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error accrued during php-fpm config creation\n\n${e}`
+            )
         }
     }
-});
+})
 
-module.exports = createMariaDBConfig;
+module.exports = createMariaDBConfig

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

@@ -1,30 +1,27 @@
-const path = require('path');
-const setConfigFile = require('../../util/set-config');
-const UnknownError = require('../../errors/unknown-error');
+const path = require('path')
+const setConfigFile = require('../../util/set-config')
+const UnknownError = require('../../errors/unknown-error')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createNginxConfig = () => ({
     title: 'Setting nginx config',
     task: async (ctx) => {
         const {
             ports,
-            config: {
-                overridenConfiguration,
-                baseConfig
-            },
+            config: { overridenConfiguration, baseConfig },
             isDockerDesktop
-        } = ctx;
+        } = ctx
 
         const {
-            configuration: {
-                nginx
-            }
-        } = overridenConfiguration;
+            configuration: { nginx }
+        } = overridenConfiguration
 
-        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
-        const hostPort = !isDockerDesktop ? ports.app : 80;
+        const hostMachine = !isDockerDesktop
+            ? '127.0.0.1'
+            : 'host.docker.internal'
+        const hostPort = !isDockerDesktop ? ports.app : 80
 
         try {
             await setConfigFile({
@@ -43,11 +40,13 @@ const createNginxConfig = () => ({
                     hostPort,
                     config: overridenConfiguration
                 }
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during nginx config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error accrued during nginx config creation\n\n${e}`
+            )
         }
     }
-});
+})
 
-module.exports = createNginxConfig;
+module.exports = createNginxConfig

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

@@ -1,24 +1,28 @@
-const UnknownError = require('../../errors/unknown-error');
-const setConfigFile = require('../../util/set-config');
+const UnknownError = require('../../errors/unknown-error')
+const setConfigFile = require('../../util/set-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createPhpConfig = () => ({
     title: 'Setting PHP config',
     task: async (ctx) => {
-        const { config: { php } } = ctx;
+        const {
+            config: { php }
+        } = ctx
 
         try {
             await setConfigFile({
                 configPathname: php.iniPath,
                 template: php.iniTemplatePath,
                 overwrite: true
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during php.ini config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error accrued during php.ini config creation\n\n${e}`
+            )
         }
     }
-});
+})
 
-module.exports = createPhpConfig;
+module.exports = createPhpConfig

package/lib/tasks/file-system/create-php-debug-config.js

@@ -1,28 +1,31 @@
-const semver = require('semver');
-const UnknownError = require('../../errors/unknown-error');
-const setConfigFile = require('../../util/set-config');
-const { getEnabledExtensionsFromImage } = require('../docker/project-image-builder');
+const semver = require('semver')
+const UnknownError = require('../../errors/unknown-error')
+const setConfigFile = require('../../util/set-config')
+const {
+    getEnabledExtensionsFromImage
+} = require('../docker/project-image-builder')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createPhpDebugConfig = () => ({
     title: 'Setting PHP XDebug config',
     skip: (ctx) => !ctx.debug,
     task: async (ctx) => {
         const {
-            config: {
-                php,
-                baseConfig
-            },
+            config: { php, baseConfig },
             debug,
             isDockerDesktop
-        } = ctx;
-        const containers = ctx.config.docker.getContainers(ctx.ports);
-        const phpExtensions = await getEnabledExtensionsFromImage(containers.php.debugImage);
-        const isXDebug2 = semver.satisfies(phpExtensions.xdebug, '2');
+        } = ctx
+        const containers = ctx.config.docker.getContainers(ctx.ports)
+        const phpExtensions = await getEnabledExtensionsFromImage(
+            containers.php.debugImage
+        )
+        const isXDebug2 = semver.satisfies(phpExtensions.xdebug, '2')
 
-        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
+        const hostMachine = !isDockerDesktop
+            ? '127.0.0.1'
+            : 'host.docker.internal'
 
         try {
             await setConfigFile({
@@ -35,11 +38,13 @@ const createPhpDebugConfig = () => ({
                     isXDebug2,
                     hostMachine
                 }
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during xdebug.ini config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error accrued during xdebug.ini config creation\n\n${e}`
+            )
         }
     }
-});
+})
 
-module.exports = createPhpDebugConfig;
+module.exports = createPhpDebugConfig

package/lib/tasks/file-system/create-php-fpm-config.js

@@ -1,14 +1,17 @@
-const UnknownError = require('../../errors/unknown-error');
-const setConfigFile = require('../../util/set-config');
+const UnknownError = require('../../errors/unknown-error')
+const setConfigFile = require('../../util/set-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createPhpFpmConfig = () => ({
     title: 'Setting php-fpm config',
     task: async (ctx) => {
-        const { config: { php }, isDockerDesktop } = ctx;
-        const port = !isDockerDesktop ? ctx.ports.fpm : 9000;
+        const {
+            config: { php },
+            isDockerDesktop
+        } = ctx
+        const port = !isDockerDesktop ? ctx.ports.fpm : 9000
 
         try {
             await setConfigFile({
@@ -18,11 +21,13 @@ const createPhpFpmConfig = () => ({
                 templateArgs: {
                     port
                 }
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during php-fpm config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error accrued during php-fpm config creation\n\n${e}`
+            )
         }
     }
-});
+})
 
-module.exports = createPhpFpmConfig;
+module.exports = createPhpFpmConfig