@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/config/versions/magento-2.4.5-p1.js

@@ -1,25 +1,32 @@
-const { defaultMagentoConfig } = require('../magento-config');
-const sodium = require('../services/php/extensions/sodium');
-const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
-const { php81 } = require('../services/php/versions');
-const { sslTerminator } = require('../services/ssl-terminator');
-const { varnish70 } = require('../services/varnish');
-const { repo } = require('../services/php/base-repo');
-const { nginx118 } = require('../services/nginx/versions');
-const { composer2 } = require('../services/composer/versions');
-const { maildev } = require('../services/maildev');
-const { redis62 } = require('../services/redis');
-const { mariadb104 } = require('../services/mariadb/versions');
-const { elasticsearch717 } = require('../services/elasticsearch/versions');
+const { defaultMagentoConfig } = require('../magento-config')
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php81 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish70 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx118 } = require('../services/nginx/versions')
+const { composer2 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis62 } = require('../services/redis')
+const { mariadb104 } = require('../services/mariadb/versions')
+const { elasticsearch717 } = require('../services/elasticsearch/versions')
 
-module.exports = ({ templateDir } = {}) => ({
+/**
+ * @param {Object} param0
+ * @param {string} param0.templateDir
+ * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ */
+module.exports = ({ templateDir }) => ({
     magentoVersion: '2.4.5-p1',
     isDefault: true,
     configuration: {
         php: php81({
             templateDir,
             extensions: { ...magento24PHPExtensionList, sodium },
-            baseImage: `${ repo }:php-8.1-magento-2.4`
+            baseImage: `${repo}:php-8.1-magento-2.4`
         }),
         nginx: nginx118({ templateDir }),
         redis: redis62(),
@@ -38,4 +45,4 @@ module.exports = ({ templateDir } = {}) => ({
     ssl: {
         enabled: false
     }
-});
+})

package/lib/config/versions/magento-2.4.5.js

@@ -1,25 +1,31 @@
-const { defaultMagentoConfig } = require('../magento-config');
-const sodium = require('../services/php/extensions/sodium');
-const { magento24PHPExtensionList } = require('../magento/required-php-extensions');
-const { php81 } = require('../services/php/versions');
-const { sslTerminator } = require('../services/ssl-terminator');
-const { varnish70 } = require('../services/varnish');
-const { repo } = require('../services/php/base-repo');
-const { nginx118 } = require('../services/nginx/versions');
-const { composer2 } = require('../services/composer/versions');
-const { maildev } = require('../services/maildev');
-const { redis62 } = require('../services/redis');
-const { mariadb104 } = require('../services/mariadb/versions');
-const { elasticsearch717 } = require('../services/elasticsearch/versions');
+const { defaultMagentoConfig } = require('../magento-config')
+const sodium = require('../services/php/extensions/sodium')
+const {
+    magento24PHPExtensionList
+} = require('../magento/required-php-extensions')
+const { php81 } = require('../services/php/versions')
+const { sslTerminator } = require('../services/ssl-terminator')
+const { varnish70 } = require('../services/varnish')
+const { repo } = require('../services/php/base-repo')
+const { nginx118 } = require('../services/nginx/versions')
+const { composer2 } = require('../services/composer/versions')
+const { maildev } = require('../services/maildev')
+const { redis62 } = require('../services/redis')
+const { mariadb104 } = require('../services/mariadb/versions')
+const { elasticsearch717 } = require('../services/elasticsearch/versions')
 
-module.exports = ({ templateDir } = {}) => ({
+/**
+ * @param {Object} param0
+ * @param {string} param0.templateDir
+ * @returns {import('../../../typings/index').CMAConfiguration & { magentoVersion: string, isDefault?: boolean }}
+ */
+module.exports = ({ templateDir }) => ({
     magentoVersion: '2.4.5',
-    isDefault: true,
     configuration: {
         php: php81({
             templateDir,
             extensions: { ...magento24PHPExtensionList, sodium },
-            baseImage: `${ repo }:php-8.1-magento-2.4`
+            baseImage: `${repo}:php-8.1-magento-2.4`
         }),
         nginx: nginx118({ templateDir }),
         redis: redis62(),
@@ -38,4 +44,4 @@ module.exports = ({ templateDir } = {}) => ({
     ssl: {
         enabled: false
     }
-});
+})

package/lib/config/xml-parser.js

@@ -1,10 +1,10 @@
-const { XMLParser, XMLBuilder } = require('fast-xml-parser');
-const fs = require('fs');
-const path = require('path');
-const pathExists = require('../util/path-exists');
+const { XMLParser, XMLBuilder } = require('fast-xml-parser')
+const fs = require('fs')
+const path = require('path')
+const pathExists = require('../util/path-exists')
 
 /**
- * @type {import('fast-xml-parser').X2jOptions}
+ * @type {Partial<import('fast-xml-parser').X2jOptions>}
  */
 const xmlParserConfig = {
     ignoreAttributes: false,
@@ -12,31 +12,32 @@ const xmlParserConfig = {
     trimValues: true,
     allowBooleanAttributes: true,
     cdataPropName: '_cdata'
-};
+}
 
 /**
  * @type {Partial<import('fast-xml-parser').XmlBuilderOptions>}
  */
 const xmlBuilderConfig = {
-    ...xmlParserConfig,
+    ignoreAttributes: false,
+    cdataPropName: '_cdata',
     format: true,
     suppressEmptyNode: true,
     suppressBooleanAttributes: false,
     processEntities: true
-};
+}
 
-const parser = new XMLParser(xmlParserConfig);
-const builder = new XMLBuilder(xmlBuilderConfig);
+const parser = new XMLParser(xmlParserConfig)
+const builder = new XMLBuilder(xmlBuilderConfig)
 
 /**
  * Load xml file to js object
  * @param {String} filePath
  */
 const loadXmlFile = async (filePath) => {
-    const fileData = await fs.promises.readFile(filePath, 'utf-8');
+    const fileData = await fs.promises.readFile(filePath, 'utf-8')
 
-    return parser.parse(fileData);
-};
+    return parser.parse(fileData)
+}
 
 /**
  * Build xml from js object and write it to file
@@ -44,20 +45,20 @@ const loadXmlFile = async (filePath) => {
  * @param {String} fileData
  */
 const buildXmlFile = async (filePath, fileData) => {
-    const xmlFileData = builder.build(fileData).replace(/&quot;/ig, '"');
+    const xmlFileData = builder.build(fileData).replace(/&quot;/gi, '"')
 
-    const { dir } = path.parse(filePath);
+    const { dir } = path.parse(filePath)
 
-    if (!await pathExists(dir)) {
+    if (!(await pathExists(dir))) {
         await fs.promises.mkdir(dir, {
             recursive: true
-        });
+        })
     }
 
-    await fs.promises.writeFile(filePath, xmlFileData, 'utf-8');
-};
+    await fs.promises.writeFile(filePath, xmlFileData, 'utf-8')
+}
 
 module.exports = {
     loadXmlFile,
     buildXmlFile
-};
+}

package/lib/errors/known-error.js

@@ -2,14 +2,16 @@ class KnownError extends Error {
     /**
      * @param {String} message Error message
      * @param {String} [name] Error name
-     * @param {{ reportToAnalytics?: boolean }} [param2]
+     * @param {{ reportToAnalytics?: boolean }} [options]
      */
-    constructor(message, name = 'Known Error', { reportToAnalytics = true } = {}) {
-        super(message);
-        this.name = name;
+    constructor(message, name = 'Known Error', options = {}) {
+        super(message)
+        this.name = name
 
-        this.reportToAnalytics = reportToAnalytics;
+        const { reportToAnalytics = true } = options
+
+        this.reportToAnalytics = reportToAnalytics
     }
 }
 
-module.exports = KnownError;
+module.exports = KnownError

package/lib/errors/unknown-error.js

@@ -2,14 +2,16 @@ class UnknownError extends Error {
     /**
      * @param {String} message Error message
      * @param {String} [name] Error name
-     * @param {{ reportToAnalytics?: boolean }} [param2]
+     * @param {{ reportToAnalytics?: boolean }} [options]
      */
-    constructor(message, name = 'Unknown Error', { reportToAnalytics = true } = {}) {
-        super(message);
-        this.name = name;
+    constructor(message, name = 'Unknown Error', options = {}) {
+        super(message)
+        this.name = name
 
-        this.reportToAnalytics = reportToAnalytics;
+        const { reportToAnalytics = true } = options
+
+        this.reportToAnalytics = reportToAnalytics
     }
 }
 
-module.exports = UnknownError;
+module.exports = UnknownError

package/lib/tasks/cache/create-cache-folder.js

@@ -1,22 +1,22 @@
-const fs = require('fs');
-const pathExists = require('../../util/path-exists');
+const fs = require('fs')
+const pathExists = require('../../util/path-exists')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const createCacheFolder = () => ({
     task: async ({ config: { baseConfig } }, task) => {
-        const cacheFolderExists = await pathExists(baseConfig.cacheDir);
+        const cacheFolderExists = await pathExists(baseConfig.cacheDir)
 
         if (cacheFolderExists) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
-        task.title = 'Creating cache folder';
+        task.title = 'Creating cache folder'
 
-        await fs.promises.mkdir(baseConfig.cacheDir);
+        await fs.promises.mkdir(baseConfig.cacheDir)
     }
-});
+})
 
-module.exports = createCacheFolder;
+module.exports = createCacheFolder

package/lib/tasks/cache/index.js

@@ -1,4 +1,4 @@
 module.exports = {
     createCacheFolder: require('./create-cache-folder'),
     removeCacheFolder: require('./remove-cache-folder')
-};
+}

package/lib/tasks/cache/remove-cache-folder.js

@@ -1,22 +1,22 @@
-const fs = require('fs');
-const pathExists = require('../../util/path-exists');
+const fs = require('fs')
+const pathExists = require('../../util/path-exists')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const removeCacheFolder = () => ({
     title: 'Cleaning cache',
     task: async ({ config: { baseConfig } }, task) => {
-        const cacheExists = await pathExists(baseConfig.cacheDir);
+        const cacheExists = await pathExists(baseConfig.cacheDir)
         if (!cacheExists) {
-            task.skip();
-            return;
+            task.skip()
+            return
         }
 
         await fs.promises.rmdir(baseConfig.cacheDir, {
             recursive: true
-        });
+        })
     }
-});
+})
 
-module.exports = removeCacheFolder;
+module.exports = removeCacheFolder

package/lib/tasks/cleanup.js

@@ -1,31 +1,29 @@
-const { removeCacheFolder } = require('./cache');
-const { stopServices } = require('./docker');
-const { removeVolumes } = require('./docker/volume/tasks');
-const {
-    uninstallMagento,
-    removeMagento
-} = require('./magento');
-const getMagentoVersionConfig = require('../config/get-magento-version-config');
+const { removeCacheFolder } = require('./cache')
+const { stopServices } = require('./docker')
+const { removeVolumes } = require('./docker/volume/tasks')
+const { uninstallMagento, removeMagento } = require('./magento')
+const getMagentoVersionConfig = require('../config/get-magento-version-config')
 // const { stopPhpFpm } = require('./php-fpm');
-const getProjectConfiguration = require('../config/get-project-configuration');
-const checkConfigurationFile = require('../config/check-configuration-file');
+const getProjectConfiguration = require('../config/get-project-configuration')
+const checkConfigurationFile = require('../config/check-configuration-file')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const cleanup = () => ({
     title: 'Cleanup project',
-    task: (ctx, task) => task.newListr([
-        checkConfigurationFile(),
-        getMagentoVersionConfig(),
-        getProjectConfiguration(),
-        // stopPhpFpm(),
-        stopServices(),
-        removeVolumes(),
-        removeCacheFolder(),
-        uninstallMagento(),
-        removeMagento()
-    ])
-});
+    task: (ctx, task) =>
+        task.newListr([
+            checkConfigurationFile(),
+            getMagentoVersionConfig(),
+            getProjectConfiguration(),
+            // stopPhpFpm(),
+            stopServices(),
+            removeVolumes(),
+            removeCacheFolder(),
+            uninstallMagento(),
+            removeMagento()
+        ])
+})
 
-module.exports = cleanup;
+module.exports = cleanup

package/lib/tasks/cli/create-bashrc-config.js

@@ -1,19 +1,25 @@
-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 createBashrcConfigFile = () => ({
     title: 'Setting Bashrc config',
     task: async (ctx) => {
-        const { config: { php, baseConfig, overridenConfiguration } } = ctx;
-        const varnishEnabled = overridenConfiguration.configuration.varnish.enabled;
+        const {
+            config: { php, baseConfig, overridenConfiguration }
+        } = ctx
+        const varnishEnabled =
+            overridenConfiguration.configuration.varnish.enabled
         try {
             await setConfigFile({
                 configPathname: path.join(baseConfig.cacheDir, '.magentorc'),
-                template: path.join(baseConfig.templateDir, 'magentorc.template'),
+                template: path.join(
+                    baseConfig.templateDir,
+                    'magentorc.template'
+                ),
                 overwrite: true,
                 templateArgs: {
                     php,
@@ -21,11 +27,13 @@ const createBashrcConfigFile = () => ({
                     config: ctx.config,
                     magentoVersion: ctx.magentoVersion
                 }
-            });
+            })
         } catch (e) {
-            throw new UnknownError(`Unexpected error accrued during .magentorc config creation\n\n${e}`);
+            throw new UnknownError(
+                `Unexpected error accrued during .magentorc config creation\n\n${e}`
+            )
         }
     }
-});
+})
 
-module.exports = createBashrcConfigFile;
+module.exports = createBashrcConfigFile

package/lib/tasks/cli/index.js

@@ -1,23 +1,20 @@
-const path = require('path');
-const { spawn } = require('child_process');
-const { baseConfig } = require('../../config');
+const path = require('path')
+const { spawn } = require('child_process')
+const { baseConfig } = require('../../config')
 
 const cli = () => {
     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)
     }
 
-    spawn('bash', [
-        '--rcfile',
-        path.join(baseConfig.cacheDir, '.magentorc')
-    ], {
+    spawn('bash', ['--rcfile', path.join(baseConfig.cacheDir, '.magentorc')], {
         stdio: [0, 1, 2]
-    });
+    })
 
     return new Promise((_resolve) => {
         // never resolve
-    });
-};
+    })
+}
 
-module.exports = cli;
+module.exports = cli

package/lib/tasks/composer/index.js

@@ -1,43 +1,48 @@
-const safeRegexExtract = require('../../util/safe-regex-extract');
-const UnknownError = require('../../errors/unknown-error');
-const { runContainerImage } = require('../../util/run-container-image');
+const safeRegexExtract = require('../../util/safe-regex-extract')
+const UnknownError = require('../../errors/unknown-error')
+const { runContainerImage } = require('../../util/run-container-image')
 
 /**
  * @param {import('../../../typings/context').ListrContext} ctx
  * @returns {Promise<string>}
  */
 const getComposerVersion = async (ctx) => {
-    const { php } = ctx.config.docker.getContainers(ctx.ports);
-    const composerVersionOutput = await runContainerImage(php.image, 'composer --version --no-ansi');
+    const { php } = ctx.config.docker.getContainers(ctx.ports)
+    const composerVersionOutput = await runContainerImage(
+        php.image,
+        'composer --version --no-ansi'
+    )
 
     const composerVersion = safeRegexExtract({
         string: composerVersionOutput,
         regex: /composer.+(\d+\.\d+\.\d+)/i,
         onNoMatch: () => {
-            throw new UnknownError(`No composer version found in composer version output!\n\n${composerVersionOutput}`);
+            throw new UnknownError(
+                `No composer version found in composer version output!\n\n${composerVersionOutput}`
+            )
         }
-    });
+    })
 
-    return composerVersion;
-};
+    return composerVersion
+}
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const getComposerVersionTask = () => ({
     title: 'Retrieving Composer version',
     task: async (ctx, task) => {
-        const composerVersion = await getComposerVersion(ctx);
-        task.title = `Using Composer version ${composerVersion}`;
-        ctx.composerVersion = composerVersion;
+        const composerVersion = await getComposerVersion(ctx)
+        task.title = `Using Composer version ${composerVersion}`
+        ctx.composerVersion = composerVersion
     },
     options: {
         bottomBar: 10
     }
-});
+})
 
 module.exports = {
     getComposerVersionTask,
     // installPrestissimo,
     getComposerVersion
-};
+}

package/lib/tasks/composer/local-auth-json.js

@@ -1,38 +1,52 @@
-const path = require('path');
-const fs = require('fs');
-const pathExists = require('../../util/path-exists');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const UnknownError = require('../../errors/unknown-error');
-const KnownError = require('../../errors/known-error');
+const path = require('path')
+const fs = require('fs')
+const pathExists = require('../../util/path-exists')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const UnknownError = require('../../errors/unknown-error')
+const KnownError = require('../../errors/known-error')
 
-const authJsonPath = path.join(process.cwd(), 'auth.json');
+const authJsonPath = path.join(process.cwd(), 'auth.json')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const localAuthJson = () => ({
     task: async (ctx, task) => {
         if (await pathExists(authJsonPath)) {
-            task.title = 'Using local auth.json';
-            const localAuthJson = await fs.promises.readFile(authJsonPath);
+            task.title = 'Using local auth.json'
+            const localAuthJson = await fs.promises.readFile(authJsonPath)
 
-            let localAuthJsonContent;
+            let localAuthJsonContent
             try {
-                localAuthJsonContent = JSON.parse(localAuthJson);
+                localAuthJsonContent = JSON.parse(localAuthJson)
             } catch (e) {
-                throw new UnknownError(`Could not parse ./auth.json file as JSON!\n\n${e}`);
+                throw new UnknownError(
+                    `Could not parse ./auth.json file as JSON!\n\n${e}`
+                )
             }
 
-            if (!localAuthJsonContent || !localAuthJsonContent['http-basic'] || !localAuthJsonContent['http-basic']['repo.magento.com']) {
-                throw new KnownError(`Your ./auth.json file does not contain the ${ logger.style.misc("{ 'http-basic': { 'repo.magento.com': <> } }") } field.`);
+            if (
+                !localAuthJsonContent ||
+                !localAuthJsonContent['http-basic'] ||
+                !localAuthJsonContent['http-basic']['repo.magento.com']
+            ) {
+                throw new KnownError(
+                    `Your ./auth.json file does not contain the ${logger.style.misc(
+                        "{ 'http-basic': { 'repo.magento.com': <> } }"
+                    )} field.`
+                )
             }
 
-            process.env.COMPOSER_AUTH = JSON.stringify(JSON.parse(localAuthJson), null, 0);
+            process.env.COMPOSER_AUTH = JSON.stringify(
+                JSON.parse(localAuthJson),
+                null,
+                0
+            )
         }
     },
     options: {
         showTimer: false
     }
-});
+})
 
-module.exports = localAuthJson;
+module.exports = localAuthJson