@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/commands/start.js

@@ -1,44 +1,53 @@
-const path = require('path');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { Listr } = require('listr2');
-const { start } = require('../tasks/start');
-const pathExists = require('../util/path-exists');
-const { baseConfig } = require('../config');
-const googleAnalytics = require('../util/analytics');
-const systeminformation = require('systeminformation');
-const { getCSAThemes } = require('../util/CSA-theme');
-const shouldUseYarn = require('@scandipwa/scandipwa-dev-utils/should-use-yarn');
-const ConsoleBlock = require('../util/console-block');
-const { getInstanceMetadata } = require('../util/instance-metadata');
-const UnknownError = require('../errors/unknown-error');
-const KnownError = require('../errors/known-error');
-
-const cmaGaTrackingId = 'UA-127741417-7';
-
-googleAnalytics.setGaTrackingId(cmaGaTrackingId);
+const path = require('path')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { Listr } = require('listr2')
+const { start } = require('../tasks/start')
+const pathExists = require('../util/path-exists')
+const { baseConfig } = require('../config')
+const googleAnalytics = require('../util/analytics')
+const systeminformation = require('systeminformation')
+const { getCSAThemes } = require('../util/CSA-theme')
+const shouldUseYarn = require('@scandipwa/scandipwa-dev-utils/should-use-yarn')
+const ConsoleBlock = require('../util/console-block')
+const { getInstanceMetadata } = require('../util/instance-metadata')
+const UnknownError = require('../errors/unknown-error')
+const KnownError = require('../errors/known-error')
 
+const cmaGaTrackingId = 'UA-127741417-7'
+
+googleAnalytics.setGaTrackingId(cmaGaTrackingId)
+
+/**
+ * @param {(import('listr2').ListrError | Error | import('../errors/known-error') | import('../errors/unknown-error') | string)[]} errors
+ */
 const reportErrors = async (errors) => {
     for (const error of errors) {
-        const path = (error.path && ` Error path: ${error.path} `) || '';
+        const path = (error.path && ` Error path: ${error.path} `) || ''
         if (error instanceof UnknownError || error instanceof KnownError) {
-            logger.error(error.message);
-            logger.error(error.stack);
+            logger.error(error.message)
+            logger.error(error.stack)
             if (error instanceof UnknownError) {
-                await googleAnalytics.trackError(`Unknown Error:${path}${error.stack}`);
+                await googleAnalytics.trackError(
+                    `Unknown Error:${path}${error.stack}`
+                )
             } else {
-                await googleAnalytics.trackError(`Known Error:${path}${error.message}`);
+                await googleAnalytics.trackError(
+                    `Known Error:${path}${error.message}`
+                )
             }
         } else if (error instanceof Error) {
-            logger.error(error.message);
-            logger.error(error.stack);
-            await googleAnalytics.trackError(`Regular Error:${path}${error.message}`);
+            logger.error(error.message)
+            logger.error(error.stack)
+            await googleAnalytics.trackError(
+                `Regular Error:${path}${error.message}`
+            )
         } else {
-            logger.error(error);
-            logger.error(error.stack);
-            await googleAnalytics.trackError(`Non Error:${path}${error}`); // track non-errors throws
+            logger.error(error)
+            logger.error(error.stack)
+            await googleAnalytics.trackError(`Non Error:${path}${error}`) // track non-errors throws
         }
     }
-};
+}
 
 /**
  * @param {import('yargs')} yargs
@@ -47,194 +56,223 @@ module.exports = (yargs) => {
     yargs.command(
         'start',
         'Deploy the application.',
-        (yargs) => yargs
-            .option('port', {
-                alias: 'p',
-                describe: 'Suggest a port for an application to run.',
-                type: 'number',
-                nargs: 1
-            })
-            .option('no-open', {
-                alias: 'n',
-                describe: 'Do not open browser after command finished',
-                type: 'boolean',
-                default: false
-            })
-            .option('debug', {
-                alias: 'd',
-                describe: 'Enable PHP xdebug.',
-                type: 'boolean',
-                default: false
-            })
-            .option('skip-setup', {
-                alias: 's',
-                describe: 'Skip Magento setup',
-                type: 'boolean',
-                default: false
-            })
-            .option('edition', {
-                alias: 'e',
-                describe: 'Magento Edition to install',
-                type: 'string'
-            })
-            .option('recompile-php', {
-                describe: 'Recompile PHP version used in the project',
-                type: 'boolean'
-            })
-            .option('verbose', {
-                alias: 'v',
-                describe: 'Enable verbose logging',
-                type: 'boolean',
-                default: false
-            })
-            .option('pull-images', {
-                describe: 'Pull Docker images',
-                type: 'boolean',
-                default: false
-            })
-            .option('reset-global-config', {
-                describe: 'Reset global magento-scripts configuration',
-                type: 'boolean',
-                default: false
-            }),
+        (yargs) =>
+            yargs
+                .option('port', {
+                    alias: 'p',
+                    describe: 'Suggest a port for an application to run.',
+                    type: 'number',
+                    nargs: 1
+                })
+                .option('no-open', {
+                    alias: 'n',
+                    describe: 'Do not open browser after command finished',
+                    type: 'boolean',
+                    default: false
+                })
+                .option('debug', {
+                    alias: 'd',
+                    describe: 'Enable PHP xdebug.',
+                    type: 'boolean',
+                    default: false
+                })
+                .option('skip-setup', {
+                    alias: 's',
+                    describe: 'Skip Magento setup',
+                    type: 'boolean',
+                    default: false
+                })
+                .option('edition', {
+                    alias: 'e',
+                    describe: 'Magento Edition to install',
+                    type: 'string'
+                })
+                .option('recompile-php', {
+                    describe: 'Recompile PHP version used in the project',
+                    type: 'boolean'
+                })
+                .option('verbose', {
+                    alias: 'v',
+                    describe: 'Enable verbose logging',
+                    type: 'boolean',
+                    default: false
+                })
+                .option('', {
+                    describe: 'Pull Docker images',
+                    type: 'boolean',
+                    default: false
+                })
+                .option('reset-global-config', {
+                    describe: 'Reset global magento-scripts configuration',
+                    type: 'boolean',
+                    default: false
+                }),
         async (args = {}) => {
             /**
              * @type {Listr<import('../../typings/context').ListrContext>}
              */
-            const tasks = new Listr(
-                start(), {
-                    exitOnError: true,
-                    ctx: args,
-                    concurrent: false,
-                    rendererOptions: {
-                        showErrorMessage: false,
-                        showTimer: true
-                    },
-                    collectErrors: 'minimal'
-                }
-            );
-            const timeStamp = Date.now();
+            const tasks = new Listr(start(), {
+                exitOnError: true,
+                ctx: args,
+                concurrent: false,
+                rendererOptions: {
+                    showErrorMessage: false,
+                    showTimer: true
+                },
+                collectErrors: 'minimal'
+            })
+            const timeStamp = Date.now()
 
             if (args.debug) {
-                logger.warn('You are running in debug mode. Magento setup will be slow.');
+                logger.warn(
+                    'You are running in debug mode. Magento setup will be slow.'
+                )
             }
-            const legacyMagentoConfigExists = await pathExists(path.join(baseConfig.cacheDir, 'app-config.json'));
-            const currentConfigExists = await pathExists(path.join(process.cwd(), 'cma.js'));
+            const legacyMagentoConfigExists = await pathExists(
+                path.join(baseConfig.cacheDir, 'app-config.json')
+            )
+            const currentConfigExists = await pathExists(
+                path.join(process.cwd(), 'cma.js')
+            )
             if (legacyMagentoConfigExists && !currentConfigExists) {
-                logger.warn('Magento configuration from app-config.json will be moved to cma.js in your projects directory.');
+                logger.warn(
+                    'Magento configuration from app-config.json will be moved to cma.js in your projects directory.'
+                )
             }
 
+            /**
+             * @type {import('../../typings/context').ListrContext}
+             */
+            let ctx
+
             try {
-                const ctx = await tasks.run();
+                ctx = await tasks.run()
+            } catch (e) {
+                await reportErrors([e])
+                process.exit(1)
+            }
+
+            const {
+                systemConfiguration: { analytics }
+            } = ctx
+
+            const instanceMetadata = getInstanceMetadata(ctx)
 
-                const {
-                    systemConfiguration: { analytics }
-                } = ctx;
+            const block = new ConsoleBlock()
+            block.addHeader('Magento 2').addEmptyLine()
 
-                const instanceMetadata = getInstanceMetadata(ctx);
+            block.addLine(logger.style.misc('Frontend'))
+            instanceMetadata.frontend.forEach(({ title, text }) => {
+                block.addLine(`  ${title}: ${text}`)
+            })
+
+            block.addEmptyLine()
+
+            block.addLine(logger.style.misc('Admin'))
+            instanceMetadata.admin.forEach(({ title, text }) => {
+                block.addLine(`  ${title}: ${text}`)
+            })
+
+            block.addEmptyLine()
 
-                const block = new ConsoleBlock();
+            block.addLine(logger.style.misc('MailDev'))
+            instanceMetadata.maildev.forEach(({ title, text }) => {
+                block.addLine(`  ${title}: ${text}`)
+            })
+
+            const themes = await getCSAThemes()
+            if (themes.length > 0) {
+                const theme = themes[0]
                 block
-                    .addHeader('Magento 2')
-                    .addEmptyLine();
-
-                block.addLine(logger.style.misc('Frontend'));
-                instanceMetadata.frontend.forEach(({ title, text }) => {
-                    block.addLine(`  ${title}: ${text}`);
-                });
-
-                block.addEmptyLine();
-
-                block.addLine(logger.style.misc('Admin'));
-                instanceMetadata.admin.forEach(({ title, text }) => {
-                    block.addLine(`  ${title}: ${text}`);
-                });
-
-                block.addEmptyLine();
-
-                block.addLine(logger.style.misc('MailDev'));
-                instanceMetadata.maildev.forEach(({ title, text }) => {
-                    block.addLine(`  ${title}: ${text}`);
-                });
-
-                const themes = await getCSAThemes();
-                if (themes.length > 0) {
-                    const theme = themes[0];
-                    block
-                        .addEmptyLine()
-                        .addSeparator('ScandiPWA')
-                        .addEmptyLine()
-                        .addLine('To run ScandiPWA theme in Magento mode, run the following command:')
-                        .addLine(`-> ${ logger.style.command(`cd ${ theme.themePath }`) }`)
-                        .addLine(`-> ${ logger.style.command(`BUILD_MODE=magento ${ shouldUseYarn() ? 'yarn start' : 'npm start' }`) }`);
-                }
+                    .addEmptyLine()
+                    .addSeparator('ScandiPWA')
+                    .addEmptyLine()
+                    .addLine(
+                        'To run ScandiPWA theme in Magento mode, run the following command:'
+                    )
+                    .addLine(
+                        `-> ${logger.style.command(`cd ${theme.themePath}`)}`
+                    )
+                    .addLine(
+                        `-> ${logger.style.command(
+                            `BUILD_MODE=magento ${
+                                shouldUseYarn() ? 'yarn start' : 'npm start'
+                            }`
+                        )}`
+                    )
+            }
 
-                block.addEmptyLine();
+            block.addEmptyLine()
 
-                if (process.isOutOfDateVersion) {
-                    block
-                        .addSeparator(logger.style.code('Warning'))
-                        .addEmptyLine();
-                    process.isOutOfDateVersionMessage.forEach((line) => {
-                        block.addLine(line);
-                    });
+            if (process.isOutOfDateVersion) {
+                block.addSeparator(logger.style.code('Warning')).addEmptyLine()
+                process.isOutOfDateVersionMessage.forEach((line) => {
+                    block.addLine(line)
+                })
 
-                    block.addEmptyLine();
-                }
+                block.addEmptyLine()
+            }
 
-                block.log();
+            block.log()
 
-                logger.note(
-                    `MariaDB credentials, containers status and project information available in ${logger.style.code('npm run status')} command.
-      To access Magento CLI, Composer and PHP for this project use ${logger.style.code('npm run cli')} command.`
-                );
-                logger.log('');
+            logger.note(
+                `MariaDB credentials, containers status and project information available in ${logger.style.code(
+                    'npm run status'
+                )} command.
+      To access Magento CLI, Composer and PHP for this project use ${logger.style.code(
+          'npm run cli'
+      )} command.`
+            )
+            logger.log('')
 
-                if (tasks.err && tasks.err.length > 0) {
-                    logger.warn('During the start, we encountered some errors that have not impacted the start-up process!');
-                    logger.log('');
-                    for (const err of tasks.err) {
-                        logger.error(`Error path: ${err.path}\nError message: ${err.message}\n\nError stack: ${err.stack}`);
-                    }
+            if (tasks.err && tasks.err.length > 0) {
+                logger.warn(
+                    'During the start, we encountered some errors that have not impacted the start-up process!'
+                )
+                logger.log('')
+                for (const err of tasks.err) {
+                    logger.error(
+                        `Error path: ${err.path}\nError message: ${err.message}\n\nError stack: ${err.stack}`
+                    )
                 }
+            }
 
-                if (!analytics) {
-                    process.exit(0);
-                }
+            if (!analytics) {
+                process.exit(0)
+            }
 
-                try {
-                    await googleAnalytics.trackTiming('CMA start time', Date.now() - timeStamp);
-                    if (!process.isFirstStart) {
-                        googleAnalytics.printAboutAnalytics();
-                        process.exit(0);
-                    }
-
-                    const { manufacturer, brand } = await systeminformation.cpu();
-                    const { platform, kernel } = await systeminformation.osInfo();
-                    const { total } = await systeminformation.mem();
-
-                    // Get ram amount in MB
-                    const totalRam = Math.round(total / 1024 / 1024);
-                    const paramInfo = `Platform: ${platform} ${kernel}, CPU model: ${manufacturer} ${brand}, RAM amount: ${totalRam}MB`;
-
-                    await googleAnalytics.trackEvent('Params', paramInfo, 0, 'OS');
-                    googleAnalytics.printAboutAnalytics();
-                } catch (e) {
-                    await googleAnalytics.trackError(e.message || e);
+            try {
+                await googleAnalytics.trackTiming(
+                    'CMA start time',
+                    Date.now() - timeStamp
+                )
+                if (!process.isFirstStart) {
+                    googleAnalytics.printAboutAnalytics()
+                    process.exit(0)
                 }
 
-                if (tasks.err && tasks.err.length > 0) {
-                    for (const err of tasks.err) {
-                        console.log(err);
-                    }
-                    await reportErrors(tasks.err);
-                }
+                const { manufacturer, brand } = await systeminformation.cpu()
+                const { platform, kernel } = await systeminformation.osInfo()
+                const { total } = await systeminformation.mem()
 
-                process.exit(0);
+                // Get ram amount in MB
+                const totalRam = Math.round(total / 1024 / 1024)
+                const paramInfo = `Platform: ${platform} ${kernel}, CPU model: ${manufacturer} ${brand}, RAM amount: ${totalRam}MB`
+
+                await googleAnalytics.trackEvent('Params', paramInfo, 0, 'OS')
+                googleAnalytics.printAboutAnalytics()
             } catch (e) {
-                await reportErrors([e]);
-                process.exit(1);
+                await googleAnalytics.trackError(e.message || e)
             }
+
+            if (tasks.err && tasks.err.length > 0) {
+                for (const err of tasks.err) {
+                    console.log(err)
+                }
+                await reportErrors(tasks.err)
+            }
+
+            process.exit(0)
         }
-    );
-};
+    )
+}

package/lib/commands/status.js

@@ -1,59 +1,73 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { Listr } = require('listr2');
-const getMagentoVersionConfig = require('../config/get-magento-version-config');
-const { getCachedPorts } = require('../config/get-port-config');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { Listr } = require('listr2')
+const getMagentoVersionConfig = require('../config/get-magento-version-config')
+const { getCachedPorts } = require('../config/get-port-config')
 
-const { prettyStatus } = require('../tasks/status');
-const { checkRequirements } = require('../tasks/requirements');
-const { statusContainers } = require('../tasks/docker/containers');
-const getProjectConfiguration = require('../config/get-project-configuration');
-const checkConfigurationFile = require('../config/check-configuration-file');
-const checkPHPVersion = require('../tasks/requirements/php-version');
-const { getComposerVersionTask } = require('../tasks/composer');
-const { systemApi } = require('../tasks/docker/system');
+const { prettyStatus } = require('../tasks/status')
+const { checkRequirements } = require('../tasks/requirements')
+const { statusContainers } = require('../tasks/docker/containers')
+const getProjectConfiguration = require('../config/get-project-configuration')
+const checkConfigurationFile = require('../config/check-configuration-file')
+const checkPHPVersion = require('../tasks/requirements/php-version')
+const { getComposerVersionTask } = require('../tasks/composer')
+const { systemApi } = require('../tasks/docker/system')
 
 /**
  * @param {import('yargs')} yargs
  */
 module.exports = (yargs) => {
-    yargs.command('status', 'Show application status', () => {}, async (args) => {
-        const tasks = new Listr([
-            checkRequirements(),
-            getMagentoVersionConfig(),
-            checkConfigurationFile(),
-            getProjectConfiguration(),
-            getCachedPorts(),
-            {
-                task: (_ctx, task) => task.newListr([
-                    checkPHPVersion(),
-                    getComposerVersionTask(),
+    yargs.command(
+        'status',
+        'Show application status',
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        () => {},
+        async (args) => {
+            const tasks = new Listr(
+                [
+                    checkRequirements(),
+                    getMagentoVersionConfig(),
+                    checkConfigurationFile(),
+                    getProjectConfiguration(),
+                    getCachedPorts(),
                     {
-                        title: 'Retrieving Docker System data',
-                        task: async (ctx) => {
-                            ctx.systemDFData = await systemApi.df({
-                                formatToJSON: true,
-                                verbose: true
-                            });
-                        }
-                    }
-                ], {
-                    concurrent: true
-                })
-            },
-            statusContainers()
-        ], {
-            concurrent: false,
-            exitOnError: true,
-            ctx: { throwMagentoVersionMissing: true, ...args },
-            rendererOptions: { collapse: false, clearOutput: true }
-        });
+                        task: (_ctx, task) =>
+                            task.newListr(
+                                [
+                                    checkPHPVersion(),
+                                    getComposerVersionTask(),
+                                    {
+                                        title: 'Retrieving Docker System data',
+                                        task: async (ctx) => {
+                                            ctx.systemDFData =
+                                                await systemApi.df({
+                                                    formatToJSON: true,
+                                                    verbose: true
+                                                })
+                                        }
+                                    }
+                                ],
+                                {
+                                    concurrent: true
+                                }
+                            )
+                    },
+                    statusContainers()
+                ],
+                {
+                    concurrent: false,
+                    exitOnError: true,
+                    ctx: { throwMagentoVersionMissing: true, ...args },
+                    rendererOptions: { collapse: false, clearOutput: true }
+                }
+            )
 
-        try {
-            await prettyStatus(await tasks.run());
-        } catch (e) {
-            logger.error(e.message || e);
-            process.exit(1);
+            try {
+                await prettyStatus(await tasks.run())
+            } catch (e) {
+                logger.error(e.message || e)
+                process.exit(1)
+            }
+            process.exit(0)
         }
-        process.exit(0);
-    });
-};
+    )
+}

package/lib/commands/stop.js

@@ -1,14 +1,17 @@
-const { Listr } = require('listr2');
-const stop = require('../tasks/stop');
+const { Listr } = require('listr2')
+const stop = require('../tasks/stop')
 
 /**
  * @param {import('yargs')} yargs
  */
 module.exports = (yargs) => {
-    yargs.command('stop', 'Stop the application.', () => {}, async () => {
-        const tasks = new Listr(
-            stop(),
-            {
+    yargs.command(
+        'stop',
+        'Stop the application.',
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        () => {},
+        async () => {
+            const tasks = new Listr(stop(), {
                 concurrent: false,
                 exitOnError: true,
                 rendererOptions: {
@@ -18,9 +21,9 @@ module.exports = (yargs) => {
                     throwMagentoVersionMissing: true,
                     projectPath: process.cwd()
                 }
-            }
-        );
+            })
 
-        await tasks.run();
-    });
-};
+            await tasks.run()
+        }
+    )
+}