@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/tasks/requirements/docker/context.js

@@ -1,51 +1,58 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const os = require('os');
-const { cmaGlobalConfig } = require('../../../config/cma-config');
-const { getCachedPorts } = require('../../../config/get-port-config');
-const { getSystemConfigTask } = require('../../../config/system-config');
-const UnknownError = require('../../../errors/unknown-error');
-const { execCommandTask } = require('../../../util/exec-async-command');
-const createCacheFolder = require('../../cache/create-cache-folder');
-const { dockerApi } = require('../../docker');
-const { stopContainers } = require('../../docker/containers');
-const { getDockerEngineAndDesktopServiceStatus } = require('./running-status');
-const getMagentoVersionConfig = require('../../../config/get-magento-version-config');
-const checkConfigurationFile = require('../../../config/check-configuration-file');
-const getProjectConfiguration = require('../../../config/get-project-configuration');
-const getDockerVersion = require('./version');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const os = require('os')
+const { cmaGlobalConfig } = require('../../../config/cma-config')
+const { getCachedPorts } = require('../../../config/get-port-config')
+const { getSystemConfigTask } = require('../../../config/system-config')
+const UnknownError = require('../../../errors/unknown-error')
+const { execCommandTask } = require('../../../util/exec-async-command')
+const createCacheFolder = require('../../cache/create-cache-folder')
+const { dockerApi } = require('../../docker')
+const { stopContainers } = require('../../docker/containers')
+const { getDockerEngineAndDesktopServiceStatus } = require('./running-status')
+const getMagentoVersionConfig = require('../../../config/get-magento-version-config')
+const checkConfigurationFile = require('../../../config/check-configuration-file')
+const getProjectConfiguration = require('../../../config/get-project-configuration')
+const getDockerVersion = require('./version')
 
-const USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER = 'useDefaultDockerDesktopContext';
+const USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER =
+    'useDefaultDockerDesktopContext'
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const checkDockerDesktopContext = () => ({
     task: async (ctx, task) => {
         if (os.platform() !== 'linux' || !ctx.isDockerDesktop) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        task.title = 'Checking contexts for Docker Desktop';
+        task.title = 'Checking contexts for Docker Desktop'
 
-        const contexts = await dockerApi.context({ formatToJSON: true });
-        const currentlyUsedContext = contexts.find((c) => c.Current);
+        const contexts = await dockerApi.context({ formatToJSON: true })
+        const currentlyUsedContext = contexts.find((c) => c.Current)
 
         if (!currentlyUsedContext) {
-            throw new UnknownError('We haven\'t found contexts in Docker...');
+            throw new UnknownError("We haven't found contexts in Docker...")
         }
 
-        const { engine } = await getDockerEngineAndDesktopServiceStatus();
+        const { engine } = await getDockerEngineAndDesktopServiceStatus()
 
         if (currentlyUsedContext.Name !== 'default' && engine.exists) {
-            if (cmaGlobalConfig.get(USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER) === false) {
-                task.skip();
-                return;
+            if (
+                cmaGlobalConfig.get(
+                    USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER
+                ) === false
+            ) {
+                task.skip()
+                return
             }
 
             const confirmContextChange = await task.prompt({
                 type: 'Select',
-                message: `Do you want to change current Docker Desktop context (${logger.style.code(currentlyUsedContext.Name)}) to ${logger.style.code('default')}?`,
+                message: `Do you want to change current Docker Desktop context (${logger.style.code(
+                    currentlyUsedContext.Name
+                )}) to ${logger.style.code('default')}?`,
                 choices: [
                     {
                         name: 'yes',
@@ -53,19 +60,24 @@ const checkDockerDesktopContext = () => ({
                     },
                     {
                         name: 'no',
-                        message: 'No, I don\'t know what this means, but you can ask again on next start.'
+                        message:
+                            "No, I don't know what this means, but you can ask again on next start."
                     },
                     {
                         name: 'skip',
-                        // eslint-disable-next-line max-len
-                        message: 'I do know what this means and I DON\'T want to change context for Docker. Also, save this answer to never ask again.'
+
+                        message:
+                            "I do know what this means and I DON'T want to change context for Docker. Also, save this answer to never ask again."
                     }
                 ]
-            });
+            })
 
             if (confirmContextChange === 'skip') {
-                cmaGlobalConfig.set(USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER, false);
-                task.skip();
+                cmaGlobalConfig.set(
+                    USE_DEFAULT_DOCKER_DESKTOP_CONTEXT_ANSWER,
+                    false
+                )
+                task.skip()
             }
 
             if (confirmContextChange === 'yes') {
@@ -79,10 +91,10 @@ const checkDockerDesktopContext = () => ({
                     stopContainers(),
                     execCommandTask('docker context use default'),
                     getDockerVersion()
-                ]);
+                ])
             }
         }
     }
-});
+})
 
-module.exports = checkDockerDesktopContext;
+module.exports = checkDockerDesktopContext

package/lib/tasks/requirements/docker/index.js

@@ -1,51 +1,70 @@
-const os = require('os');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { cmaGlobalConfig } = require('../../../config/cma-config');
-const KnownError = require('../../../errors/known-error');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const openBrowser = require('../../../util/open-browser');
-const checkDockerDesktopContext = require('./context');
-const { installDockerEngine } = require('./install');
-const installDockerOnMac = require('./install-on-mac');
-const { checkDockerPerformance } = require('./performance');
-const { checkDockerSocketPermissions } = require('./permissions');
-const { checkDockerStatus, getDockerEngineAndDesktopServiceStatus } = require('./running-status');
-const getDockerVersion = require('./version');
-const getIsWsl = require('../../../util/is-wsl');
-
-const USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER = 'useDockerEngineWithDockerDesktop';
+const os = require('os')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { cmaGlobalConfig } = require('../../../config/cma-config')
+const KnownError = require('../../../errors/known-error')
+const { execAsyncSpawn } = require('../../../util/exec-async-command')
+const openBrowser = require('../../../util/open-browser')
+const checkDockerDesktopContext = require('./context')
+const { installDockerEngine } = require('./install')
+const installDockerOnMac = require('./install-on-mac')
+const { checkDockerPerformance } = require('./performance')
+const { checkDockerSocketPermissions } = require('./permissions')
+const {
+    checkDockerStatus,
+    getDockerEngineAndDesktopServiceStatus
+} = require('./running-status')
+const getDockerVersion = require('./version')
+const getIsWsl = require('../../../util/is-wsl')
 
+const USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER =
+    'useDockerEngineWithDockerDesktop'
+
+/**
+ * @param {import('listr2').ListrTaskWrapper<import('../../../../typings/context').ListrContext, any>} task
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
 const setVersionInContextTask = (task) => ({
     task: (ctx) => {
-        if (os.platform() === 'darwin' && ctx.dockerServerData && ctx.dockerServerData.Platform && ctx.dockerServerData.Platform.Name) {
-            task.title = `Using ${ctx.dockerServerData.Platform.Name} for Mac`;
+        if (
+            os.platform() === 'darwin' &&
+            ctx.dockerServerData &&
+            ctx.dockerServerData.Platform &&
+            ctx.dockerServerData.Platform.Name
+        ) {
+            task.title = `Using ${ctx.dockerServerData.Platform.Name} for Mac`
         } else {
-            task.title = `Using Docker version ${ctx.dockerVersion}`;
+            task.title = `Using Docker version ${ctx.dockerVersion}`
         }
     }
-});
+})
 
+/**
+ * @param {import('listr2').ListrTaskWrapper<import('../../../../typings/context').ListrContext, any>} task
+ * @param {{ skipPrompt?: boolean }} param1
+ */
 const dockerInstallPromptLinux = async (task, { skipPrompt = false } = {}) => {
-    const automaticallyInstallDocker = skipPrompt ? 'yes' : await task.prompt({
-        type: 'Select',
-        message: `You don't have Docker installed!
+    const automaticallyInstallDocker = skipPrompt
+        ? 'yes'
+        : await task.prompt({
+              type: 'Select',
+              message: `You don't have Docker installed!
 Do you want to install it automatically?
 `,
-        choices: [
-            {
-                name: 'yes',
-                message: 'Yes, I to install Docker automatically'
-            },
-            {
-                name: 'no',
-                message: 'No, I want to install Docker myself'
-            },
-            {
-                name: 'skip',
-                message: 'Skip installing Docker'
-            }
-        ]
-    });
+              choices: [
+                  {
+                      name: 'yes',
+                      message: 'Yes, I to install Docker automatically'
+                  },
+                  {
+                      name: 'no',
+                      message: 'No, I want to install Docker myself'
+                  },
+                  {
+                      name: 'skip',
+                      message: 'Skip installing Docker'
+                  }
+              ]
+          })
 
     if (automaticallyInstallDocker === 'yes') {
         return task.newListr([
@@ -54,7 +73,7 @@ Do you want to install it automatically?
             getDockerVersion(),
             {
                 task: async (ctx) => {
-                    task.title = `Using docker version ${ctx.dockerVersion}`;
+                    task.title = `Using docker version ${ctx.dockerVersion}`
 
                     const confirmLogOut = await task.prompt({
                         type: 'Select',
@@ -62,49 +81,56 @@ Do you want to install it automatically?
                         choices: [
                             {
                                 name: 'log-out',
-                                message: `${logger.style.command('[Recommended]')} Now I will log out and log back it (or restart my system) to re-evaluate group membership`
+                                message: `${logger.style.command(
+                                    '[Recommended]'
+                                )} Now I will log out and log back it (or restart my system) to re-evaluate group membership`
                             },
                             {
                                 name: 'skip',
-                                message: 'Skip log out and proceed with installation'
+                                message:
+                                    'Skip log out and proceed with installation'
                             }
                         ]
-                    });
+                    })
 
                     if (confirmLogOut === 'skip') {
-                        return;
+                        return
                     }
 
                     throw new KnownError(
                         `Docker is installed successfully!
 Please log out and log back in (or restart your system) so your group membership is re-evaluated!
-Learn more here: ${ logger.style.link('https://docs.docker.com/engine/install/linux-postinstall/') }`
-                    );
+Learn more here: ${logger.style.link(
+                            'https://docs.docker.com/engine/install/linux-postinstall/'
+                        )}`
+                    )
                 }
             },
             checkDockerStatus(),
             checkDockerDesktopContext()
-        ]);
+        ])
     }
 
     if (automaticallyInstallDocker === 'skip') {
-        return;
+        return
     }
 
-    throw new KnownError('Docker is not installed!');
-};
+    throw new KnownError('Docker is not installed!')
+}
 
 // maybe in the future docker will be possible to install on wsl from terminal...
 const dockerInstallPromptWindows = () => {
     throw new KnownError(
         `You don't have Docker installed!
 Follow this instructions to install Docker on Windows:
-${ logger.style.link('https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements#2-install-docker-desktop-for-windows') }`
-    );
-};
+${logger.style.link(
+    'https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements#2-install-docker-desktop-for-windows'
+)}`
+    )
+}
 
 /**
- * @param {import('listr2').ListrTaskWrapper} task
+ * @param {import('listr2').ListrTaskWrapper<import('../../../../typings/context').ListrContext, any>} task
  */
 const dockerInstallPromptMacOS = async (task) => {
     const confirmationToInstallDocker = await task.prompt({
@@ -122,7 +148,7 @@ Would you like to install it automatically using brew cask or you prefer to inst
                 message: 'Install Docker manually'
             }
         ]
-    });
+    })
 
     if (confirmationToInstallDocker === 'automatic') {
         return task.newListr([
@@ -131,53 +157,59 @@ Would you like to install it automatically using brew cask or you prefer to inst
             checkDockerStatus(),
             getDockerVersion(),
             setVersionInContextTask(task)
-        ]);
+        ])
     }
 
-    const dockerInstallLink = 'https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos#3.-install-docker-for-mac';
-    await openBrowser(dockerInstallLink);
+    const dockerInstallLink =
+        'https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos#3.-install-docker-for-mac'
+    await openBrowser(dockerInstallLink)
 
     throw new KnownError(
         `Follow this instructions to install Docker on Mac:
-${ logger.style.link(dockerInstallLink) }`
-    );
-};
+${logger.style.link(dockerInstallLink)}`
+    )
+}
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const checkDocker = () => ({
     title: 'Checking Docker',
     task: async (ctx, task) => {
         const { code } = await execAsyncSpawn('docker -v', {
             withCode: true
-        });
+        })
 
         if (code !== 0) {
             if (os.platform() === 'linux') {
-                const isWsl = await getIsWsl();
+                const isWsl = await getIsWsl()
                 if (!isWsl) {
-                    const { engine } = await getDockerEngineAndDesktopServiceStatus();
+                    const { engine } =
+                        await getDockerEngineAndDesktopServiceStatus()
                     if (!engine.exists) {
-                        const result = await dockerInstallPromptLinux(task);
+                        const result = await dockerInstallPromptLinux(task)
                         if (result) {
-                            return result;
+                            return result
                         }
                     }
                 } else if (isWsl) {
-                    dockerInstallPromptWindows();
+                    dockerInstallPromptWindows()
                 }
             } else {
-                const result = await dockerInstallPromptMacOS(task);
+                const result = await dockerInstallPromptMacOS(task)
                 if (result) {
-                    return result;
+                    return result
                 }
             }
         } else if (os.platform() === 'linux') {
-            const { engine, desktop } = await getDockerEngineAndDesktopServiceStatus();
-            if (!engine.exists
-                && desktop.exists
-                && cmaGlobalConfig.get(USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER) !== false
+            const { engine, desktop } =
+                await getDockerEngineAndDesktopServiceStatus()
+            if (
+                !engine.exists &&
+                desktop.exists &&
+                cmaGlobalConfig.get(
+                    USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER
+                ) !== false
             ) {
                 const confirmInstallingDockerEngine = await task.prompt({
                     type: 'Select',
@@ -187,7 +219,8 @@ Do you want to install it and use it's context together with Docker Desktop?
                     choices: [
                         {
                             name: 'yes',
-                            message: 'Sure, if it means I will have less issues with my setup!'
+                            message:
+                                'Sure, if it means I will have less issues with my setup!'
                         },
                         {
                             name: 'no',
@@ -195,20 +228,23 @@ Do you want to install it and use it's context together with Docker Desktop?
                         },
                         {
                             name: 'skip',
-                            message: 'No. And don\'t ask me again.'
+                            message: "No. And don't ask me again."
                         }
                     ]
-                });
+                })
 
                 if (confirmInstallingDockerEngine === 'skip') {
-                    cmaGlobalConfig.set(USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER, false);
+                    cmaGlobalConfig.set(
+                        USE_DOCKER_ENGINE_WITH_DOCKER_DESKTOP_ANSWER,
+                        false
+                    )
                 } else if (confirmInstallingDockerEngine === 'yes') {
                     const result = await dockerInstallPromptLinux(task, {
                         skipPrompt: true
-                    });
+                    })
 
                     if (result) {
-                        return result;
+                        return result
                     }
                 }
             }
@@ -220,18 +256,16 @@ Do you want to install it and use it's context together with Docker Desktop?
             getDockerVersion(),
             checkDockerDesktopContext(),
             setVersionInContextTask(task)
-        ]);
+        ])
     }
-});
+})
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 module.exports = () => ({
-    task: (ctx, task) => task.newListr([
-        checkDocker(),
-        checkDockerPerformance()
-    ], {
-        concurrent: false
-    })
-});
+    task: (ctx, task) =>
+        task.newListr([checkDocker(), checkDockerPerformance()], {
+            concurrent: false
+        })
+})

package/lib/tasks/requirements/docker/install-on-mac.js

@@ -1,29 +1,36 @@
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
-const { getBrewCommand } = require('../../../util/get-brew-bin-path');
+const { execAsyncSpawn } = require('../../../util/exec-async-command')
+const { getBrewCommand } = require('../../../util/get-brew-bin-path')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const installDockerOnMac = () => ({
     title: 'Installing Docker on Mac OS',
     task: async (ctx, task) => {
-        const interval = !ctx.verbose ? setInterval(() => {
-            task.output = `Installing Docker on Mac... Yep, still in progress ${new Date().toUTCString()}`;
-        }, 5000) : null;
+        const interval = !ctx.verbose
+            ? setInterval(() => {
+                  task.output = `Installing Docker on Mac... Yep, still in progress ${new Date().toUTCString()}`
+              }, 5000)
+            : null
 
-        await execAsyncSpawn(`${await getBrewCommand({ native: true })} install --cask docker`, {
-            callback: !ctx.verbose ? undefined : (t) => {
-                task.output = t;
+        await execAsyncSpawn(
+            `${await getBrewCommand({ native: true })} install --cask docker`,
+            {
+                callback: !ctx.verbose
+                    ? undefined
+                    : (t) => {
+                          task.output = t
+                      }
             }
-        });
+        )
 
-        if (!ctx.verbose) {
-            clearInterval(interval);
+        if (!ctx.verbose && interval) {
+            clearInterval(interval)
         }
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = installDockerOnMac;
+module.exports = installDockerOnMac