@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/tasks/requirements/index.js

@@ -1,38 +1,42 @@
-const checkPlatform = require('./platform');
-const { checkComposerCredentials } = require('./composer-credentials');
-const localAuthJson = require('../composer/local-auth-json');
-const checkDocker = require('./docker');
-const checkNodeVersion = require('./node-version');
-const checkRosetta = require('./rosetta');
+const checkPlatform = require('./platform')
+const { checkComposerCredentials } = require('./composer-credentials')
+const localAuthJson = require('../composer/local-auth-json')
+const checkDocker = require('./docker')
+const checkNodeVersion = require('./node-version')
+const checkRosetta = require('./rosetta')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkRequirements = () => ({
     title: 'Checking requirements',
-    task: (ctx, task) => task.newListr([
-        // check if rosetta 2 is installed or not on m1 macs
-        checkRosetta(),
-        // checking if user is on supported platform
-        checkPlatform(),
-        // check the Docker installation
-        checkDocker(),
-        // check for Node.js version
-        checkNodeVersion(),
-        // check for COMPOSER_AUTH or auth.json
-        localAuthJson(),
-        checkComposerCredentials()
-    ], {
-        concurrent: false,
-        exitOnError: true,
-        rendererOptions: {
-            collapse: false,
-            showTimer: false
-        }
-    }),
+    task: (ctx, task) =>
+        task.newListr(
+            [
+                // check if rosetta 2 is installed or not on m1 macs
+                checkRosetta(),
+                // checking if user is on supported platform
+                checkPlatform(),
+                // check the Docker installation
+                checkDocker(),
+                // check for Node.js version
+                checkNodeVersion(),
+                // check for COMPOSER_AUTH or auth.json
+                localAuthJson(),
+                checkComposerCredentials()
+            ],
+            {
+                concurrent: false,
+                exitOnError: true,
+                rendererOptions: {
+                    collapse: false,
+                    showTimer: false
+                }
+            }
+        ),
     options: {
         showTimer: false
     }
-});
+})
 
-module.exports = { checkRequirements };
+module.exports = { checkRequirements }

package/lib/tasks/requirements/node-version.js

@@ -1,23 +1,23 @@
-const semver = require('semver');
-const KnownError = require('../../errors/known-error');
+const semver = require('semver')
+const KnownError = require('../../errors/known-error')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkNodeVersion = () => ({
     title: 'Checking Node.js',
     task: (ctx, task) => {
-        const { node } = process.versions;
+        const { node } = process.versions
 
         if (!semver.gte(node, '12.0.0')) {
             throw new KnownError(
                 `Your Node.js version is out of date!
 You need to upgrade Node.js to at lease version 12 to work with this software!`
-            );
+            )
         }
 
-        task.title = `Using Node.js version ${node} ${process.arch}`;
+        task.title = `Using Node.js version ${node} ${process.arch}`
     }
-});
+})
 
-module.exports = checkNodeVersion;
+module.exports = checkNodeVersion

package/lib/tasks/requirements/php-version.js

@@ -1,8 +1,8 @@
-const UnknownError = require('../../errors/unknown-error');
-const { runContainerImage } = require('../../util/run-container-image');
+const UnknownError = require('../../errors/unknown-error')
+const { runContainerImage } = require('../../util/run-container-image')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkPHPVersion = () => ({
     title: 'Checking container PHP version',
@@ -10,19 +10,22 @@ const checkPHPVersion = () => ({
         const phpVersionResponse = await runContainerImage(
             ctx.config.overridenConfiguration.configuration.php.baseImage,
             'php --version'
-        );
+        )
 
-        const phpVersionResponseResult = phpVersionResponse.match(/PHP\s(\d+\.\d+\.\d+)/i);
+        const phpVersionResponseResult =
+            phpVersionResponse.match(/PHP\s(\d+\.\d+\.\d+)/i)
 
         if (phpVersionResponseResult && phpVersionResponseResult.length > 0) {
-            const phpVersion = phpVersionResponseResult[1];
+            const phpVersion = phpVersionResponseResult[1]
 
-            ctx.phpVersion = phpVersion;
-            task.title = `Using PHP version ${phpVersion} in container`;
+            ctx.phpVersion = phpVersion
+            task.title = `Using PHP version ${phpVersion} in container`
         } else {
-            throw new UnknownError(`Cannot retrieve PHP Version!\n\n${phpVersionResponse}`);
+            throw new UnknownError(
+                `Cannot retrieve PHP Version!\n\n${phpVersionResponse}`
+            )
         }
     }
-});
+})
 
-module.exports = checkPHPVersion;
+module.exports = checkPHPVersion

package/lib/tasks/requirements/platform.js

@@ -1,12 +1,12 @@
-const os = require('os');
-const semver = require('semver');
-const systeminformation = require('systeminformation');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { platforms, darwinMinimalVersion } = require('../../config');
-const { getArch } = require('../../util/arch');
-const getIsWsl = require('../../util/is-wsl');
-const KnownError = require('../../errors/known-error');
-const { getMacOSVersion } = require('../../util/macos-version');
+const os = require('os')
+const semver = require('semver')
+const systeminformation = require('systeminformation')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { platforms, darwinMinimalVersion } = require('../../config')
+const { getArch } = require('../../util/arch')
+const getIsWsl = require('../../util/is-wsl')
+const KnownError = require('../../errors/known-error')
+const { getMacOSVersion } = require('../../util/macos-version')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -14,35 +14,51 @@ const { getMacOSVersion } = require('../../util/macos-version');
 const checkPlatform = () => ({
     title: 'Checking platform',
     task: async (ctx, task) => {
-        const currentPlatform = os.platform();
+        const currentPlatform = os.platform()
 
-        ctx.arch = await getArch();
+        ctx.arch = await getArch()
 
-        ctx.isArm = ctx.arch === 'arm64';
-        ctx.isWsl = await getIsWsl();
+        ctx.isArm = ctx.arch === 'arm64'
+        ctx.isWsl = await getIsWsl()
 
-        ctx.platform = currentPlatform;
-        ctx.platformVersion = currentPlatform !== 'darwin' ? os.release() : await getMacOSVersion();
-        ctx.isArmMac = ctx.isArm && ctx.platform === 'darwin';
+        ctx.platform = currentPlatform
+        ctx.platformVersion =
+            currentPlatform !== 'darwin'
+                ? os.release()
+                : await getMacOSVersion()
+        ctx.isArmMac = ctx.isArm && ctx.platform === 'darwin'
 
         if (!platforms.includes(currentPlatform)) {
             throw new KnownError(
-                `Your current OS platform is ${ logger.style.misc(currentPlatform) }.
-                Unfortunately, currently we only support ${ platforms.map((platform) => logger.style.misc(platform)).join(',') }.`
-            );
+                `Your current OS platform is ${logger.style.misc(
+                    currentPlatform
+                )}.
+                Unfortunately, currently we only support ${platforms
+                    .map((platform) => logger.style.misc(platform))
+                    .join(',')}.`
+            )
         }
 
-        if (currentPlatform === 'darwin' && !semver.gt(ctx.platformVersion, semver.coerce(darwinMinimalVersion).version)) {
+        if (
+            ctx.platformVersion &&
+            currentPlatform === 'darwin' &&
+            !semver.gt(
+                ctx.platformVersion,
+                semver.coerce(darwinMinimalVersion).version
+            )
+        ) {
             throw new KnownError(
                 'Please update your system!',
-                `MacOS bellow version ${ logger.style.misc(darwinMinimalVersion) } is not supported.`
-            );
+                `MacOS bellow version ${logger.style.misc(
+                    darwinMinimalVersion
+                )} is not supported.`
+            )
         }
 
-        const { manufacturer, brand, cores } = await systeminformation.cpu();
+        const { manufacturer, brand, cores } = await systeminformation.cpu()
 
-        task.title = `Running on ${currentPlatform} ${ctx.platformVersion} (${manufacturer} ${brand} ${cores} threads)`;
+        task.title = `Running on ${currentPlatform} ${ctx.platformVersion} (${manufacturer} ${brand} ${cores} threads)`
     }
-});
+})
 
-module.exports = checkPlatform;
+module.exports = checkPlatform

package/lib/tasks/requirements/rosetta.js

@@ -1,4 +1,7 @@
-const { execAsyncSpawn, execCommandTask } = require('../../util/exec-async-command');
+const {
+    execAsyncSpawn,
+    execCommandTask
+} = require('../../util/exec-async-command')
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -6,27 +9,27 @@ const { execAsyncSpawn, execCommandTask } = require('../../util/exec-async-comma
 const checkRosetta = () => ({
     skip: (ctx) => !ctx.isArmMac,
     task: async (ctx, task) => {
-        task.title = 'Checking Rosetta 2 status';
+        task.title = 'Checking Rosetta 2 status'
 
         const { code } = await execAsyncSpawn('arch -x86_64 echo "test"', {
             withCode: true
-        });
+        })
 
         if (code === 1) {
-            task.output = 'Rosetta 2 is not installed, installing...';
+            task.output = 'Rosetta 2 is not installed, installing...'
             return task.newListr(
-                execCommandTask('softwareupdate --install-rosetta --agree-to-license', {
-                    pipeInput: true,
-                    callback: (t) => {
-                        task.output = t;
+                execCommandTask(
+                    'softwareupdate --install-rosetta --agree-to-license',
+                    {
+                        pipeInput: true
                     }
-                })
-            );
+                )
+            )
         }
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
-module.exports = checkRosetta;
+module.exports = checkRosetta