@scandipwa/magento-scripts 2.0.0-alpha.7 → 2.0.0-alpha.8

package/exec.js

@@ -0,0 +1,71 @@
+#!/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');
+
+if (isRunningRoot()) {
+    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);
+}
+
+process.title = 'magento-scripts';
+
+const newVersionIsAPatch = (latestVersion, currentVersion) => {
+    const latestVersionParsed = semver.parse(latestVersion);
+    const currentVersionParsed = semver.parse(currentVersion);
+
+    return latestVersionParsed.major === currentVersionParsed.major
+    && latestVersionParsed.minor === currentVersionParsed.minor
+    && latestVersionParsed.patch !== currentVersionParsed.patch;
+};
+
+(async () => {
+    const { version: currentVersion, name } = require('./package.json');
+    try {
+        const latestVersion = await getLatestVersion(name);
+
+        if (semver.gt(latestVersion, currentVersion)) {
+            const isNewVersionAPath = newVersionIsAPatch(latestVersion, currentVersion);
+
+            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 }`) }`
+                ];
+            } 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 }`) }.`
+                ];
+            }
+
+            process.isOutOfDateVersion = true;
+            process.isOutOfDateVersionMessage = message;
+        }
+    } catch (e) {
+        logger.warn(`Package ${ logger.style.misc(name) } is not yet published.`);
+        logger.log(); // add empty line
+    }
+
+    const [containername, ...commands] = process.argv.slice(2);
+
+    return executeTask({
+        containername,
+        commands
+    });
+})();

package/index.js

@@ -13,7 +13,7 @@ if (isRunningRoot()) {
 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') }, ${ logger.style.misc('PHPBrew') } and ${ logger.style.misc('PHP') } compilation 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);

package/lib/commands/execute.js

@@ -1,11 +1,4 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { Listr } = require('listr2');
-const checkConfigurationFile = require('../config/check-configuration-file');
-const getProjectConfiguration = require('../config/get-project-configuration');
-const executeInContainer = require('../tasks/execute');
-const getMagentoVersionConfig = require('../config/get-magento-version-config');
-const { checkRequirements } = require('../tasks/requirements');
-const { getCachedPorts } = require('../config/get-port-config');
+const { executeTask } = require('../tasks/execute');
 
 /**
  * @param {import('yargs')} yargs
@@ -26,55 +19,7 @@ Available containers:
 - sslTerminator`);
         },
         async (argv) => {
-            const tasks = new Listr([
-                checkRequirements(),
-                getMagentoVersionConfig(),
-                checkConfigurationFile(),
-                getProjectConfiguration(),
-                getCachedPorts()
-            ], {
-                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 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 container = containers[argv.containername]
-                    ? containers[argv.containername]
-                    : Object.entries(containers).find(([key]) => key.includes(argv.containername))[1];
-
-                if (argv.commands.length === 0) {
-                // if we have default connect command then use it
-                    if (container.connectCommand) {
-                    // eslint-disable-next-line no-param-reassign
-                        argv.commands = container.connectCommand;
-                    } else {
-                    // otherwise fall back to bash (if it exists inside container)
-                        argv.commands.push('bash');
-                    }
-                }
-
-                logger.logN(`Executing container ${logger.style.misc(container._)} (command: ${logger.style.command(argv.commands[0])})`);
-                await executeInContainer({
-                    containerName: container.name,
-                    commands: argv.commands
-                });
-
-                return;
-            }
-
-            logger.error(`No container found "${argv.containername}"`);
+            await executeTask(argv);
         }
     );
 };

package/lib/config/templates/magentorc.template

@@ -2,16 +2,16 @@ RED='\033[0;31m'
 GREEN='\033[0;32m'
 NC='\033[0m' # No Color
 
-alias php="npm run exec php php"
+alias php="node ./node_modules/.bin/magento-scripts-exec php php"
 alias magento="php bin/magento"
 alias magneto="echo -e 'Not ${RED}magneto${NC} but ${GREEN}magento${NC} please! or at least ${GREEN}m${NC}!' && magento"
 alias m="magento"
-alias composer="npm run exec php composer"
+alias composer="node ./node_modules/.bin/magento-scripts-exec php composer"
 alias c="composer"
 <% if (it.varnishEnabled) { %>
-alias cvc="npm run exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
+alias cvc="node ./node_modules/.bin/magento-scripts-exec varnish varnishadm ban req.url '~ /' && echo 'Varnish cache cleared!'"
 <% } %>
-alias mariadb="npm run exec mariadb 'mysql -umagento -pmagento'"
-alias mariadbroot="npm run exec mariadb 'mysql -uroot -pscandipwa'"
+alias mariadb="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -umagento -pmagento'"
+alias mariadbroot="node ./node_modules/.bin/magento-scripts-exec mariadb 'mysql -uroot -pscandipwa'"
 
 export BASH_SILENCE_DEPRECATION_WARNING=1

package/lib/tasks/execute.js

@@ -0,0 +1,98 @@
+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 = require('../util/execute-in-container');
+const { containerApi } = require('./docker/containers');
+const { runPHPContainerCommand } = require('./php/php-container');
+const KnownError = require('../errors/known-error');
+
+/**
+ *
+ * @param {{ containername: string, commands?: string[] }} argv
+ * @returns
+ */
+const executeTask = async (argv) => {
+    const tasks = new Listr([
+        checkRequirements(),
+        getMagentoVersionConfig(),
+        checkConfigurationFile(),
+        getProjectConfiguration(),
+        getCachedPorts()
+    ], {
+        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 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]
+            ? containers[argv.containername]
+            : Object.entries(containers).find(([key]) => key.includes(argv.containername))[1];
+
+        if (argv.commands.length === 0) {
+        // if we have default connect command then use it
+            if (container.connectCommand) {
+            // eslint-disable-next-line no-param-reassign
+                argv.commands = container.connectCommand;
+            } else {
+            // otherwise fall back to bash (if it exists inside container)
+                argv.commands.push('bash');
+            }
+        }
+
+        const containerList = await containerApi.ls({
+            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(' '))})`);
+            const result = await executeInContainer({
+                containerName: container.name,
+                commands: argv.commands
+            });
+
+            return result;
+        }
+
+        if (container.name.endsWith('php')) {
+            logger.logN(`Starting container ${logger.style.misc(container._)} with command: ${logger.style.command(argv.commands.join(' '))}`);
+            const result = await runPHPContainerCommand(
+                ctx,
+                argv.commands.join(' '),
+                {
+                    logOutput: true
+                }
+            );
+
+            return result;
+        }
+
+        throw new KnownError(`Container ${container.name} is not running!`);
+    }
+
+    logger.error(`No container found "${argv.containername}"`);
+};
+
+module.exports = {
+    executeTask
+};

package/lib/tasks/php/php-container.js

@@ -10,9 +10,13 @@ const { containerApi } = require('../docker/containers');
 const runPHPContainerCommand = async (ctx, command, options = {}) => {
     const { php } = ctx.config.docker.getContainers(ctx.ports);
 
-    const containers = await containerApi.ls({ formatToJSON: true, all: true });
+    const containers = await containerApi.ls({
+        formatToJSON: true,
+        all: true,
+        filter: `name=${php.name}`
+    });
 
-    if (containers.some((c) => c.Names === php.name)) {
+    if (containers.length > 0) {
         return execPHPContainerCommand(ctx, command, options);
     }
 

package/lib/{tasks/execute/index.js → util/execute-in-container.js}

@@ -1,6 +1,9 @@
 const os = require('os');
 const { spawn } = require('child_process');
 
+/**
+ * @param {{ containerName: string, commands: string[] }} param0
+ */
 const executeInContainer = ({ containerName, commands }) => {
     if (!process.stdin.isTTY) {
         process.stderr.write('This app works only in TTY mode');
@@ -14,7 +17,10 @@ const executeInContainer = ({ containerName, commands }) => {
         '-it',
         userArg,
         containerName
-    ].filter(Boolean).concat(...commands.map((command) => command.split(' '))), {
+    ]
+        .filter(Boolean)
+        .concat(...commands.map((command) => command.split(' ')).flat()),
+    {
         stdio: [0, 1, 2]
     });
 

package/package.json

@@ -3,12 +3,13 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "2.0.0-alpha.7",
+    "version": "2.0.0-alpha.8",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
     "bin": {
-        "magento-scripts": "./index.js"
+        "magento-scripts": "./index.js",
+        "magento-scripts-exec": "./exec.js"
     },
     "engines": {
         "node": ">=12"
@@ -53,5 +54,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "c965b81745323f4b3dce11965d49b2de32a4d79c"
+    "gitHead": "a7d43251a35fd62dcf74503e2547aa0a0dd080c7"
 }