@scandipwa/magento-scripts 2.0.3 → 2.0.4

package/lib/tasks/status/index.js

@@ -1,49 +1,50 @@
 /* eslint-disable max-len */
-const path = require('path');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { getProjectCreatedAt, getPrefix } = require('../../util/prefix');
+const path = require('path')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { getProjectCreatedAt, getPrefix } = require('../../util/prefix')
 
-const { version: packageVersion } = require('../../../package.json');
-const { getArchSync } = require('../../util/arch');
-const ConsoleBlock = require('../../util/console-block');
-const { getInstanceMetadata } = require('../../util/instance-metadata');
+const { version: packageVersion } = require('../../../package.json')
+const { getArchSync } = require('../../util/arch')
+const ConsoleBlock = require('../../util/console-block')
+const { getInstanceMetadata } = require('../../util/instance-metadata')
 
+/**
+ * @param {any} str
+ * @returns {str is string}
+ */
 const isJSON = (str) => {
     try {
-        const result = JSON.parse(str);
+        const result = JSON.parse(str)
         if (typeof result === 'object') {
-            return true;
+            return true
         }
     } catch (e) {
         //
     }
 
-    return false;
-};
+    return false
+}
 
 /**
  * @param {string} port
  * @return {{ host: string, hostPort: string, containerPort: string }}
  */
 const parsePort = (port) => {
-    const [host, hostPort, containerPort] = port.split(':');
+    const [host, hostPort, containerPort] = port.split(':')
 
     return {
         host,
         hostPort,
         containerPort
-    };
-};
+    }
+}
 
 /**
  * @param {import('../../../typings/context').ListrContext & { containers: ReturnType<Awaited<ReturnType<import('../../config/docker')>>['getContainers']> }} ctx
  */
 const prettyStatus = async (ctx) => {
     const {
-        config: {
-            baseConfig,
-            projectConfig
-        },
+        config: { baseConfig, projectConfig },
         magentoVersion,
         dockerVersion,
         platform,
@@ -51,23 +52,35 @@ const prettyStatus = async (ctx) => {
         containers,
         composerVersion,
         systemDFData
-    } = ctx;
-    const projectCreatedAt = getProjectCreatedAt();
+    } = ctx
+    const projectCreatedAt = getProjectCreatedAt()
 
-    const prefix = getPrefix();
+    const prefix = getPrefix()
 
-    const { name: folderName } = path.parse(process.cwd());
+    const { name: folderName } = path.parse(process.cwd())
 
-    const block = new ConsoleBlock();
+    const block = new ConsoleBlock()
 
     block
-        .addHeader(`magento-scripts version: ${ logger.style.link(packageVersion) }`)
+        .addHeader(
+            `magento-scripts version: ${logger.style.link(packageVersion)}`
+        )
         .addEmptyLine()
-        .addLine(`Project: ${logger.style.file(baseConfig.prefix)} ${prefix === folderName ? '(without prefix)' : '(with prefix)'} (with php container)${ projectConfig.debug ? ' (with debugging)' : '' }`)
-        .addLine(`Project location: ${logger.style.link(process.cwd())}`);
+        .addLine(
+            `Project: ${logger.style.file(baseConfig.prefix)} ${
+                prefix === folderName ? '(without prefix)' : '(with prefix)'
+            } (with php container)${
+                projectConfig.debug ? ' (with debugging)' : ''
+            }`
+        )
+        .addLine(`Project location: ${logger.style.link(process.cwd())}`)
 
     if (projectCreatedAt) {
-        block.addLine(`Project created: ${logger.style.link(projectCreatedAt.toDateString())} at ${logger.style.link(projectCreatedAt.toTimeString())}`);
+        block.addLine(
+            `Project created: ${logger.style.link(
+                projectCreatedAt.toDateString()
+            )} at ${logger.style.link(projectCreatedAt.toTimeString())}`
+        )
     }
 
     block
@@ -79,125 +92,179 @@ const prettyStatus = async (ctx) => {
         .addLine(`Platform version: ${logger.style.file(platformVersion)}`)
         .addLine(`Platform architecture: ${logger.style.file(getArchSync())}`)
         .addEmptyLine()
-        .addSeparator('Docker containers status');
+        .addSeparator('Docker containers status')
 
     Object.values(containers).forEach((container) => {
         block
             .addEmptyLine()
             .addLine(`> ${logger.style.misc(container._)}`)
-            .addEmptyLine();
+            .addEmptyLine()
 
-        let containerStatus;
+        let containerStatus
 
-        if (container.status && container.status.State && container.status.State.Health) {
-            containerStatus = `✓ ${ logger.style.file(container.status.State.Health.Status) } and ${ logger.style.file('running') }`;
+        if (
+            container.status &&
+            container.status.State &&
+            container.status.State.Health
+        ) {
+            containerStatus = `✓ ${logger.style.file(
+                container.status.State.Health.Status
+            )} and ${logger.style.file('running')}`
         } else if (container.status && container.status.State) {
-            containerStatus = logger.style.file(container.status.State.Status);
+            containerStatus = logger.style.file(container.status.State.Status)
         } else {
-            containerStatus = '✖ Not running';
+            containerStatus = '✖ Not running'
         }
 
         block
             .addLine(`Status: ${containerStatus}`)
-            .addLine(`Name: ${logger.style.misc(container.name)}`);
-
-        if (container.status && container.status.Config && container.status.Config.Image) {
-            block.addLine(`Image: ${logger.style.file(container.status.Config.Image)}`);
+            .addLine(`Name: ${logger.style.misc(container.name)}`)
+
+        if (
+            container.status &&
+            container.status.Config &&
+            container.status.Config.Image
+        ) {
+            block.addLine(
+                `Image: ${logger.style.file(container.status.Config.Image)}`
+            )
         } else {
-            block.addLine(`Image: ${logger.style.file(container.image)}`);
+            block.addLine(`Image: ${logger.style.file(container.image)}`)
         }
 
-        block.addLine(`Network: ${logger.style.link(container.network)}`);
+        block.addLine(`Network: ${logger.style.link(container.network)}`)
 
-        if (!containerStatus.includes('Not running') && container.forwardedPorts && container.forwardedPorts.length > 0) {
-            block.addLine('Port forwarding:');
+        if (
+            !containerStatus.includes('Not running') &&
+            container.forwardedPorts &&
+            container.forwardedPorts.length > 0
+        ) {
+            block.addLine('Port forwarding:')
             container.forwardedPorts.forEach((port) => {
-                const { host, hostPort, containerPort } = parsePort(port);
+                const { host, hostPort, containerPort } = parsePort(port)
                 if (container.network !== 'host') {
-                    block.addLine(`${' '.repeat(3)} ${logger.style.link(`${host}:${hostPort}`)} -> ${logger.style.file(containerPort)} (${logger.style.link('host')} -> ${logger.style.file('container')})`);
+                    block.addLine(
+                        `${' '.repeat(3)} ${logger.style.link(
+                            `${host}:${hostPort}`
+                        )} -> ${logger.style.file(
+                            containerPort
+                        )} (${logger.style.link('host')} -> ${logger.style.file(
+                            'container'
+                        )})`
+                    )
                 } else {
-                    block.addLine(`${' '.repeat(3)} ${logger.style.link(`Running on host network - ${host}:${hostPort}`)}`);
+                    block.addLine(
+                        `${' '.repeat(3)} ${logger.style.link(
+                            `Running on host network - ${host}:${hostPort}`
+                        )}`
+                    )
                 }
-            });
+            })
         }
 
         if (container.env && Object.keys(container.env).length > 0) {
-            block.addLine('Environment variables:');
+            block.addLine('Environment variables:')
             for (const [envName, envValue] of Object.entries(container.env)) {
                 if (isJSON(envValue)) {
-                    const beautifyJSONLines = JSON.stringify(JSON.parse(envValue), null, 1).split('\n');
+                    const beautifyJSONLines = JSON.stringify(
+                        JSON.parse(envValue),
+                        null,
+                        1
+                    ).split('\n')
 
-                    block.addLine(`${' '.repeat(3)} ${logger.style.misc(envName)}=${logger.style.file(beautifyJSONLines.shift())}`);
+                    block.addLine(
+                        `${' '.repeat(3)} ${logger.style.misc(
+                            envName
+                        )}=${logger.style.file(beautifyJSONLines.shift())}`
+                    )
 
-                    let currentOpeningBracket = 0;
+                    let currentOpeningBracket = 0
 
                     beautifyJSONLines.forEach((line) => {
-                        block.addLine(`${'  '.repeat(2 + currentOpeningBracket)}${logger.style.file(line)}`);
-                        if (['{', '['].some((openingBracketVariant) => line.includes(openingBracketVariant))) {
-                            currentOpeningBracket++;
-                        } else if (['}', ']'].some((closingBracketVariant) => line.includes(closingBracketVariant))) {
-                            currentOpeningBracket--;
+                        block.addLine(
+                            `${'  '.repeat(
+                                2 + currentOpeningBracket
+                            )}${logger.style.file(line)}`
+                        )
+                        if (
+                            ['{', '['].some((openingBracketVariant) =>
+                                line.includes(openingBracketVariant)
+                            )
+                        ) {
+                            currentOpeningBracket++
+                        } else if (
+                            ['}', ']'].some((closingBracketVariant) =>
+                                line.includes(closingBracketVariant)
+                            )
+                        ) {
+                            currentOpeningBracket--
                         }
-                    });
+                    })
                 } else {
-                    block.addLine(`${' '.repeat(3)} ${logger.style.misc(envName)}=${logger.style.file(envValue)}`);
+                    block.addLine(
+                        `${' '.repeat(3)} ${logger.style.misc(
+                            envName
+                        )}=${logger.style.file(envValue)}`
+                    )
                 }
             }
         }
 
         if (container.description) {
-            block.addLine('Description:');
+            block.addLine('Description:')
             container.description.split('\n').forEach((line) => {
-                block.addLine(line);
-            });
+                block.addLine(line)
+            })
         }
-    });
+    })
 
-    block
-        .addSeparator('Docker volume data')
-        .addEmptyLine();
+    block.addSeparator('Docker volume data').addEmptyLine()
 
-    const { volumes } = ctx.config.docker;
+    const { volumes } = ctx.config.docker
 
     Object.values(volumes)
         .map((volume) => {
-            volume.volumeData = systemDFData.Volumes
-                .find((v) => v.Name === volume.name);
+            volume.volumeData = systemDFData.Volumes.find(
+                (v) => v.Name === volume.name
+            )
 
-            return volume;
+            return volume
         })
         .forEach((v) => {
-            block
-                .addLine(`> ${logger.style.misc(v.name)}`);
+            block.addLine(`> ${logger.style.misc(v.name)}`)
             if (v.volumeData) {
-                block.addLine(`Size: ${logger.style.code(v.volumeData.Size)}`);
+                block.addLine(`Size: ${logger.style.code(v.volumeData.Size)}`)
             }
 
             if (ctx.isDockerDesktop && v.opt && v.opt.device) {
-                block.addLine(`Mountpoint: ${logger.style.file(v.opt.device.replace(process.cwd(), '<project location>'))}`);
+                block.addLine(
+                    `Mountpoint: ${logger.style.file(
+                        v.opt.device.replace(
+                            process.cwd(),
+                            '<project location>'
+                        )
+                    )}`
+                )
             }
-        });
+        })
 
-    const instanceMetadata = getInstanceMetadata(ctx);
+    const instanceMetadata = getInstanceMetadata(ctx)
 
-    block
-        .addEmptyLine()
-        .addSeparator('Magento 2')
-        .addEmptyLine();
+    block.addEmptyLine().addSeparator('Magento 2').addEmptyLine()
 
-    block.addLine(logger.style.misc('Frontend'));
+    block.addLine(logger.style.misc('Frontend'))
     instanceMetadata.frontend.forEach(({ title, text }) => {
-        block.addLine(`  ${title}: ${text}`);
-    });
+        block.addLine(`  ${title}: ${text}`)
+    })
 
-    block.addEmptyLine();
+    block.addEmptyLine()
 
-    block.addLine(logger.style.misc('Admin'));
+    block.addLine(logger.style.misc('Admin'))
     instanceMetadata.admin.forEach(({ title, text }) => {
-        block.addLine(`  ${title}: ${text}`);
-    });
+        block.addLine(`  ${title}: ${text}`)
+    })
 
-    block.log();
-};
+    block.log()
+}
 
-module.exports = { prettyStatus };
+module.exports = { prettyStatus }

package/lib/tasks/stop.js

@@ -1,24 +1,28 @@
-const { stopServices } = require('./docker');
-const getMagentoVersionConfig = require('../config/get-magento-version-config');
-const getProjectConfiguration = require('../config/get-project-configuration');
-const checkConfigurationFile = require('../config/check-configuration-file');
-const getDockerVersion = require('./requirements/docker/version');
+const { stopServices } = require('./docker')
+const getMagentoVersionConfig = require('../config/get-magento-version-config')
+const getProjectConfiguration = require('../config/get-project-configuration')
+const checkConfigurationFile = require('../config/check-configuration-file')
+const getDockerVersion = require('./requirements/docker/version')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const stop = () => ({
     title: 'Stopping project',
-    task: async (ctx, task) => task.newListr([
-        getDockerVersion(),
-        getMagentoVersionConfig(),
-        checkConfigurationFile(),
-        getProjectConfiguration(),
-        stopServices()
-    ], {
-        concurrent: false,
-        exitOnError: true
-    })
-});
+    task: async (ctx, task) =>
+        task.newListr(
+            [
+                getDockerVersion(),
+                getMagentoVersionConfig(),
+                checkConfigurationFile(),
+                getProjectConfiguration(),
+                stopServices()
+            ],
+            {
+                concurrent: false,
+                exitOnError: true
+            }
+        )
+})
 
-module.exports = stop;
+module.exports = stop

package/lib/tasks/theme/build-theme.js

@@ -1,9 +1,9 @@
-const path = require('path');
-const pathExists = require('../../util/path-exists');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const matchFilesystem = require('../../util/match-filesystem');
-const UnknownError = require('../../errors/unknown-error');
+const path = require('path')
+const pathExists = require('../../util/path-exists')
+const { execAsyncSpawn } = require('../../util/exec-async-command')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const matchFilesystem = require('../../util/match-filesystem')
+const UnknownError = require('../../errors/unknown-error')
 
 /**
  * @type {(theme: import('../../../typings/theme').Theme) => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -11,51 +11,68 @@ const UnknownError = require('../../errors/unknown-error');
 const buildTheme = ({ themePath }) => ({
     title: `Building theme in ${themePath}`,
     task: async (ctx, task) => {
-        const { verbose = false } = ctx;
+        const { verbose = false } = ctx
 
-        if (!await pathExists(path.join(themePath, 'node_modules'))) {
-            task.output = 'Installing theme dependencies';
-            const commandToInstallDependencies = await pathExists(path.join(themePath, 'package-lock.json'))
+        if (!(await pathExists(path.join(themePath, 'node_modules')))) {
+            task.output = 'Installing theme dependencies'
+            const commandToInstallDependencies = (await pathExists(
+                path.join(themePath, 'package-lock.json')
+            ))
                 ? 'npm ci'
-                : 'npm i';
+                : 'npm i'
 
             try {
                 await execAsyncSpawn(commandToInstallDependencies, {
                     cwd: path.join(process.cwd(), themePath),
-                    callback: !verbose ? undefined : (t) => {
-                        task.output = t;
-                    }
-                });
+                    callback: !verbose
+                        ? undefined
+                        : (t) => {
+                              task.output = t
+                          }
+                })
             } catch (e) {
-                throw new UnknownError(`We were unable to install theme dependencies in ${themePath} using ${logger.style.code(commandToInstallDependencies)} command!
-If you have ${logger.style.file('package-lock.json')} in theme directory make sure it's up to date with ${logger.style.file('package.json')} file content.`);
+                throw new UnknownError(`We were unable to install theme dependencies in ${themePath} using ${logger.style.code(
+                    commandToInstallDependencies
+                )} command!
+If you have ${logger.style.file(
+                    'package-lock.json'
+                )} in theme directory make sure it's up to date with ${logger.style.file(
+                    'package.json'
+                )} file content.`)
             }
         }
 
-        const magentoThemeDirPath = path.join(themePath, 'magento', 'Magento_Theme');
-        const isMagentoThemeDirMatching = await matchFilesystem(magentoThemeDirPath, {
-            templates: true,
-            web: [
-                'static'
-            ]
-        });
+        const magentoThemeDirPath = path.join(
+            themePath,
+            'magento',
+            'Magento_Theme'
+        )
+        const isMagentoThemeDirMatching = await matchFilesystem(
+            magentoThemeDirPath,
+            {
+                templates: true,
+                web: ['static']
+            }
+        )
 
         if (isMagentoThemeDirMatching) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        task.output = 'Building theme...';
+        task.output = 'Building theme...'
         await execAsyncSpawn('BUILD_MODE=magento npm run build', {
             cwd: path.join(process.cwd(), themePath),
-            callback: !verbose ? undefined : (t) => {
-                task.output = t;
-            }
-        });
+            callback: !verbose
+                ? undefined
+                : (t) => {
+                      task.output = t
+                  }
+        })
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = buildTheme;
+module.exports = buildTheme

package/lib/tasks/theme/install-theme.js

@@ -1,7 +1,7 @@
-const path = require('path');
-const UnknownError = require('../../errors/unknown-error');
-const getJsonfileData = require('../../util/get-jsonfile-data');
-const runComposerCommand = require('../../util/run-composer');
+const path = require('path')
+const UnknownError = require('../../errors/unknown-error')
+const getJsonfileData = require('../../util/get-jsonfile-data')
+const runComposerCommand = require('../../util/run-composer')
 
 /**
  * @type {(theme: import('../../../typings/theme').Theme) => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -9,33 +9,46 @@ const runComposerCommand = require('../../util/run-composer');
 const installTheme = (theme) => ({
     title: 'Installing theme in composer.json',
     task: async (ctx, task) => {
-        const { magentoVersion, verbose = false } = ctx;
-        const composerJsonData = await getJsonfileData(path.join(process.cwd(), 'composer.json'));
+        const { verbose = false } = ctx
+        /**
+         * @type {{ require: Record<string, string> } | null}
+         */
+        const composerJsonData = await getJsonfileData(
+            path.join(process.cwd(), 'composer.json')
+        )
 
-        if (composerJsonData.require[theme.composerData.name]) {
-            task.skip();
-            return;
+        if (
+            composerJsonData &&
+            composerJsonData.require[theme.composerData.name]
+        ) {
+            task.skip()
+            return
         }
 
         try {
-            await runComposerCommand(ctx, `require ${theme.composerData.name}`, {
-                magentoVersion,
-                callback: !verbose ? undefined : (t) => {
-                    task.output = t;
+            await runComposerCommand(
+                ctx,
+                `require ${theme.composerData.name}`,
+                {
+                    callback: !verbose
+                        ? undefined
+                        : (t) => {
+                              task.output = t
+                          }
                 }
-            });
+            )
         } catch (e) {
             throw new UnknownError(
                 `Unexpected error while installing theme.
 See ERROR log below.\n\n${e}`
-            );
+            )
         }
 
-        ctx.isSetupUpgradeNeeded = true;
+        ctx.isSetupUpgradeNeeded = true
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = installTheme;
+module.exports = installTheme