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

package/lib/util/execute-in-container.js

@@ -1,44 +1,39 @@
-const { spawn } = require('child_process');
-const { runCommand } = require('../tasks/docker/containers/container-api');
+const { spawn } = require('child_process')
+const { runCommand } = require('../tasks/docker/containers/container-api')
 
 /**
  * @param {{ containerName: string, commands: string[], user?: string }} param0
+ * @returns {Promise<never>}
  */
-const executeInContainer = ({
-    containerName, commands, user
-}) => {
+const executeInContainer = ({ containerName, commands, user }) => {
     if (!process.stdin.isTTY) {
-        process.stderr.write('This app works only in TTY mode');
-        process.exit(1);
+        process.stderr.write('This app works only in TTY mode')
+        process.exit(1)
     }
 
-    const userArg = user && `--user=${user}`;
-
-    spawn('docker', [
-        'exec',
-        '-it',
-        userArg,
-        containerName
-    ]
+    const userArg = (user && `--user=${user}`) || ''
+    const args = ['exec', '-it', userArg, containerName]
         .filter(Boolean)
-        .concat(...commands.map((command) => command.split(' ')).flat()),
-    {
+        .concat(...commands.map((command) => command.split(' ')).flat())
+
+    spawn('docker', args, {
         stdio: [0, 1, 2]
-    });
+    })
 
     return new Promise((_resolve) => {
         // never resolve
-    });
-};
+    })
+}
 
 /**
  * @param {import('../tasks/docker/containers/container-api').ContainerRunOptions} options
  * @param {string[]} commands
+ * @returns {Promise<never>}
  */
 const runInContainer = (options, commands) => {
     if (!process.stdin.isTTY) {
-        process.stderr.write('This app works only in TTY mode');
-        process.exit(1);
+        process.stderr.write('This app works only in TTY mode')
+        process.exit(1)
     }
 
     const runArgs = runCommand({
@@ -47,16 +42,16 @@ const runInContainer = (options, commands) => {
         detach: false,
         rm: true,
         command: commands.join(' ')
-    });
+    })
 
-    spawn('bash', ['-c', runArgs.join(' ')], { stdio: [0, 1, 2] });
+    spawn('bash', ['-c', runArgs.join(' ')], { stdio: [0, 1, 2] })
 
     return new Promise((_resolve) => {
         // never resolve
-    });
-};
+    })
+}
 
 module.exports = {
     executeInContainer,
     runInContainer
-};
+}

package/lib/util/execute-sudo-command.js

@@ -1,31 +1,27 @@
-const os = require('os');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { execCommandTask } = require('./exec-async-command');
+const os = require('os')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { execCommandTask } = require('./exec-async-command')
 
 /**
- * @type {(
- *   command: string,
- *   options: Omit<import('../util/exec-async-command').ExecAsyncSpawnOptions<false>, 'callback' | 'pipeInput'>
- * ) => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @type {<T extends boolean>(command: string, options?: Omit<import('../util/exec-async-command').ExecAsyncSpawnOptions<T>, 'pipeInput'>) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const executeSudoCommand = (command, options = {}) => ({
     task: async (ctx, task) => {
-        task.output = 'Enter your sudo password!';
-        task.output = logger.style.command(`>[sudo] password for ${ os.userInfo().username }:`);
+        task.output = 'Enter your sudo password!'
+        task.output = logger.style.command(
+            `>[sudo] password for ${os.userInfo().username}:`
+        )
 
         return task.newListr(
             execCommandTask(command, {
-                callback: (t) => {
-                    task.output = t;
-                },
                 pipeInput: true,
                 ...options
             })
-        );
+        )
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = executeSudoCommand;
+module.exports = executeSudoCommand

package/lib/util/get-brew-bin-path.js

@@ -1,57 +1,61 @@
-const { getArch, getArchSync } = require('./arch');
+const { getArch, getArchSync } = require('./arch')
 
-const BREW_BIN_PATH_INTEL = '/usr/local/bin/brew';
-const BREW_BIN_PATH_ARM_ROSETTA = '/usr/local/homebrew/bin/brew';
+const BREW_BIN_PATH_INTEL = '/usr/local/bin/brew'
+const BREW_BIN_PATH_ARM_ROSETTA = '/usr/local/homebrew/bin/brew'
 // native is not used ATM
-const BREW_BIN_PATH_ARM_NATIVE = '/opt/homebrew/bin/brew';
+const BREW_BIN_PATH_ARM_NATIVE = '/opt/homebrew/bin/brew'
 
 const getBrewBinPath = async () => {
-    const arch = await getArch();
+    const arch = await getArch()
 
     if (arch === 'arm64') {
-        return BREW_BIN_PATH_ARM_ROSETTA;
+        return BREW_BIN_PATH_ARM_ROSETTA
     }
 
-    return BREW_BIN_PATH_INTEL;
-};
+    return BREW_BIN_PATH_INTEL
+}
 
 const getBrewBinPathSync = () => {
-    const arch = getArchSync();
+    const arch = getArchSync()
 
     if (arch === 'arm64') {
-        return BREW_BIN_PATH_ARM_ROSETTA;
+        return BREW_BIN_PATH_ARM_ROSETTA
     }
 
-    return BREW_BIN_PATH_INTEL;
-};
+    return BREW_BIN_PATH_INTEL
+}
 
 const getBrewCommand = async ({ native } = { native: false }) => {
-    const arch = await getArch();
+    const arch = await getArch()
 
     if (arch === 'arm64') {
         if (native) {
-            return `arch -arm64 ${BREW_BIN_PATH_ARM_NATIVE}`;
+            return `arch -arm64 ${BREW_BIN_PATH_ARM_NATIVE}`
         }
 
-        return `arch -x86_64 ${BREW_BIN_PATH_ARM_ROSETTA}`;
+        return `arch -x86_64 ${BREW_BIN_PATH_ARM_ROSETTA}`
     }
 
-    return BREW_BIN_PATH_INTEL;
-};
+    return BREW_BIN_PATH_INTEL
+}
 
+/**
+ * @param {{ native?: boolean }} param0
+ * @returns
+ */
 const getBrewCommandSync = ({ native } = { native: false }) => {
-    const arch = getArchSync();
+    const arch = getArchSync()
 
     if (arch === 'arm64') {
         if (native) {
-            return `arch -arm64 ${BREW_BIN_PATH_ARM_NATIVE}`;
+            return `arch -arm64 ${BREW_BIN_PATH_ARM_NATIVE}`
         }
 
-        return `arch -x86_64 ${BREW_BIN_PATH_ARM_ROSETTA}`;
+        return `arch -x86_64 ${BREW_BIN_PATH_ARM_ROSETTA}`
     }
 
-    return BREW_BIN_PATH_INTEL;
-};
+    return BREW_BIN_PATH_INTEL
+}
 
 module.exports = {
     getBrewBinPath,
@@ -61,4 +65,4 @@ module.exports = {
     BREW_BIN_PATH_INTEL,
     BREW_BIN_PATH_ARM_ROSETTA,
     BREW_BIN_PATH_ARM_NATIVE
-};
+}

package/lib/util/get-installed-magento-version.js

@@ -1,34 +1,40 @@
-const fs = require('fs');
-const path = require('path');
-const KnownError = require('../errors/known-error');
-const pathExists = require('./path-exists');
-
+const fs = require('fs')
+const path = require('path')
+const KnownError = require('../errors/known-error')
+const pathExists = require('./path-exists')
+
+/**
+ * @param {string} composerPath
+ * @returns {Promise<{ require: Record<string, string> } | null>}
+ */
 const getComposerData = async (composerPath) => {
-    const composerExists = await pathExists(composerPath);
+    const composerExists = await pathExists(composerPath)
 
     if (!composerExists) {
-        return null;
+        return null
     }
 
-    return JSON.parse(await fs.promises.readFile(composerPath, 'utf-8'));
-};
+    return JSON.parse(await fs.promises.readFile(composerPath, 'utf-8'))
+}
 
 const getInstalledMagentoVersion = async (projectPath = process.cwd()) => {
-    const composerData = await getComposerData(path.join(projectPath, 'composer.json'));
+    const composerData = await getComposerData(
+        path.join(projectPath, 'composer.json')
+    )
 
     if (!composerData) {
-        throw new KnownError('composer.json not found');
+        throw new KnownError('composer.json not found')
     }
     const magentoDependency = [
         'magento/product-community-edition',
         'magento/product-enterprise-edition'
-    ].find((magentoEdition) => composerData.require[magentoEdition]);
+    ].find((magentoEdition) => composerData.require[magentoEdition])
 
     if (!magentoDependency) {
-        throw new KnownError('No Magento dependency found in composer.json');
+        throw new KnownError('No Magento dependency found in composer.json')
     }
 
-    return composerData.require[magentoDependency].replace(/\^/i, '');
-};
+    return composerData.require[magentoDependency].replace(/\^/i, '')
+}
 
-module.exports = getInstalledMagentoVersion;
+module.exports = getInstalledMagentoVersion

package/lib/util/get-jsonfile-data.js

@@ -1,19 +1,24 @@
-const fs = require('fs');
-const UnknownError = require('../errors/unknown-error');
-const pathExists = require('./path-exists');
+const fs = require('fs')
+const UnknownError = require('../errors/unknown-error')
+const pathExists = require('./path-exists')
 
+/**
+ * @type {<T>(fileData: string) => Promise<T | null>}
+ */
 const getJsonfileData = async (filePath) => {
-    const fileExists = await pathExists(filePath);
+    const fileExists = await pathExists(filePath)
 
     if (!fileExists) {
-        return null;
+        return null
     }
 
     try {
-        return JSON.parse(await fs.promises.readFile(filePath, 'utf-8'));
+        return JSON.parse(await fs.promises.readFile(filePath, 'utf-8'))
     } catch (e) {
-        throw new UnknownError(`Ooops! Something went wrong when trying to json parse ${filePath} file!\n\n${e}`);
+        throw new UnknownError(
+            `Ooops! Something went wrong when trying to json parse ${filePath} file!\n\n${e}`
+        )
     }
-};
+}
 
-module.exports = getJsonfileData;
+module.exports = getJsonfileData

package/lib/util/install-dependencies-task.js

@@ -1,100 +1,112 @@
-const os = require('os');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const sleep = require('./sleep');
-const { execCommandTask } = require('./exec-async-command');
-const dependenciesForPlatforms = require('../config/dependencies-for-platforms');
-const KnownError = require('../errors/known-error');
+const os = require('os')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const sleep = require('./sleep')
+const { execCommandTask } = require('./exec-async-command')
+const dependenciesForPlatforms = require('../config/dependencies-for-platforms')
+const KnownError = require('../errors/known-error')
 
 /**
  * Install dependencies
  * @param {object} options
  * @param {keyof dependenciesForPlatforms} options.platform Platform
  * @param {string[]} options.dependenciesToInstall List of dependencies to install
- * @param {boolean} options.useMacNativeEnvironment Use Mac native environment
+ * @param {boolean} [options.useMacNativeEnvironment] Use Mac native environment
  * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const installDependenciesTask = (options) => ({
     task: async (ctx, task) => {
-        const { dependenciesToInstall, platform } = options;
-        task.title = `Installing ${platform} dependencies`;
-        let cmd;
+        const { dependenciesToInstall, platform } = options
+        task.title = `Installing ${platform} dependencies`
+        let cmd
         if (os.platform() === 'darwin') {
-            cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '), {
-                native: options.useMacNativeEnvironment
-            });
+            cmd = dependenciesForPlatforms[platform].installCommand(
+                dependenciesToInstall.join(' '),
+                {
+                    native: options.useMacNativeEnvironment
+                }
+            )
         } else {
-            cmd = dependenciesForPlatforms[platform].installCommand(dependenciesToInstall.join(' '));
+            cmd = dependenciesForPlatforms[platform].installCommand(
+                dependenciesToInstall.join(' ')
+            )
         }
-        const installCommand = logger.style.code(cmd);
-        const dependenciesWordFormatter = `dependenc${dependenciesToInstall.length > 1 ? 'ies' : 'y'}`;
-        task.title = `Installing missing dependencies: ${ logger.style.code(dependenciesToInstall.join(', ')) }`;
-        task.output = `Missing ${ dependenciesWordFormatter } ${ logger.style.code(dependenciesToInstall.join(' ')) } detected!`;
+        const installCommand = logger.style.code(cmd)
+        const dependenciesWordFormatter = `dependenc${
+            dependenciesToInstall.length > 1 ? 'ies' : 'y'
+        }`
+        task.title = `Installing missing dependencies: ${logger.style.code(
+            dependenciesToInstall.join(', ')
+        )}`
+        task.output = `Missing ${dependenciesWordFormatter} ${logger.style.code(
+            dependenciesToInstall.join(' ')
+        )} detected!`
 
-        let promptSkipper = false;
+        let promptSkipper = false
         const timer = async () => {
             for (let i = 5 * 60; i !== 0; i--) {
-                await sleep(1000);
+                await sleep(1000)
                 if (promptSkipper) {
-                    return null;
+                    return null
                 }
-                task.title = `Checking ${platform} dependencies (${i} sec left...)`;
+                task.title = `Checking ${platform} dependencies (${i} sec left...)`
             }
-            task.cancelPrompt();
-            return 'timeout';
-        };
+            task.cancelPrompt()
+            return 'timeout'
+        }
 
         const installAnswer = await Promise.race([
             task.prompt({
                 type: 'Select',
-                message: `Do you want to install missing ${ dependenciesWordFormatter } now?`,
+                message: `Do you want to install missing ${dependenciesWordFormatter} now?`,
                 name: 'installAnswer',
                 choices: [
                     {
                         name: 'install',
-                        message: `Install ${ dependenciesWordFormatter } now!`
+                        message: `Install ${dependenciesWordFormatter} now!`
                     },
                     {
                         name: 'not-install',
-                        message: `Install ${ dependenciesWordFormatter } later, when I feel it.`
+                        message: `Install ${dependenciesWordFormatter} later, when I feel it.`
                     }
                 ]
             }),
             timer()
-        ]);
+        ])
 
-        promptSkipper = true;
+        promptSkipper = true
 
         if (installAnswer === 'timeout') {
             throw new KnownError(`Timeout!
 
-To install missing ${ dependenciesWordFormatter } manually, run the following command: ${ installCommand }`);
+To install missing ${dependenciesWordFormatter} manually, run the following command: ${installCommand}`)
         }
 
         if (installAnswer === 'not-install') {
-            task.skip(`User chose to skip installation of ${ dependenciesWordFormatter }`);
-            return;
+            task.skip(
+                `User chose to skip installation of ${dependenciesWordFormatter}`
+            )
+            return
         }
 
         if (installAnswer === 'install') {
             // on macos we don't need sudo permissions to install dependencies, so every other platform required to do that
             if (platform !== 'darwin') {
-                task.output = `Enter your sudo password! It's needed for ${ dependenciesWordFormatter } installation.`;
-                task.output = logger.style.command(`>[sudo] password for ${ os.userInfo().username }:`);
+                task.output = `Enter your sudo password! It's needed for ${dependenciesWordFormatter} installation.`
+                task.output = logger.style.command(
+                    `>[sudo] password for ${os.userInfo().username}:`
+                )
             }
 
             return task.newListr(
                 execCommandTask(cmd, {
-                    callback: (t) => {
-                        task.output = t;
-                    },
                     pipeInput: true
                 })
-            );
+            )
         }
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = installDependenciesTask;
+module.exports = installDependenciesTask

package/lib/util/instance-metadata.js

@@ -1,20 +1,23 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
 
-const WEB_LOCAL_LOCATION_TITLE = `Location on ${ logger.style.misc('localhost') }`;
-const WEB_LOCATION_TITLE = 'Location on the Web';
-const WEB_ADMIN_LOCATION_TITLE = 'Panel location';
-const WEB_ADMIN_CREDENTIALS_TITLE = 'Panel credentials';
-const WEB_MAILDEV_LOCATION_TITLE = 'Panel location';
+const WEB_LOCAL_LOCATION_TITLE = `Location on ${logger.style.misc('localhost')}`
+const WEB_LOCATION_TITLE = 'Location on the Web'
+const WEB_ADMIN_LOCATION_TITLE = 'Panel location'
+const WEB_ADMIN_CREDENTIALS_TITLE = 'Panel credentials'
+const WEB_MAILDEV_LOCATION_TITLE = 'Panel location'
 
+/**
+ * @param {{ title: string, text: string }} param0
+ */
 const mapDataStyle = ({ title, text }) => ({
     title,
     text: logger.style.link(text),
     link: text
-});
+})
 
 /**
  * @param {import("../../typings/context").ListrContext} ctx
- * @return {{ frontend: { title: string, text: string }[], admin: { title: string, url: string }[], maildev: { title: string, text: string }[] }}
+ * @return {{ frontend: { title: string, text: string }[], admin: { title: string, text: string }[], maildev: { title: string, text: string }[] }}
  */
 const getInstanceMetadata = (ctx) => {
     const {
@@ -23,64 +26,76 @@ const getInstanceMetadata = (ctx) => {
             magentoConfiguration,
             overridenConfiguration: { host, ssl }
         }
-    } = ctx;
+    } = ctx
 
     /**
      * @type {{ title: string, text: string }[]}
      */
-    const frontend = [];
+    const frontend = []
 
     /**
      * @type {{ title: string, text: string }[]}
      */
-    const admin = [];
+    const admin = []
 
     /**
      * @type {{ title: string, text: string }[]}
      */
-    const maildev = [];
+    const maildev = []
 
-    const isNgrok = host.endsWith('ngrok.io');
+    const isNgrok = host.endsWith('ngrok.io')
 
     if (isNgrok) {
         frontend.push({
             title: WEB_LOCAL_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://localhost${ssl.enabled || ports.sslTerminator === 80 ? '' : `:${ports.sslTerminator}`}/`
-        });
+            text: `${ssl.enabled ? 'https' : 'http'}://localhost${
+                ssl.enabled || ports.sslTerminator === 80
+                    ? ''
+                    : `:${ports.sslTerminator}`
+            }/`
+        })
         frontend.push({
             title: WEB_LOCATION_TITLE,
             text: `${ssl.enabled ? 'https' : 'http'}://${host}/`
-        });
+        })
     } else {
         frontend.push({
             title: WEB_LOCATION_TITLE,
-            text: `${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.sslTerminator === 80 ? '' : `:${ports.sslTerminator}`}/`
-        });
+            text: `${ssl.enabled ? 'https' : 'http'}://${host}${
+                ssl.enabled || ports.sslTerminator === 80
+                    ? ''
+                    : `:${ports.sslTerminator}`
+            }/`
+        })
     }
 
-    const webLocation = frontend.find((u) => u.title === WEB_LOCATION_TITLE);
+    const webLocation = frontend.find((u) => u.title === WEB_LOCATION_TITLE)
 
-    admin.push({
-        title: WEB_ADMIN_LOCATION_TITLE,
-        text: logger.style.link(`${webLocation.text}admin`)
-    });
+    if (webLocation) {
+        admin.push({
+            title: WEB_ADMIN_LOCATION_TITLE,
+            text: logger.style.link(`${webLocation.text}admin`)
+        })
+    }
 
     admin.push({
         title: WEB_ADMIN_CREDENTIALS_TITLE,
-        text: `${logger.style.misc(magentoConfiguration.user)} - ${logger.style.misc(magentoConfiguration.password)}`
-    });
+        text: `${logger.style.misc(
+            magentoConfiguration.user
+        )} - ${logger.style.misc(magentoConfiguration.password)}`
+    })
 
     maildev.push({
         title: WEB_MAILDEV_LOCATION_TITLE,
         text: `http://${host}:${ports.maildevWeb}/`
-    });
+    })
 
     return {
         admin,
         frontend: frontend.map(mapDataStyle),
         maildev: maildev.map(mapDataStyle)
-    };
-};
+    }
+}
 
 module.exports = {
     getInstanceMetadata,
@@ -90,4 +105,4 @@ module.exports = {
         WEB_ADMIN_LOCATION_TITLE,
         WEB_ADMIN_CREDENTIALS_TITLE
     }
-};
+}

package/lib/util/ip.js

@@ -1,8 +1,12 @@
-const { request } = require('smol-request');
+const { request } = require('smol-request')
 
-const ipRegex = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
+const ipRegex =
+    /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/
 
-const isIpAddress = (text) => ipRegex.test(text);
+/**
+ * @param {string} text
+ */
+const isIpAddress = (text) => ipRegex.test(text)
 
 const externalIpProviders = [
     'http://api.ipify.org/',
@@ -16,24 +20,24 @@ const externalIpProviders = [
     'http://ipecho.net/plain',
     'http://diagnostic.opendns.com/myip',
     'http://trackip.net/ip'
-];
+]
 
 /**
  * Get an external IP address
  * @returns {Promise<string>}
  */
 const getExternalIpAddress = async () => {
-    let ip;
+    let ip
 
     for (const ipProvider of externalIpProviders) {
         try {
             const response = await request(ipProvider, {
                 responseType: 'text'
-            });
+            })
 
             if (response.status === 200) {
-                ip = response.data;
-                break;
+                ip = response.data
+                break
             }
         } catch (e) {
             //
@@ -41,14 +45,14 @@ const getExternalIpAddress = async () => {
     }
 
     if (!ip) {
-        throw new Error('External IP address is not available!');
+        throw new Error('External IP address is not available!')
     }
 
-    return ip;
-};
+    return ip
+}
 
 module.exports = {
     ipRegex,
     isIpAddress,
     getExternalIpAddress
-};
+}