@scandipwa/magento-scripts 2.0.3-alpha.0 → 2.0.4

package/.eslintrc

@@ -1,5 +1,10 @@
 {
     "globals": {
-        "verbose":true
+        "verbose":true,
+        "NodeJS": true,
+        "BufferEncoding": true
+    },
+    "env": {
+        "node": true
     }
 }

package/exec.js

@@ -1,71 +1,107 @@
 #!/usr/bin/env node
 
-const getLatestVersion = require('@scandipwa/scandipwa-dev-utils/latest-version');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const semver = require('semver');
-const isInstalledGlobally = require('is-installed-globally');
-const isRunningRoot = require('./lib/util/is-running-root');
-const { executeTask } = require('./lib/tasks/execute');
+const getLatestVersion = require('@scandipwa/scandipwa-dev-utils/latest-version')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const semver = require('semver')
+const isInstalledGlobally = require('is-installed-globally')
+const isRunningRoot = require('./lib/util/is-running-root')
+const { executeTask } = require('./lib/tasks/execute')
 
 if (isRunningRoot()) {
-    logger.error('Root privileges detected!');
+    logger.error('Root privileges detected!')
     console.log(`
-We detected that you are running ${ logger.style.misc('magento-scripts') } as root user.
-We cannot allow you to run ${ logger.style.misc('magento-scripts') } with root privileges, this will only cause more problems.
+We detected that you are running ${logger.style.misc(
+        'magento-scripts'
+    )} as root user.
+We cannot allow you to run ${logger.style.misc(
+        'magento-scripts'
+    )} with root privileges, this will only cause more problems.
 
-If you are experiencing problems with ${ logger.style.misc('Docker') } or ${ logger.style.misc('Magento') } setup, running ${ logger.style.misc('magento-scripts') } as root will not solve those problems.
-`);
+If you are experiencing problems with ${logger.style.misc(
+        'Docker'
+    )} or ${logger.style.misc('Magento')} setup, running ${logger.style.misc(
+        'magento-scripts'
+    )} as root will not solve those problems.
+`)
 
-    process.exit(1);
+    process.exit(1)
 }
 
-process.title = 'magento-scripts';
+process.title = 'magento-scripts'
 
+/**
+ * @param {String} latestVersion
+ * @param {String} currentVersion
+ * @returns {Boolean}
+ */
 const newVersionIsAPatch = (latestVersion, currentVersion) => {
-    const latestVersionParsed = semver.parse(latestVersion);
-    const currentVersionParsed = semver.parse(currentVersion);
+    const latestVersionParsed = semver.parse(latestVersion)
+    const currentVersionParsed = semver.parse(currentVersion)
 
-    return latestVersionParsed.major === currentVersionParsed.major
-    && latestVersionParsed.minor === currentVersionParsed.minor
-    && latestVersionParsed.patch !== currentVersionParsed.patch;
-};
+    return Boolean(
+        latestVersionParsed &&
+            currentVersionParsed &&
+            latestVersionParsed.major === currentVersionParsed.major &&
+            latestVersionParsed.minor === currentVersionParsed.minor &&
+            latestVersionParsed.patch !== currentVersionParsed.patch
+    )
+}
 
-(async () => {
-    const { version: currentVersion, name } = require('./package.json');
+;(async () => {
+    const { version: currentVersion, name } = require('./package.json')
     try {
-        const latestVersion = await getLatestVersion(name);
+        const latestVersion = await getLatestVersion(name)
 
         if (semver.gt(latestVersion, currentVersion)) {
-            const isNewVersionAPath = newVersionIsAPatch(latestVersion, currentVersion);
+            const isNewVersionAPath = newVersionIsAPatch(
+                latestVersion,
+                currentVersion
+            )
 
-            let message = [];
+            let message = []
 
             if (isNewVersionAPath) {
                 message = [
-                    `A patch for ${ logger.style.misc(name) } is available!`,
-                    `We recommend to update to latest version ${ logger.style.misc(latestVersion) }!`,
-                    `-> ${ logger.style.command(`npm i ${ isInstalledGlobally ? '-g ' : '' }${ name }@${ latestVersion }`) }`
-                ];
+                    `A patch for ${logger.style.misc(name)} is available!`,
+                    `We recommend to update to latest version ${logger.style.misc(
+                        latestVersion
+                    )}!`,
+                    `-> ${logger.style.command(
+                        `npm i ${
+                            isInstalledGlobally ? '-g ' : ''
+                        }${name}@${latestVersion}`
+                    )}`
+                ]
             } else {
                 message = [
-                    `${ isInstalledGlobally ? 'Global module' : 'Module' } ${ logger.style.misc(name) } (${currentVersion}) is out-dated.`,
-                    `Please upgrade it to latest version ${ logger.style.misc(latestVersion) }.`,
-                    `You can do it by running the following command: ${ logger.style.command(`npm i ${ isInstalledGlobally ? '-g ' : '' }${ name }@${ latestVersion }`) }.`
-                ];
+                    `${
+                        isInstalledGlobally ? 'Global module' : 'Module'
+                    } ${logger.style.misc(
+                        name
+                    )} (${currentVersion}) is out-dated.`,
+                    `Please upgrade it to latest version ${logger.style.misc(
+                        latestVersion
+                    )}.`,
+                    `You can do it by running the following command: ${logger.style.command(
+                        `npm i ${
+                            isInstalledGlobally ? '-g ' : ''
+                        }${name}@${latestVersion}`
+                    )}.`
+                ]
             }
 
-            process.isOutOfDateVersion = true;
-            process.isOutOfDateVersionMessage = message;
+            process.isOutOfDateVersion = true
+            process.isOutOfDateVersionMessage = message
         }
     } catch (e) {
-        logger.warn(`Package ${ logger.style.misc(name) } is not yet published.`);
-        logger.log(); // add empty line
+        logger.warn(`Package ${logger.style.misc(name)} is not yet published.`)
+        logger.log() // add empty line
     }
 
-    const [containername, ...commands] = process.argv.slice(2);
+    const [containername, ...commands] = process.argv.slice(2)
 
     return executeTask({
         containername,
         commands
-    });
-})();
+    })
+})()

package/index.js

@@ -1,22 +1,30 @@
 #!/usr/bin/env node
 
-const yargs = require('yargs');
-const getLatestVersion = require('@scandipwa/scandipwa-dev-utils/latest-version');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const semver = require('semver');
-const isInstalledGlobally = require('is-installed-globally');
-const isRunningRoot = require('./lib/util/is-running-root');
+const yargs = require('yargs')
+const getLatestVersion = require('@scandipwa/scandipwa-dev-utils/latest-version')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const semver = require('semver')
+const isInstalledGlobally = require('is-installed-globally')
+const isRunningRoot = require('./lib/util/is-running-root')
 
 if (isRunningRoot()) {
-    logger.error('Root privileges detected!');
+    logger.error('Root privileges detected!')
     console.log(`
-We detected that you are running ${ logger.style.misc('magento-scripts') } as root user.
-We cannot allow you to run ${ logger.style.misc('magento-scripts') } with root privileges, this will only cause more problems.
-
-If you are experiencing problems with ${ logger.style.misc('Docker') } or ${ logger.style.misc('Magento') } setup, running ${ logger.style.misc('magento-scripts') } as root will not solve those problems.
-`);
-
-    process.exit(1);
+We detected that you are running ${logger.style.misc(
+        'magento-scripts'
+    )} as root user.
+We cannot allow you to run ${logger.style.misc(
+        'magento-scripts'
+    )} with root privileges, this will only cause more problems.
+
+If you are experiencing problems with ${logger.style.misc(
+        'Docker'
+    )} or ${logger.style.misc('Magento')} setup, running ${logger.style.misc(
+        'magento-scripts'
+    )} as root will not solve those problems.
+`)
+
+    process.exit(1)
 }
 
 const commands = [
@@ -29,61 +37,94 @@ const commands = [
     require('./lib/commands/status'),
     require('./lib/commands/execute'),
     require('./lib/commands/import-db')
-];
+]
 
-process.title = 'magento-scripts';
+process.title = 'magento-scripts'
 
+/**
+ * @param {string} latestVersion
+ * @param {string} currentVersion
+ */
 const newVersionIsAPatch = (latestVersion, currentVersion) => {
-    const latestVersionParsed = semver.parse(latestVersion);
-    const currentVersionParsed = semver.parse(currentVersion);
+    const latestVersionParsed = semver.parse(latestVersion)
+    const currentVersionParsed = semver.parse(currentVersion)
 
-    return latestVersionParsed.major === currentVersionParsed.major
-    && latestVersionParsed.minor === currentVersionParsed.minor
-    && latestVersionParsed.patch !== currentVersionParsed.patch;
-};
+    if (!latestVersionParsed || !currentVersionParsed) {
+        return false
+    }
+
+    return (
+        latestVersionParsed.major === currentVersionParsed.major &&
+        latestVersionParsed.minor === currentVersionParsed.minor &&
+        latestVersionParsed.patch !== currentVersionParsed.patch
+    )
+}
 
-(async () => {
-    const { version: currentVersion, name } = require('./package.json');
+;(async () => {
+    const { version: currentVersion, name } = require('./package.json')
     try {
-        const latestVersion = await getLatestVersion(name);
+        const latestVersion = await getLatestVersion(name)
 
         if (semver.gt(latestVersion, currentVersion)) {
-            const isNewVersionAPath = newVersionIsAPatch(latestVersion, currentVersion);
+            const isNewVersionAPath = newVersionIsAPatch(
+                latestVersion,
+                currentVersion
+            )
 
-            let message = [];
+            let message = []
 
             if (isNewVersionAPath) {
                 message = [
-                    `A patch for ${ logger.style.misc(name) } is available!`,
-                    `We recommend to update to latest version ${ logger.style.misc(latestVersion) }!`,
-                    `-> ${ logger.style.command(`npm i ${ isInstalledGlobally ? '-g ' : '' }${ name }@${ latestVersion }`) }`
-                ];
+                    `A patch for ${logger.style.misc(name)} is available!`,
+                    `We recommend to update to latest version ${logger.style.misc(
+                        latestVersion
+                    )}!`,
+                    `-> ${logger.style.command(
+                        `npm i ${
+                            isInstalledGlobally ? '-g ' : ''
+                        }${name}@${latestVersion}`
+                    )}`
+                ]
             } else {
                 message = [
-                    `${ isInstalledGlobally ? 'Global module' : 'Module' } ${ logger.style.misc(name) } (${currentVersion}) is out-dated.`,
-                    `Please upgrade it to latest version ${ logger.style.misc(latestVersion) }.`,
-                    `You can do it by running the following command: ${ logger.style.command(`npm i ${ isInstalledGlobally ? '-g ' : '' }${ name }@${ latestVersion }`) }.`
-                ];
+                    `${
+                        isInstalledGlobally ? 'Global module' : 'Module'
+                    } ${logger.style.misc(
+                        name
+                    )} (${currentVersion}) is out-dated.`,
+                    `Please upgrade it to latest version ${logger.style.misc(
+                        latestVersion
+                    )}.`,
+                    `You can do it by running the following command: ${logger.style.command(
+                        `npm i ${
+                            isInstalledGlobally ? '-g ' : ''
+                        }${name}@${latestVersion}`
+                    )}.`
+                ]
             }
 
-            const doNotLogOutOfDateCommands = ['start'];
+            const doNotLogOutOfDateCommands = ['start']
 
-            if (!yargs.argv._.some((arg) => doNotLogOutOfDateCommands.includes(arg))) {
-                logger.warn(...message);
+            if (
+                !yargs.argv._.some((arg) =>
+                    doNotLogOutOfDateCommands.includes(arg)
+                )
+            ) {
+                logger.warn(...message)
             }
-            process.isOutOfDateVersion = true;
-            process.isOutOfDateVersionMessage = message;
+            process.isOutOfDateVersion = true
+            process.isOutOfDateVersionMessage = message
         }
     } catch (e) {
-        logger.warn(`Package ${ logger.style.misc(name) } is not yet published.`);
-        logger.log(); // add empty line
+        logger.warn(`Package ${logger.style.misc(name)} is not yet published.`)
+        logger.log() // add empty line
     }
 
-    yargs.scriptName('magento-scripts');
+    yargs.scriptName('magento-scripts')
 
     // Initialize program commands
-    commands.forEach((command) => command(yargs));
+    commands.forEach((command) => command(yargs))
 
     // eslint-disable-next-line no-unused-expressions
-    yargs.argv;
-})();
+    yargs.argv
+})()

package/lib/commands/cleanup.js

@@ -1,6 +1,6 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { Listr } = require('listr2');
-const cleanup = require('../tasks/cleanup');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { Listr } = require('listr2')
+const cleanup = require('../tasks/cleanup')
 
 /**
  * @param {import('yargs')} yargs
@@ -9,28 +9,25 @@ module.exports = (yargs) => {
     yargs.command(
         'cleanup',
         'Cleanup project folder',
-        (yargs) => yargs.option(
-            'force',
-            {
+        (yargs) =>
+            yargs.option('force', {
                 alias: 'f',
                 describe: 'Force cleanup to remove app directory',
                 type: 'boolean',
                 default: false
-            }
-        ),
+            }),
         async (args) => {
-            logger.warn('you should not use this command.');
-            const tasks = new Listr(
-                cleanup(),
-                {
-                    concurrent: false,
-                    exitOnError: true,
-                    ctx: { force: args.force },
-                    rendererOptions: { collapse: false }
-                }
-            );
+            logger.warn('you should not use this command.')
+            const tasks = new Listr(cleanup(), {
+                concurrent: false,
+                exitOnError: true,
+                ctx: {
+                    force: args.force
+                },
+                rendererOptions: { collapse: false }
+            })
 
-            await tasks.run();
+            await tasks.run()
         }
-    );
-};
+    )
+}

package/lib/commands/cli.js

@@ -1,89 +1,154 @@
-const { Listr } = require('listr2');
-const cli = require('../tasks/cli');
-const createBashrcConfigFile = require('../tasks/cli/create-bashrc-config');
-const getMagentoVersionConfig = require('../config/get-magento-version-config');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const getProjectConfiguration = require('../config/get-project-configuration');
-const checkConfigurationFile = require('../config/check-configuration-file');
-const ConsoleBlock = require('../util/console-block');
-const { checkComposerCredentials } = require('../tasks/requirements/composer-credentials');
-const pkg = require('../../package.json');
+const { Listr } = require('listr2')
+const cli = require('../tasks/cli')
+const createBashrcConfigFile = require('../tasks/cli/create-bashrc-config')
+const getMagentoVersionConfig = require('../config/get-magento-version-config')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const getProjectConfiguration = require('../config/get-project-configuration')
+const checkConfigurationFile = require('../config/check-configuration-file')
+const ConsoleBlock = require('../util/console-block')
+const {
+    checkComposerCredentials
+} = require('../tasks/requirements/composer-credentials')
+const pkg = require('../../package.json')
 
 /**
  * @param {import('yargs')} yargs
  */
 module.exports = (yargs) => {
-    yargs.command('cli', 'Enter CLI (magento, php, composer).', () => {}, async () => {
-        const tasks = new Listr([
-            getMagentoVersionConfig(),
-            checkConfigurationFile(),
-            getProjectConfiguration(),
-            createBashrcConfigFile(),
-            checkComposerCredentials()
-        ], {
-            concurrent: false,
-            exitOnError: true,
-            ctx: {
-                throwMagentoVersionMissing: true
-            },
-            rendererOptions: { collapse: false, clearOutput: true }
-        });
+    yargs.command(
+        'cli',
+        'Enter CLI (magento, php, composer).',
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        () => {},
+        async () => {
+            const tasks = new Listr(
+                [
+                    getMagentoVersionConfig(),
+                    checkConfigurationFile(),
+                    getProjectConfiguration(),
+                    createBashrcConfigFile(),
+                    checkComposerCredentials()
+                ],
+                {
+                    concurrent: false,
+                    exitOnError: true,
+                    ctx: {
+                        throwMagentoVersionMissing: true
+                    },
+                    rendererOptions: { collapse: false, clearOutput: true }
+                }
+            )
 
-        let ctx;
-        try {
-            ctx = await tasks.run();
-        } catch (e) {
-            logger.error(e.message || e);
-            process.exit(1);
-        }
-
-        const block = new ConsoleBlock();
+            let ctx
+            try {
+                ctx = await tasks.run()
+            } catch (e) {
+                logger.error(e.message || e)
+                process.exit(1)
+            }
 
-        block
-            .addHeader('Create Magento App CLI')
-            .addEmptyLine()
-            .addLine(`Magento version: ${logger.style.link(ctx.magentoVersion)}`)
-            .addLine(`${logger.style.file('magento-scripts')} version: ${logger.style.link(pkg.version)}`)
-            .addEmptyLine()
-            .addLine(`Available aliases: ${logger.style.command('php')}, ${logger.style.command('magento')}, ${logger.style.command('composer')}`)
-            .addLine(`Available shortcuts: magento -> ${logger.style.command('m')}, composer -> ${logger.style.command('c')}`)
-            .addEmptyLine();
+            const block = new ConsoleBlock()
 
-        block
-            .addLine(`Execute into any service: ${logger.style.command('exec <service name>')}`)
-            .addLine(`Execute into PHP container: ${logger.style.command('exec php')}`)
-            .addEmptyLine();
+            block
+                .addHeader('Create Magento App CLI')
+                .addEmptyLine()
+                .addLine(
+                    `Magento version: ${logger.style.link(ctx.magentoVersion)}`
+                )
+                .addLine(
+                    `${logger.style.file(
+                        'magento-scripts'
+                    )} version: ${logger.style.link(pkg.version)}`
+                )
+                .addEmptyLine()
+                .addLine(
+                    `Available aliases: ${logger.style.command(
+                        'php'
+                    )}, ${logger.style.command(
+                        'magento'
+                    )}, ${logger.style.command('composer')}`
+                )
+                .addLine(
+                    `Available shortcuts: magento -> ${logger.style.command(
+                        'm'
+                    )}, composer -> ${logger.style.command('c')}`
+                )
+                .addEmptyLine()
 
-        if (ctx.config.overridenConfiguration.configuration.varnish.enabled) {
-            block.addLine(`Clear Varnish cache: ${logger.style.command('cvc')}`);
-        }
+            block
+                .addLine(
+                    `Execute into any service: ${logger.style.command(
+                        'exec <service name>'
+                    )}`
+                )
+                .addLine(
+                    `Execute into PHP container: ${logger.style.command(
+                        'exec php'
+                    )}`
+                )
+                .addEmptyLine()
 
-        block
-            .addLine(`Clear Magento cache: ${logger.style.command('m c:c')}`)
-            .addLine(`Magento setup upgrade: ${logger.style.command('m se:up')}`)
-            .addLine(`Magento DI compile: ${logger.style.command('m s:d:c')}`)
-            .addEmptyLine();
+            if (
+                ctx.config.overridenConfiguration.configuration.varnish.enabled
+            ) {
+                block.addLine(
+                    `Clear Varnish cache: ${logger.style.command('cvc')}`
+                )
+            }
 
-        block
-            .addLine(`Clear Composer cache: ${logger.style.command('c cc')}`)
-            .addEmptyLine();
+            block
+                .addLine(
+                    `Clear Magento cache: ${logger.style.command('m c:c')}`
+                )
+                .addLine(
+                    `Magento setup upgrade: ${logger.style.command('m se:up')}`
+                )
+                .addLine(
+                    `Magento DI compile: ${logger.style.command('m s:d:c')}`
+                )
+                .addEmptyLine()
 
-        block
-            .addLine(`Connect to MariaDB server: ${logger.style.command('mariadb')}`)
-            .addLine(`Connect to MariaDB server as root: ${logger.style.command('mariadbroot')}`)
-            .addEmptyLine();
+            block
+                .addLine(
+                    `Clear Composer cache: ${logger.style.command('c cc')}`
+                )
+                .addEmptyLine()
 
-        if (ctx.debug) {
             block
-                .addLine('Debug PHP in CLI:')
-                .addLine('1. Start debugger in VSCode or PHPStorm')
-                .addLine(`2. Go to PHP container: ${ logger.style.command('exec php') }`)
-                .addLine(`3. Run CLI command with ${ logger.style.code('XDEBUG_SESSION=phpstorm') } environmental variable: ${ logger.style.command('XDEBUG_SESSION=phpstorm magento <command>') }`)
-                .addLine('4. Enjoy');
-        }
+                .addLine(
+                    `Connect to MariaDB server: ${logger.style.command(
+                        'mariadb'
+                    )}`
+                )
+                .addLine(
+                    `Connect to MariaDB server as root: ${logger.style.command(
+                        'mariadbroot'
+                    )}`
+                )
+                .addEmptyLine()
 
-        block.log();
+            if (ctx.debug) {
+                block
+                    .addLine('Debug PHP in CLI:')
+                    .addLine('1. Start debugger in VSCode or PHPStorm')
+                    .addLine(
+                        `2. Go to PHP container: ${logger.style.command(
+                            'exec php'
+                        )}`
+                    )
+                    .addLine(
+                        `3. Run CLI command with ${logger.style.code(
+                            'XDEBUG_SESSION=phpstorm'
+                        )} environmental variable: ${logger.style.command(
+                            'XDEBUG_SESSION=phpstorm magento <command>'
+                        )}`
+                    )
+                    .addLine('4. Enjoy')
+            }
 
-        return cli();
-    });
-};
+            block.log()
+
+            return cli()
+        }
+    )
+}

package/lib/commands/execute.js

@@ -1,4 +1,4 @@
-const { executeTask } = require('../tasks/execute');
+const { executeTask } = require('../tasks/execute')
 
 /**
  * @param {import('yargs')} yargs
@@ -16,10 +16,10 @@ Available containers:
 - redis
 - elasticsearch
 - varnish (if enabled)
-- sslTerminator`);
+- sslTerminator`)
         },
         async (argv) => {
-            await executeTask(argv);
+            await executeTask(argv)
         }
-    );
-};
+    )
+}