@scandipwa/magento-scripts 2.0.3 → 2.0.4

package/lib/tasks/theme/link-theme.js

@@ -1,14 +1,14 @@
-const symlinkTheme = require('./symlink-theme');
-const installTheme = require('./install-theme');
-const adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-cache');
-const disablePageBuilder = require('../magento/setup-magento/disable-page-builder');
-const buildTheme = require('./build-theme');
-const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
-const updateEnvPHP = require('../php/update-env-php');
-const semver = require('semver');
+const symlinkTheme = require('./symlink-theme')
+const installTheme = require('./install-theme')
+const adjustFullPageCache = require('../magento/setup-magento/adjust-full-page-cache')
+const disablePageBuilder = require('../magento/setup-magento/disable-page-builder')
+const buildTheme = require('./build-theme')
+const upgradeMagento = require('../magento/setup-magento/upgrade-magento')
+const updateEnvPHP = require('../php/update-env-php')
+const semver = require('semver')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const linkTheme = () => ({
     title: 'Linking theme',
@@ -19,21 +19,25 @@ const linkTheme = () => ({
             themePath,
             composerData,
             databaseConnection
-        } = ctx;
+        } = ctx
         const {
             magento: { edition: magentoEdition },
             magentoVersion
-        } = overridenConfiguration;
+        } = overridenConfiguration
 
-        const isEnterprise = magentoEdition === 'enterprise';
-        const isPageBuilderInstalled = isEnterprise && semver.satisfies(semver.coerce(magentoVersion), '^2.4');
+        const isEnterprise = magentoEdition === 'enterprise'
+        const isPageBuilderInstalled =
+            isEnterprise &&
+            semver.satisfies(semver.coerce(magentoVersion), '^2.4')
         const [queryResult] = await databaseConnection.query(`
                 SELECT value AS isPagebuilderEnabled
                 FROM core_config_data
                 WHERE path = 'cms/pagebuilder/enabled'
-            `);
+            `)
 
-        const [{ isPagebuilderEnabled = 1 }] = queryResult.length ? queryResult : [{}];
+        const [{ isPagebuilderEnabled = 1 }] = queryResult.length
+            ? queryResult
+            : [{}]
 
         /**
          * @type {import('../../../typings/theme').Theme}
@@ -42,9 +46,9 @@ const linkTheme = () => ({
             themePath,
             absoluteThemePath,
             composerData
-        };
+        }
 
-        task.title = `Linking theme from ${themePath}`;
+        task.title = `Linking theme from ${themePath}`
 
         return task.newListr([
             symlinkTheme(theme),
@@ -52,13 +56,15 @@ const linkTheme = () => ({
             updateEnvPHP(),
             upgradeMagento(),
             adjustFullPageCache(),
-            ...(isPageBuilderInstalled && Number(isPagebuilderEnabled) ? [disablePageBuilder()] : []),
+            ...(isPageBuilderInstalled && Number(isPagebuilderEnabled)
+                ? [disablePageBuilder()]
+                : []),
             buildTheme(theme)
-        ]);
+        ])
     },
     options: {
         bottomBar: 5
     }
-});
+})
 
-module.exports = linkTheme;
+module.exports = linkTheme

package/lib/tasks/theme/retrieve-theme-data.js

@@ -1,8 +1,8 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const path = require('path');
-const KnownError = require('../../errors/known-error');
-const getJsonfileData = require('../../util/get-jsonfile-data');
-const pathExists = require('../../util/path-exists');
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const path = require('path')
+const KnownError = require('../../errors/known-error')
+const getJsonfileData = require('../../util/get-jsonfile-data')
+const pathExists = require('../../util/path-exists')
 
 /**
  * @type {(themePath: string) => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -10,40 +10,46 @@ const pathExists = require('../../util/path-exists');
 const retrieveThemeData = (themePath) => ({
     title: 'Checking theme folder',
     task: async (ctx) => {
-        let absoluteThemePath = path.resolve(themePath);
+        let absoluteThemePath = path.resolve(themePath)
 
         // validate if theme is located inside magento directory
         if (!absoluteThemePath.includes(process.cwd())) {
             throw new KnownError(`You are trying to link the theme from outside of your Magento project!
 
-This is not supported in ${ logger.style.command('magento-scripts') } version 2.
+This is not supported in ${logger.style.command('magento-scripts')} version 2.
 
-Move your theme inside Magento project!`);
+Move your theme inside Magento project!`)
         }
 
         // check if path not relative
-        if (!(await pathExists(path.join(absoluteThemePath, 'composer.json')))) {
+        if (
+            !(await pathExists(path.join(absoluteThemePath, 'composer.json')))
+        ) {
             // if composer.json is not found, then it's not correct path
             // and we need to test if it's absolute one
             if (await pathExists(path.join(themePath, 'composer.json'))) {
                 // if so, use it as absolute path
-                absoluteThemePath = themePath;
+                absoluteThemePath = themePath
             }
         } else {
             // path is relative, so we use it
-            absoluteThemePath = themePath;
+            absoluteThemePath = themePath
         }
 
-        const composerData = await getJsonfileData(path.join(absoluteThemePath, 'composer.json'));
+        const composerData = await getJsonfileData(
+            path.join(absoluteThemePath, 'composer.json')
+        )
 
         if (!composerData) {
-            throw new KnownError(`composer.json file not found in "${themePath}"`);
+            throw new KnownError(
+                `composer.json file not found in "${themePath}"`
+            )
         }
 
-        ctx.themePath = themePath;
-        ctx.composerData = composerData;
-        ctx.absoluteThemePath = absoluteThemePath;
+        ctx.themePath = themePath
+        ctx.composerData = composerData
+        ctx.absoluteThemePath = absoluteThemePath
     }
-});
+})
 
-module.exports = retrieveThemeData;
+module.exports = retrieveThemeData

package/lib/tasks/theme/setup-themes.js

@@ -1,94 +1,122 @@
-const path = require('path');
-const getJsonfileData = require('../../util/get-jsonfile-data');
-const pathExists = require('../../util/path-exists');
-const symlinkTheme = require('./symlink-theme');
-const installTheme = require('./install-theme');
-const upgradeMagento = require('../magento/setup-magento/upgrade-magento');
-const buildTheme = require('./build-theme');
-const KnownError = require('../../errors/known-error');
+const path = require('path')
+const getJsonfileData = require('../../util/get-jsonfile-data')
+const pathExists = require('../../util/path-exists')
+const symlinkTheme = require('./symlink-theme')
+const installTheme = require('./install-theme')
+const upgradeMagento = require('../magento/setup-magento/upgrade-magento')
+const buildTheme = require('./build-theme')
+const KnownError = require('../../errors/known-error')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const setupThemes = () => ({
     title: 'Setting up themes',
     task: async (ctx, task) => {
-        const { config: { baseConfig } } = ctx;
-        const composerData = await getJsonfileData(path.join(baseConfig.magentoDir, 'composer.json'));
+        const {
+            config: { baseConfig }
+        } = ctx
+        /**
+         * @type {{ require: Record<string, string>, repositories?: Record<string, { type: string, url: string }> | { type: string, url: string }[] } | null}
+         */
+        const composerData = await getJsonfileData(
+            path.join(baseConfig.magentoDir, 'composer.json')
+        )
 
-        if (!composerData.repositories) {
-            task.skip();
-            return;
+        if (!composerData || !composerData.repositories) {
+            task.skip()
+            return
         }
 
         const composerLocalPaths = Array.isArray(composerData.repositories)
             ? composerData.repositories.filter((repo) => repo.type === 'path')
-            : Object.values(composerData.repositories).filter((repo) => repo.type === 'path');
+            : Object.values(composerData.repositories).filter(
+                  (repo) => repo.type === 'path'
+              )
 
         /**
          * @type {string[]}
          */
-        const composerLocalPackagesPaths = [];
+        const composerLocalPackagesPaths = []
         for (const localPath of composerLocalPaths) {
             if (
-                await pathExists(localPath.url)
-                && await pathExists(path.join(process.cwd(), localPath.url, 'composer.json'))
-                && await pathExists(path.join(process.cwd(), localPath.url, 'package.json'))
+                (await pathExists(localPath.url)) &&
+                (await pathExists(
+                    path.join(process.cwd(), localPath.url, 'composer.json')
+                )) &&
+                (await pathExists(
+                    path.join(process.cwd(), localPath.url, 'package.json')
+                ))
             ) {
-                const localPathComposerData = await getJsonfileData(path.join(process.cwd(), localPath.url, 'composer.json'));
+                const localPathComposerData = await getJsonfileData(
+                    path.join(process.cwd(), localPath.url, 'composer.json')
+                )
                 if (composerData.require[localPathComposerData.name]) {
-                    composerLocalPackagesPaths.push(localPath.url);
+                    composerLocalPackagesPaths.push(localPath.url)
                 }
             }
         }
 
         if (composerLocalPackagesPaths.length === 0) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        const themes = await Promise.all(composerLocalPackagesPaths.map(async (themePath) => {
-            let absoluteThemePath = path.join(process.cwd(), themePath);
+        const themes = await Promise.all(
+            composerLocalPackagesPaths.map(async (themePath) => {
+                let absoluteThemePath = path.join(process.cwd(), themePath)
 
-            // check if path not relative
-            if (!(await pathExists(path.join(absoluteThemePath, 'composer.json')))) {
-                // if composer.json is not found, then it's not correct path
-                // and we need to test if it's absolute one
-                if (await pathExists(path.join(themePath, 'composer.json'))) {
-                    // if so, use it as absolute path
-                    absoluteThemePath = themePath;
+                // check if path not relative
+                if (
+                    !(await pathExists(
+                        path.join(absoluteThemePath, 'composer.json')
+                    ))
+                ) {
+                    // if composer.json is not found, then it's not correct path
+                    // and we need to test if it's absolute one
+                    if (
+                        await pathExists(path.join(themePath, 'composer.json'))
+                    ) {
+                        // if so, use it as absolute path
+                        absoluteThemePath = themePath
+                    }
+                } else {
+                    // path is relative, so we use it
+                    absoluteThemePath = themePath
                 }
-            } else {
-                // path is relative, so we use it
-                absoluteThemePath = themePath;
-            }
 
-            const composerData = await getJsonfileData(path.join(absoluteThemePath, 'composer.json'));
+                const composerData = await getJsonfileData(
+                    path.join(absoluteThemePath, 'composer.json')
+                )
 
-            if (!composerData) {
-                throw new KnownError(`composer.json file not found in "${themePath}"`);
-            }
+                if (!composerData) {
+                    throw new KnownError(
+                        `composer.json file not found in "${themePath}"`
+                    )
+                }
 
-            return {
-                themePath,
-                composerData,
-                absoluteThemePath
-            };
-        }));
+                return {
+                    themePath,
+                    composerData,
+                    absoluteThemePath
+                }
+            })
+        )
 
         return task.newListr(
-            themes.map((theme) => ({
-                title: `Theme from "${theme.themePath}"`,
-                task: (subCtx, subTask) => subTask.newListr([
-                    symlinkTheme(theme),
-                    installTheme(theme),
-                    buildTheme(theme)
-                ])
-            })).concat([
-                upgradeMagento()
-            ])
-        );
+            themes
+                .map((theme) => ({
+                    title: `Theme from "${theme.themePath}"`,
+                    task: (subCtx, subTask) =>
+                        subTask.newListr([
+                            symlinkTheme(theme),
+                            installTheme(theme),
+                            buildTheme(theme)
+                        ])
+                }))
+                .concat([upgradeMagento()])
+        )
     }
-});
+})
 
-module.exports = setupThemes;
+module.exports = setupThemes

package/lib/tasks/theme/symlink-theme.js

@@ -1,7 +1,7 @@
-const path = require('path');
-const UnknownError = require('../../errors/unknown-error');
-const getJsonfileData = require('../../util/get-jsonfile-data');
-const runComposerCommand = require('../../util/run-composer');
+const path = require('path')
+const UnknownError = require('../../errors/unknown-error')
+const getJsonfileData = require('../../util/get-jsonfile-data')
+const runComposerCommand = require('../../util/run-composer')
 
 /**
  * @type {(theme: import('../../../typings/theme').Theme) => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -9,38 +9,60 @@ const runComposerCommand = require('../../util/run-composer');
 const symlinkTheme = (theme) => ({
     title: 'Setting symbolic link for theme in composer.json',
     task: async (ctx, task) => {
-        const { verbose = false } = ctx;
-        const composerJsonData = await getJsonfileData(path.join(process.cwd(), 'composer.json'));
+        const { verbose = false } = ctx
+        /**
+         * @type {{ require: Record<string, string>, repositories?: Record<string, { type: string, url: string }> | { type: string, url: string }[] } | null}
+         */
+        const composerJsonData = await getJsonfileData(
+            path.join(process.cwd(), 'composer.json')
+        )
 
-        if (!composerJsonData.repositories) {
-            task.skip();
-            return;
+        if (!composerJsonData || !composerJsonData.repositories) {
+            task.skip()
+            return
         }
 
+        /**
+         * @type {Record<string, { type: string, url: string }>}
+         */
+        const init = {}
         const repositories = Array.isArray(composerJsonData.repositories)
-            ? composerJsonData.repositories.reduce((acc, repo, index) => ({ ...acc, [`${index}`]: repo }), {})
-            : composerJsonData.repositories;
+            ? composerJsonData.repositories.reduce(
+                  (acc, repo, index) => ({ ...acc, [`${index}`]: repo }),
+                  init
+              )
+            : composerJsonData.repositories
 
-        if (Object.values(repositories).some((value) => value.url === theme.themePath)) {
-            task.skip();
-            return;
+        if (
+            Object.values(repositories).some(
+                (value) => value.url === theme.themePath
+            )
+        ) {
+            task.skip()
+            return
         }
 
         try {
-            await runComposerCommand(ctx, `config repo.scandipwa path ${theme.absoluteThemePath}`, {
-                callback: !verbose ? undefined : (t) => {
-                    task.output = t;
+            await runComposerCommand(
+                ctx,
+                `config repo.scandipwa path ${theme.absoluteThemePath}`,
+                {
+                    callback: !verbose
+                        ? undefined
+                        : (t) => {
+                              task.output = t
+                          }
                 }
-            });
+            )
         } catch (e) {
             throw new UnknownError(
                 `Unexpected error while configuring theme symbolic link.
                 See ERROR log above.\n\n${e}`
-            );
+            )
         }
 
-        ctx.isSetupUpgradeNeeded = true;
+        ctx.isSetupUpgradeNeeded = true
     }
-});
+})
 
-module.exports = symlinkTheme;
+module.exports = symlinkTheme

package/lib/util/CSA-theme.js

@@ -1,36 +1,38 @@
-const path = require('path');
-const getJsonfileData = require('./get-jsonfile-data');
+const path = require('path')
+const getJsonfileData = require('./get-jsonfile-data')
 
 const getCSAThemes = async ({ cwd = process.cwd() } = {}) => {
-    const composerData = await getJsonfileData(
-        path.join(cwd, 'composer.json')
-    );
+    const composerData = await getJsonfileData(path.join(cwd, 'composer.json'))
 
     if (!composerData || !composerData.repositories) {
-        return [];
+        return []
     }
 
-    const pathRepositories = Object.entries(composerData.repositories)
-        .filter(([_, repoOptions]) => repoOptions.type === 'path');
+    const pathRepositories = Object.entries(composerData.repositories).filter(
+        ([_, repoOptions]) => repoOptions.type === 'path'
+    )
 
-    const CSAThemes = (await Promise.all(
-        pathRepositories
-            .map(async ([_, repoOptions]) => {
-                const pkg = (await getJsonfileData(path.join(cwd, repoOptions.url, 'package.json')) || {});
+    const CSAThemes = (
+        await Promise.all(
+            pathRepositories.map(async ([_, repoOptions]) => {
+                const pkg =
+                    (await getJsonfileData(
+                        path.join(cwd, repoOptions.url, 'package.json')
+                    )) || {}
 
                 return {
                     themePath: repoOptions.url,
-                    isCSATheme: (
-                        (pkg.scandipwa && pkg.scandipwa.type === 'theme')
-                        || (pkg.mosaic && pkg.mosaic.type === 'theme')
-                    )
-                };
+                    isCSATheme:
+                        (pkg.scandipwa && pkg.scandipwa.type === 'theme') ||
+                        (pkg.mosaic && pkg.mosaic.type === 'theme')
+                }
             })
-    )).filter(({ isCSATheme }) => isCSATheme);
+        )
+    ).filter(({ isCSATheme }) => isCSATheme)
 
-    return CSAThemes;
-};
+    return CSAThemes
+}
 
 module.exports = {
     getCSAThemes
-};
+}