@scandipwa/magento-scripts 2.0.3 → 2.0.4

package/lib/tasks/file-system/create-phpstorm-config/xml-utils.js

@@ -1,5 +1,6 @@
-const formatPathForPHPStormConfig = (p) => p.replace(process.cwd(), '$PROJECT_DIR$');
+const formatPathForPHPStormConfig = (p) =>
+    p.replace(process.cwd(), '$PROJECT_DIR$')
 
 module.exports = {
     formatPathForPHPStormConfig
-};
+}

package/lib/tasks/file-system/create-ssl-terminator-config.js

@@ -1,46 +1,49 @@
-const path = require('path');
-const fs = require('fs');
-const setConfigFile = require('../../util/set-config');
-const pathExists = require('../../util/path-exists');
-const { isIpAddress } = require('../../util/ip');
-const KnownError = require('../../errors/known-error');
-const UnknownError = require('../../errors/unknown-error');
+const path = require('path')
+const fs = require('fs')
+const setConfigFile = require('../../util/set-config')
+const pathExists = require('../../util/path-exists')
+const { isIpAddress } = require('../../util/ip')
+const KnownError = require('../../errors/known-error')
+const UnknownError = require('../../errors/unknown-error')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createSSLTerminatorConfig = () => ({
     title: 'Setting ssl terminator config',
     task: async (ctx) => {
         const {
             ports,
-            config: {
-                overridenConfiguration,
-                baseConfig
-            },
+            config: { overridenConfiguration, baseConfig },
             debug,
             isDockerDesktop
-        } = ctx;
+        } = ctx
 
         const {
-            configuration: {
-                sslTerminator
-            },
+            configuration: { sslTerminator },
             ssl,
             host
-        } = overridenConfiguration;
+        } = overridenConfiguration
 
         if (ssl.enabled) {
             if (!(await pathExists(ssl.ssl_certificate))) {
-                throw new KnownError('ssl.ssl_certificate file does not exist!');
+                throw new KnownError('ssl.ssl_certificate file does not exist!')
             }
             if (!(await pathExists(ssl.ssl_certificate_key))) {
-                throw new KnownError('ssl.ssl_certificate_key file does not exist!');
+                throw new KnownError(
+                    'ssl.ssl_certificate_key file does not exist!'
+                )
             }
 
-            const sslTerminatorCacheDir = path.join(baseConfig.cacheDir, 'ssl-terminator', 'conf.d');
-            if (!await pathExists(sslTerminatorCacheDir)) {
-                await fs.promises.mkdir(sslTerminatorCacheDir, { recursive: true });
+            const sslTerminatorCacheDir = path.join(
+                baseConfig.cacheDir,
+                'ssl-terminator',
+                'conf.d'
+            )
+            if (!(await pathExists(sslTerminatorCacheDir))) {
+                await fs.promises.mkdir(sslTerminatorCacheDir, {
+                    recursive: true
+                })
             }
 
             await fs.promises.copyFile(
@@ -51,7 +54,7 @@ const createSSLTerminatorConfig = () => ({
                     'conf.d',
                     'ssl_certificate.pem'
                 )
-            );
+            )
             await fs.promises.copyFile(
                 ssl.ssl_certificate_key,
                 path.join(
@@ -60,12 +63,14 @@ const createSSLTerminatorConfig = () => ({
                     'conf.d',
                     'ssl_certificate-key.pem'
                 )
-            );
+            )
         }
 
-        const networkToBindTo = isIpAddress(host) ? host : '127.0.0.1';
-        const hostMachine = !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal';
-        const hostPort = !isDockerDesktop ? ports.sslTerminator : 80;
+        const networkToBindTo = isIpAddress(host) ? host : '127.0.0.1'
+        const hostMachine = !isDockerDesktop
+            ? '127.0.0.1'
+            : 'host.docker.internal'
+        const hostPort = !isDockerDesktop ? ports.sslTerminator : 80
 
         try {
             await setConfigFile({
@@ -85,9 +90,11 @@ const createSSLTerminatorConfig = () => ({
                     networkToBindTo,
                     debug
                 }
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error appeared during ssl terminator config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error appeared during ssl terminator config creation\n\n${e}`
+            )
         }
 
         // fixes ngrok error "ngrok.io redirected you too many times"
@@ -98,16 +105,21 @@ const createSSLTerminatorConfig = () => ({
                     'ssl-terminator',
                     'fastcgi_params'
                 ),
-                template: path.join(baseConfig.templateDir, 'nginx.fastcgi_params.template'),
+                template: path.join(
+                    baseConfig.templateDir,
+                    'nginx.fastcgi_params.template'
+                ),
                 overwrite: true,
                 templateArgs: {
                     isNgrok: host.endsWith('ngrok.io')
                 }
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error appeared during ssl terminator fastcgi_params config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error appeared during ssl terminator fastcgi_params config creation\n\n${e}`
+            )
         }
     }
-});
+})
 
-module.exports = createSSLTerminatorConfig;
+module.exports = createSSLTerminatorConfig

package/lib/tasks/file-system/create-varnish-config.js

@@ -1,50 +1,47 @@
-const path = require('path');
-const UnknownError = require('../../errors/unknown-error');
-const setConfigFile = require('../../util/set-config');
+const path = require('path')
+const UnknownError = require('../../errors/unknown-error')
+const setConfigFile = require('../../util/set-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createVarnishConfig = () => ({
     title: 'Setting Varnish config',
-    skip: (ctx) => !ctx.config.overridenConfiguration.configuration.varnish.enabled,
+    skip: (ctx) =>
+        !ctx.config.overridenConfiguration.configuration.varnish.enabled,
     task: async (ctx) => {
         const {
             ports,
             config: {
                 overridenConfiguration,
-                baseConfig: {
-                    cacheDir
-                }
+                baseConfig: { cacheDir }
             },
             isDockerDesktop
-        } = ctx;
+        } = ctx
 
         const {
-            configuration: {
-                varnish
-            }
-        } = overridenConfiguration;
+            configuration: { varnish }
+        } = overridenConfiguration
 
         try {
             await setConfigFile({
-                configPathname: path.join(
-                    cacheDir,
-                    'varnish',
-                    'default.vcl'
-                ),
+                configPathname: path.join(cacheDir, 'varnish', 'default.vcl'),
                 template: varnish.configTemplate,
                 overwrite: true,
                 templateArgs: {
-                    hostMachine: !isDockerDesktop ? '127.0.0.1' : 'host.docker.internal',
+                    hostMachine: !isDockerDesktop
+                        ? '127.0.0.1'
+                        : 'host.docker.internal',
                     nginxPort: ports.app,
                     healthCheck: varnish.healthCheck
                 }
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during varnish config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error accrued during varnish config creation\n\n${e}`
+            )
         }
     }
-});
+})
 
-module.exports = createVarnishConfig;
+module.exports = createVarnishConfig

package/lib/tasks/file-system/create-vscode-config.js

@@ -1,15 +1,19 @@
-const path = require('path');
-const fs = require('fs');
-const hjson = require('hjson');
-const pathExists = require('../../util/path-exists');
-const setConfigFile = require('../../util/set-config');
-const UnknownError = require('../../errors/unknown-error');
+const path = require('path')
+const fs = require('fs')
+const hjson = require('hjson')
+const pathExists = require('../../util/path-exists')
+const setConfigFile = require('../../util/set-config')
+const UnknownError = require('../../errors/unknown-error')
 
-const listenForXDebugConfigName = 'Listen for XDebug';
+const listenForXDebugConfigName = 'Listen for XDebug'
 
-const xdebugPort = 9003;
+const xdebugPort = 9003
 
-const vscodeLaunchConfigPath = path.join(process.cwd(), '.vscode', 'launch.json');
+const vscodeLaunchConfigPath = path.join(
+    process.cwd(),
+    '.vscode',
+    'launch.json'
+)
 
 /**
  * @param {import('../../../typings/context').ListrContext} ctx
@@ -17,9 +21,9 @@ const vscodeLaunchConfigPath = path.join(process.cwd(), '.vscode', 'launch.json'
 const addPHPDebugConfig = (vscodeLaunchConfig, ctx) => {
     const phpXDebugConfig = vscodeLaunchConfig.configurations.find(
         ({ name }) => name === listenForXDebugConfigName
-    );
+    )
 
-    let hasChanges = false;
+    let hasChanges = false
 
     const newConfiguration = {
         name: listenForXDebugConfigName,
@@ -30,61 +34,68 @@ const addPHPDebugConfig = (vscodeLaunchConfig, ctx) => {
             // eslint-disable-next-line no-template-curly-in-string
             [ctx.config.baseConfig.containerMagentoDir]: '${workspaceFolder}'
         }
-
-    };
+    }
 
     if (phpXDebugConfig && phpXDebugConfig.runtimeExecutable) {
-        vscodeLaunchConfig.configurations = vscodeLaunchConfig.configurations.filter(
-            ({ name }) => name !== listenForXDebugConfigName
-        );
+        vscodeLaunchConfig.configurations =
+            vscodeLaunchConfig.configurations.filter(
+                ({ name }) => name !== listenForXDebugConfigName
+            )
 
-        vscodeLaunchConfig.configurations.push(newConfiguration);
+        vscodeLaunchConfig.configurations.push(newConfiguration)
 
-        return true;
+        return true
     }
     if (!phpXDebugConfig) {
-        vscodeLaunchConfig.configurations.push(newConfiguration);
+        vscodeLaunchConfig.configurations.push(newConfiguration)
 
-        return true;
+        return true
     }
 
-    if (
-        !phpXDebugConfig.port
-        || phpXDebugConfig.port !== xdebugPort) {
-        phpXDebugConfig.port = xdebugPort;
+    if (!phpXDebugConfig.port || phpXDebugConfig.port !== xdebugPort) {
+        phpXDebugConfig.port = xdebugPort
 
-        hasChanges = true;
+        hasChanges = true
     }
 
-    if (!phpXDebugConfig.pathMappings || !phpXDebugConfig.pathMappings[ctx.config.baseConfig.containerMagentoDir]) {
+    if (
+        !phpXDebugConfig.pathMappings ||
+        !phpXDebugConfig.pathMappings[ctx.config.baseConfig.containerMagentoDir]
+    ) {
         phpXDebugConfig.pathMappings = {
             // eslint-disable-next-line no-template-curly-in-string
             [ctx.config.baseConfig.containerMagentoDir]: '${workspaceFolder}'
-        };
+        }
 
-        hasChanges = true;
+        hasChanges = true
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createVSCodeConfig = () => ({
     title: 'Setting VSCode config',
     task: async (ctx, task) => {
         if (await pathExists(vscodeLaunchConfigPath)) {
-            const vscodeLaunchConfig = hjson.parse(await fs.promises.readFile(vscodeLaunchConfigPath, 'utf-8'), {
-                keepWsc: true
-            });
+            const vscodeLaunchConfig = hjson.parse(
+                await fs.promises.readFile(vscodeLaunchConfigPath, 'utf-8'),
+                {
+                    keepWsc: true
+                }
+            )
 
-            const vscodeConfigEdited = addPHPDebugConfig(vscodeLaunchConfig, ctx);
+            const vscodeConfigEdited = addPHPDebugConfig(
+                vscodeLaunchConfig,
+                ctx
+            )
 
             // if vscode config is up-to-date, skip task
             if (!vscodeConfigEdited) {
-                task.skip();
-                return;
+                task.skip()
+                return
             }
 
             const result = hjson.stringify(vscodeLaunchConfig, {
@@ -92,24 +103,28 @@ const createVSCodeConfig = () => ({
                 bracesSameLine: true,
                 separator: true,
                 quotes: 'all'
+            })
 
-            });
-
-            await fs.promises.writeFile(vscodeLaunchConfigPath, result);
+            await fs.promises.writeFile(vscodeLaunchConfigPath, result)
 
-            return;
+            return
         }
 
-        if (!await pathExists(path.join(process.cwd(), '.vscode'))) {
+        if (!(await pathExists(path.join(process.cwd(), '.vscode')))) {
             try {
-                await fs.promises.mkdir(path.join(process.cwd(), '.vscode'));
+                await fs.promises.mkdir(path.join(process.cwd(), '.vscode'))
             } catch (e) {
-                throw new UnknownError(`Unable to creade .vscode directory in your project!\n\n${e}`);
+                throw new UnknownError(
+                    `Unable to creade .vscode directory in your project!\n\n${e}`
+                )
             }
         }
 
         try {
-            const vscodeLaunchConfigTemplatePath = path.join(ctx.config.baseConfig.templateDir, 'vscode-launch.template.json');
+            const vscodeLaunchConfigTemplatePath = path.join(
+                ctx.config.baseConfig.templateDir,
+                'vscode-launch.template.json'
+            )
             await setConfigFile({
                 template: vscodeLaunchConfigTemplatePath,
                 configPathname: vscodeLaunchConfigPath,
@@ -117,12 +132,14 @@ const createVSCodeConfig = () => ({
                     XDebugPort: xdebugPort,
                     baseConfig: ctx.config.baseConfig
                 }
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during launch.json config creation!\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error accrued during launch.json config creation!\n\n${e}`
+            )
         }
     },
     exitOnError: false
-});
+})
 
-module.exports = createVSCodeConfig;
+module.exports = createVSCodeConfig

package/lib/tasks/file-system/index.js

@@ -1,33 +1,37 @@
-const createMariaDBConfig = require('./create-mariadb-config');
-const createNginxConfig = require('./create-nginx-config');
-const createPhpConfig = require('./create-php-config');
-const createPhpDebugConfig = require('./create-php-debug-config');
-const createPhpFpmConfig = require('./create-php-fpm-config');
-const createPhpStormConfig = require('./create-phpstorm-config');
-const createSSLTerminatorConfig = require('./create-ssl-terminator-config');
-const createVarnishConfig = require('./create-varnish-config');
-const createVSCodeConfig = require('./create-vscode-config');
+const createMariaDBConfig = require('./create-mariadb-config')
+const createNginxConfig = require('./create-nginx-config')
+const createPhpConfig = require('./create-php-config')
+const createPhpDebugConfig = require('./create-php-debug-config')
+const createPhpFpmConfig = require('./create-php-fpm-config')
+const createPhpStormConfig = require('./create-phpstorm-config')
+const createSSLTerminatorConfig = require('./create-ssl-terminator-config')
+const createVarnishConfig = require('./create-varnish-config')
+const createVSCodeConfig = require('./create-vscode-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const prepareFileSystem = () => ({
     title: 'Preparing file system',
-    task: (ctx, task) => task.newListr([
-        createSSLTerminatorConfig(),
-        createNginxConfig(),
-        createPhpFpmConfig(),
-        createPhpConfig(),
-        createPhpDebugConfig(),
-        createPhpStormConfig(),
-        createVSCodeConfig(),
-        createVarnishConfig(),
-        createMariaDBConfig()
-    ], {
-        concurrent: true
-    })
-});
+    task: (ctx, task) =>
+        task.newListr(
+            [
+                createSSLTerminatorConfig(),
+                createNginxConfig(),
+                createPhpFpmConfig(),
+                createPhpConfig(),
+                createPhpDebugConfig(),
+                createPhpStormConfig(),
+                createVSCodeConfig(),
+                createVarnishConfig(),
+                createMariaDBConfig()
+            ],
+            {
+                concurrent: true
+            }
+        )
+})
 
 module.exports = {
     prepareFileSystem
-};
+}

package/lib/tasks/import-dump.js

@@ -1,65 +1,74 @@
-const path = require('path');
-const { checkRequirements } = require('./requirements');
+const path = require('path')
+const { checkRequirements } = require('./requirements')
 const {
     importDumpToDatabase,
     fixDB,
     dumpThemeConfig,
     restoreThemeConfig
-} = require('./database');
-const { setupMagento } = require('./magento');
-const indexProducts = require('./magento/setup-magento/index-products');
+} = require('./database')
+const { setupMagento } = require('./magento')
+const indexProducts = require('./magento/setup-magento/index-products')
 const {
     retrieveProjectConfiguration,
     stopProject,
     retrieveFreshProjectConfiguration,
     configureProject
-} = require('./start');
-const importRemoteDb = require('./database/import-remote-db');
-const matchFilesystem = require('../util/match-filesystem');
+} = require('./start')
+const importRemoteDb = require('./database/import-remote-db')
+const matchFilesystem = require('../util/match-filesystem')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const importDump = () => ({
     title: 'Importing Database Dump',
-    task: (ctx, task) => task.newListr([
-        importRemoteDb(),
-        checkRequirements(),
-        retrieveProjectConfiguration(),
-        stopProject(),
-        retrieveFreshProjectConfiguration(),
-        configureProject(),
-        {
-            title: 'Installing Magento',
-            // skip setup if env.php and config.php are present in app/etc folder and db is not empty
-            skip: async (ctx) => {
-                const isFsMatching = await matchFilesystem(path.join(process.cwd(), 'app', 'etc'), ['config.php', 'env.php']);
-                const { databaseConnection } = ctx;
-                const [[{ tableCount }]] = await databaseConnection.query(`
+    task: (ctx, task) =>
+        task.newListr(
+            [
+                importRemoteDb(),
+                checkRequirements(),
+                retrieveProjectConfiguration(),
+                stopProject(),
+                retrieveFreshProjectConfiguration(),
+                configureProject(),
+                {
+                    title: 'Installing Magento',
+                    // skip setup if env.php and config.php are present in app/etc folder and db is not empty
+                    skip: async (ctx) => {
+                        const isFsMatching = await matchFilesystem(
+                            path.join(process.cwd(), 'app', 'etc'),
+                            ['config.php', 'env.php']
+                        )
+                        const { databaseConnection } = ctx
+                        const [[{ tableCount }]] =
+                            await databaseConnection.query(`
                     SELECT count(*) AS tableCount
                     FROM INFORMATION_SCHEMA.TABLES
                     WHERE TABLE_SCHEMA = 'magento';
-                `);
+                `)
 
-                return tableCount !== 0 || !isFsMatching;
-            },
-            task: (subCtx, subTask) => subTask.newListr(
-                setupMagento({ onlyInstallMagento: true })
-            )
-        },
-        dumpThemeConfig(),
-        importDumpToDatabase(),
-        restoreThemeConfig(),
-        fixDB(),
-        setupMagento(),
-        indexProducts()
-    ], {
-        concurrent: false,
-        exitOnError: true,
-        rendererOptions: {
-            collapse: false
-        }
-    })
-});
+                        return tableCount !== 0 || !isFsMatching
+                    },
+                    task: (subCtx, subTask) =>
+                        subTask.newListr(
+                            setupMagento({ onlyInstallMagento: true })
+                        )
+                },
+                dumpThemeConfig(),
+                importDumpToDatabase(),
+                restoreThemeConfig(),
+                fixDB(),
+                setupMagento(),
+                indexProducts()
+            ],
+            {
+                concurrent: false,
+                exitOnError: true,
+                rendererOptions: {
+                    collapse: false
+                }
+            }
+        )
+})
 
-module.exports = importDump;
+module.exports = importDump

package/lib/tasks/link.js

@@ -1,29 +1,30 @@
-const getMagentoVersionConfig = require('../config/get-magento-version-config');
-const { getCachedPorts } = require('../config/get-port-config');
-const getProjectConfiguration = require('../config/get-project-configuration');
-const retrieveThemeData = require('./theme/retrieve-theme-data');
-const linkTheme = require('./theme/link-theme');
-const { startServices } = require('./docker');
-const checkConfigurationFile = require('../config/check-configuration-file');
-const { connectToDatabase } = require('./database');
-const { checkRequirements } = require('./requirements');
+const getMagentoVersionConfig = require('../config/get-magento-version-config')
+const { getCachedPorts } = require('../config/get-port-config')
+const getProjectConfiguration = require('../config/get-project-configuration')
+const retrieveThemeData = require('./theme/retrieve-theme-data')
+const linkTheme = require('./theme/link-theme')
+const { startServices } = require('./docker')
+const checkConfigurationFile = require('../config/check-configuration-file')
+const { connectToDatabase } = require('./database')
+const { checkRequirements } = require('./requirements')
 
 /**
  * @type {(theme: string) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const linkTask = (themePath) => ({
-    task: (ctx, task) => task.newListr([
-        checkRequirements(),
-        getMagentoVersionConfig(),
-        checkConfigurationFile(),
-        getProjectConfiguration(),
-        getCachedPorts(),
-        startServices(),
-        // startPhpFpm(),
-        connectToDatabase(),
-        retrieveThemeData(themePath),
-        linkTheme()
-    ])
-});
+    task: (ctx, task) =>
+        task.newListr([
+            checkRequirements(),
+            getMagentoVersionConfig(),
+            checkConfigurationFile(),
+            getProjectConfiguration(),
+            getCachedPorts(),
+            startServices(),
+            // startPhpFpm(),
+            connectToDatabase(),
+            retrieveThemeData(themePath),
+            linkTheme()
+        ])
+})
 
-module.exports = linkTask;
+module.exports = linkTask