@scandipwa/magento-scripts 2.0.3 → 2.0.4

package/lib/util/config-php-json.js

@@ -1,29 +1,47 @@
-const path = require('path');
-const UnknownError = require('../errors/unknown-error');
-const { runPHPContainerCommand } = require('../tasks/php/php-container');
-const pathExists = require('./path-exists');
+const path = require('path')
+const UnknownError = require('../errors/unknown-error')
+const { runPHPContainerCommand } = require('../tasks/php/php-container')
+const pathExists = require('./path-exists')
 
 /**
  * @param {import('../../typings/context').ListrContext} ctx
  */
 const configPhpToJson = async (ctx) => {
-    const configPhpOnSystemPath = path.join(ctx.config.baseConfig.magentoDir, 'app', 'etc', 'config.php');
-    const configPhpInContainerPath = path.join(ctx.config.baseConfig.containerMagentoDir, 'app', 'etc', 'config.php');
-    if (!await pathExists(configPhpOnSystemPath)) {
-        return null;
+    const configPhpOnSystemPath = path.join(
+        ctx.config.baseConfig.magentoDir,
+        'app',
+        'etc',
+        'config.php'
+    )
+    const configPhpInContainerPath = path.join(
+        ctx.config.baseConfig.containerMagentoDir,
+        'app',
+        'etc',
+        'config.php'
+    )
+    if (!(await pathExists(configPhpOnSystemPath))) {
+        return null
     }
-    const { code, result } = await runPHPContainerCommand(ctx, `php -r "echo json_encode(require '${configPhpInContainerPath}');"`, {
-        withCode: true
-    });
+    const { code, result } = await runPHPContainerCommand(
+        ctx,
+        `php -r "echo json_encode(require '${configPhpInContainerPath}');"`,
+        {
+            withCode: true
+        }
+    )
 
     if (code !== 0) {
-        throw new UnknownError(`Received non-zero code during converting app/etc/config.php to json:\n\n${result}`);
+        throw new UnknownError(
+            `Received non-zero code during converting app/etc/config.php to json:\n\n${result}`
+        )
     }
     try {
-        return JSON.parse(result);
+        return JSON.parse(result)
     } catch (e) {
-        throw new UnknownError(`Ooops! Something went wrong when trying to parse app/etc/config.php file!\n\n${e}\n\nFile result: ${result}`);
+        throw new UnknownError(
+            `Ooops! Something went wrong when trying to parse app/etc/config.php file!\n\n${e}\n\nFile result: ${result}`
+        )
     }
-};
+}
 
-module.exports = configPhpToJson;
+module.exports = configPhpToJson

package/lib/util/connection-string.js

@@ -2,11 +2,12 @@
  * @typedef ParsedConnection
  * @prop {String} protocol
  * @prop {String} [user]
+ * @prop {String} [password]
  * @prop {String} [port]
  * @prop {String} host
  * @prop {String} [hostname]
  * @prop {String[]} [segments]
- * @prop {Record<string, string} params
+ * @prop {Record<string, string>} params
  */
 
 /**
@@ -14,49 +15,62 @@
  * @returns {ParsedConnection}
  */
 const connectionStringParser = (url) => {
-    // eslint-disable-next-line no-useless-escape
-    const pattern = /^(?:([^:\/?#\s]+):\/{2})?(?:([^@\/?#\s]+)@)?([^\/?#\s]+)?(?:\/([^?#\s]*))?(?:[?]([^#\s]+))?\S*$/;
-    const matches = url.match(pattern);
-    const params = {};
-    if (matches[5] !== undefined) {
+    const pattern =
+        /^(?:([^:/?#\s]+):\/{2})?(?:([^@/?#\s]+)@)?([^/?#\s]+)?(?:\/([^?#\s]*))?(?:[?]([^#\s]+))?\S*$/
+    const matches = url.match(pattern)
+
+    if (!matches) {
+        return {
+            host: '',
+            params: {},
+            protocol: ''
+        }
+    }
+    /**
+     * @type {Record<string, string>}
+     */
+    const params = {}
+    if (matches && matches[5] !== undefined) {
         matches[5].split('&').forEach((x) => {
-            const a = x.split('=');
-            params[a[0]] = a[1];
-        });
+            const a = x.split('=')
+            params[a[0]] = a[1]
+        })
     }
 
     return {
         protocol: matches[1],
         user: matches[2] !== undefined ? matches[2].split(':')[0] : undefined,
-        password: matches[2] !== undefined ? matches[2].split(':')[1] : undefined,
+        password:
+            matches[2] !== undefined ? matches[2].split(':')[1] : undefined,
         host: matches[3],
-        hostname: matches[3] !== undefined ? matches[3].split(/:(?=\d+$)/)[0] : undefined,
-        port: matches[3] !== undefined ? matches[3].split(/:(?=\d+$)/)[1] : undefined,
+        hostname:
+            matches[3] !== undefined
+                ? matches[3].split(/:(?=\d+$)/)[0]
+                : undefined,
+        port:
+            matches[3] !== undefined
+                ? matches[3].split(/:(?=\d+$)/)[1]
+                : undefined,
         segments: matches[4] !== undefined ? matches[4].split('/') : undefined,
         params
-    };
-};
+    }
+}
 
 /**
  * @param {ParsedConnection} options
  * @returns {String}
  */
 const connectionStringBuilder = (options) => {
-    const {
-        protocol,
-        user,
-        password,
-        host,
-        port,
-        segments,
-        params
-    } = options;
+    const { protocol, user, password, host, port, segments, params } = options
 
-    // eslint-disable-next-line max-len
-    return `${protocol}://${(user && password) ? `${user}:${password}@` : ''}${host}${port ? `:${port}` : ''}/${(segments && segments.length > 0) ? segments.join('/') : ''}${new URLSearchParams(params).toString()}`;
-};
+    return `${protocol}://${
+        user && password ? `${user}:${password}@` : ''
+    }${host}${port ? `:${port}` : ''}/${
+        segments && segments.length > 0 ? segments.join('/') : ''
+    }${new URLSearchParams(params).toString()}`
+}
 
 module.exports = {
     connectionStringParser,
     connectionStringBuilder
-};
+}

package/lib/util/console-block.js

@@ -4,49 +4,48 @@
  * @typedef {{ type: BlockType, data: string }} Block
  */
 
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-
-const HORIZONTAL_SEPARATOR = '-';
-const VERTICAL_SEPARATOR = '|';
-const EMPTY_CHAR = ' ';
-const TOP_LEFT_SEPARATOR = '┌';
-const TOP_RIGHT_SEPARATOR = '┐';
-const MIDDLE_LEFT_SEPARATOR = '├';
-const MIDDLE_RIGHT_SEPARATOR = '┤';
-const BOTTOM_LEFT_SEPARATOR = '└';
-const BOTTOM_RIGHT_SEPARATOR = '┘';
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+
+const HORIZONTAL_SEPARATOR = '-'
+const VERTICAL_SEPARATOR = '|'
+const EMPTY_CHAR = ' '
+const TOP_LEFT_SEPARATOR = '┌'
+const TOP_RIGHT_SEPARATOR = '┐'
+const MIDDLE_LEFT_SEPARATOR = '├'
+const MIDDLE_RIGHT_SEPARATOR = '┤'
+const BOTTOM_LEFT_SEPARATOR = '└'
+const BOTTOM_RIGHT_SEPARATOR = '┘'
 
 // eslint-disable-next-line no-control-regex
-const consoleStyleReplacer = /[\u001b]\[\S+?m/g;
+const consoleStyleReplacer = /[\u001b]\[\S+?m/g
 
 class ConsoleBlock {
     constructor() {
         /**
          * @type {Block[]}
          */
-        this.data = [];
+        this.data = []
     }
 
     /**
      * @param {string} header
      */
     addHeader(header) {
-        this.data.unshift(
-            {
-                type: 'header',
-                data: header
-            }
-        );
+        this.data.unshift({
+            type: 'header',
+            data: header
+        })
 
-        return this;
+        return this
     }
 
     addEmptyLine() {
         this.data.push({
-            type: 'empty-line'
-        });
+            type: 'empty-line',
+            data: ''
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -56,9 +55,9 @@ class ConsoleBlock {
         this.data.push({
             type: 'line',
             data: line
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -68,58 +67,106 @@ class ConsoleBlock {
         this.data.push({
             type: 'separator',
             data: separator
-        });
+        })
 
-        return this;
+        return this
     }
 
     log() {
         const longestLineRaw = this.data.reduce(
-            (acc, { data = '' }) => (
-                data.replace(consoleStyleReplacer, '').length > acc ? data.replace(consoleStyleReplacer, '').length : acc
-            ),
+            (acc, { data = '' }) =>
+                data.replace(consoleStyleReplacer, '').length > acc
+                    ? data.replace(consoleStyleReplacer, '').length
+                    : acc,
             0
-        );
-        const longestLine = longestLineRaw % 2 === 0 ? longestLineRaw + 2 : longestLineRaw + 3;
+        )
+        const longestLine =
+            longestLineRaw % 2 === 0 ? longestLineRaw + 2 : longestLineRaw + 3
 
-        logger.log('');
+        logger.log('')
 
         this.data.forEach(({ type, data }) => {
             switch (type) {
-            case 'header': {
-                const dataLength = data.replace(consoleStyleReplacer, '').length;
-                const spacersLength = (longestLine - (dataLength % 2 === 0 ? dataLength : (dataLength + 1))) / 2;
-
-                logger.log(`${TOP_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(spacersLength)}${EMPTY_CHAR}${data}${EMPTY_CHAR}${HORIZONTAL_SEPARATOR.repeat(dataLength % 2 === 0 ? spacersLength : spacersLength + 1)}${TOP_RIGHT_SEPARATOR}`);
-                break;
-            }
-
-            case 'line': {
-                logger.log(`${VERTICAL_SEPARATOR}${EMPTY_CHAR}${data}${EMPTY_CHAR.repeat(longestLine - data.replace(consoleStyleReplacer, '').length || 1)}${EMPTY_CHAR}${VERTICAL_SEPARATOR}`);
-                break;
-            }
-
-            case 'separator': {
-                const dataLength = data.replace(consoleStyleReplacer, '').length;
-                const spacersLength = (longestLine - (dataLength % 2 === 0 ? dataLength : (dataLength + 1))) / 2;
-
-                logger.log(`${MIDDLE_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(spacersLength)}${EMPTY_CHAR}${data}${EMPTY_CHAR}${HORIZONTAL_SEPARATOR.repeat(dataLength % 2 === 0 ? spacersLength : spacersLength + 1)}${MIDDLE_RIGHT_SEPARATOR}`);
-                break;
-            }
-
-            case 'empty-line': {
-                logger.log(`${VERTICAL_SEPARATOR}${EMPTY_CHAR.repeat(longestLine + 2)}${VERTICAL_SEPARATOR}`);
-                break;
-            }
-
-            default: {
-                //
-            }
+                case 'header': {
+                    const dataLength = data.replace(
+                        consoleStyleReplacer,
+                        ''
+                    ).length
+                    const spacersLength =
+                        (longestLine -
+                            (dataLength % 2 === 0
+                                ? dataLength
+                                : dataLength + 1)) /
+                        2
+
+                    logger.log(
+                        `${TOP_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(
+                            spacersLength
+                        )}${EMPTY_CHAR}${data}${EMPTY_CHAR}${HORIZONTAL_SEPARATOR.repeat(
+                            dataLength % 2 === 0
+                                ? spacersLength
+                                : spacersLength + 1
+                        )}${TOP_RIGHT_SEPARATOR}`
+                    )
+                    break
+                }
+
+                case 'line': {
+                    logger.log(
+                        `${VERTICAL_SEPARATOR}${EMPTY_CHAR}${data}${EMPTY_CHAR.repeat(
+                            longestLine -
+                                data.replace(consoleStyleReplacer, '').length ||
+                                1
+                        )}${EMPTY_CHAR}${VERTICAL_SEPARATOR}`
+                    )
+                    break
+                }
+
+                case 'separator': {
+                    const dataLength = data.replace(
+                        consoleStyleReplacer,
+                        ''
+                    ).length
+                    const spacersLength =
+                        (longestLine -
+                            (dataLength % 2 === 0
+                                ? dataLength
+                                : dataLength + 1)) /
+                        2
+
+                    logger.log(
+                        `${MIDDLE_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(
+                            spacersLength
+                        )}${EMPTY_CHAR}${data}${EMPTY_CHAR}${HORIZONTAL_SEPARATOR.repeat(
+                            dataLength % 2 === 0
+                                ? spacersLength
+                                : spacersLength + 1
+                        )}${MIDDLE_RIGHT_SEPARATOR}`
+                    )
+                    break
+                }
+
+                case 'empty-line': {
+                    logger.log(
+                        `${VERTICAL_SEPARATOR}${EMPTY_CHAR.repeat(
+                            longestLine + 2
+                        )}${VERTICAL_SEPARATOR}`
+                    )
+                    break
+                }
+
+                default: {
+                    //
+                }
             }
-        });
+        })
 
-        logger.logN(`${BOTTOM_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(longestLine + 2)}${BOTTOM_RIGHT_SEPARATOR}`);
+        logger.logN(
+            `${BOTTOM_LEFT_SEPARATOR}${HORIZONTAL_SEPARATOR.repeat(
+                longestLine + 2
+            )}${BOTTOM_RIGHT_SEPARATOR}`
+        )
     }
 }
 
-module.exports = ConsoleBlock;
+module.exports = ConsoleBlock

package/lib/util/database.js

@@ -1,82 +1,105 @@
 /**
  * Update table in **magento** database
  * @param {String} table Table name
- * @param {{path: string, value: string}[]} values
- * @param {import('../../typings/context').ListrContext} param1
+ * @param {{ path: string, value: string | number | null }[]} values
+ * @param {{ databaseConnection: import('../../typings/context').ListrContext['databaseConnection'], task: import('listr2').ListrTaskWrapper<import('../../typings/context').ListrContext, any> }} param2
  */
-const updateTableValues = async (table, values, { databaseConnection, task }) => {
+const updateTableValues = async (
+    table,
+    values,
+    { databaseConnection, task }
+) => {
     const [rows] = await databaseConnection.query(`
         SELECT * FROM ${table}
         WHERE ${values.map((p) => `path = '${p.path}'`).join(' OR ')};
-    `);
+    `)
 
     if (rows.filter(Boolean).length !== values.length) {
-        const lostConfigs = values.filter((p) => !rows.some((row) => row.path === p.path));
+        const lostConfigs = values.filter(
+            (p) => !rows.some((row) => row.path === p.path)
+        )
         for (const config of lostConfigs) {
-            await databaseConnection.query(`
+            await databaseConnection.query(
+                `
                 INSERT INTO ${table}
                 (scope, path, value)
                 VALUES ('default', ?, ?);
-            `, [config.path, config.value]);
+            `,
+                [config.path, config.value]
+            )
         }
 
-        const configsToUpdate = values.filter((p) => rows.some((row) => row.path === p.path));
+        const configsToUpdate = values.filter((p) =>
+            rows.some((row) => row.path === p.path)
+        )
         for (const config of configsToUpdate) {
-            await databaseConnection.query(`
+            await databaseConnection.query(
+                `
                 UPDATE ${table}
                 SET value = ?
                 WHERE path = ?;
-            `, [config.value, config.path]);
+            `,
+                [config.value, config.path]
+            )
         }
 
-        return;
+        return
     }
 
+    /**
+     * @param {{ path: string, value: unknown }} param0
+     */
     const checkIfValueIsCorrect = ({ path, value }) => {
-        const val = values.find((p) => p.path === path);
+        const val = values.find((p) => p.path === path)
 
-        return val && val.value === value;
-    };
+        return val && val.value === value
+    }
 
     if (rows.every(checkIfValueIsCorrect)) {
-        task.skip();
-        return;
+        task.skip()
+        return
     }
 
     const configsToUpdate = values.filter(({ path, value }) => {
-        const row = rows.find((row) => row.path === path);
+        const row = rows.find((row) => row.path === path)
 
-        return row && row.value !== value;
-    });
+        return row && row.value !== value
+    })
 
     for (const config of configsToUpdate) {
-        await databaseConnection.query(`
+        await databaseConnection.query(
+            `
             UPDATE ${table}
             SET value = ?
             WHERE path = ?;
-        `, [config.value, config.path]);
+        `,
+            [config.value, config.path]
+        )
     }
-};
+}
 
 /**
-* @param {String} database
-* @param {String} tableName
-* @param {import('../../typings/context').ListrContext} param2
-*/
+ * @param {String} database
+ * @param {String} tableName
+ * @param {import('../../typings/context').ListrContext} param2
+ */
 const isTableExists = async (database, tableName, { databaseConnection }) => {
     /**
-    * @type {{ tableCount: number }[][]}
-    */
-    const [[{ tableCount }]] = await databaseConnection.query(`
+     * @type {{ tableCount: number }[][]}
+     */
+    const [[{ tableCount }]] = await databaseConnection.query(
+        `
    SELECT count(*) as tableCount
    FROM information_schema.TABLES
    WHERE (TABLE_SCHEMA = ?) AND (TABLE_NAME = ?);
-`, [database, tableName]);
+`,
+        [database, tableName]
+    )
 
-    return tableCount > 0;
-};
+    return tableCount > 0
+}
 
 module.exports = {
     updateTableValues,
     isTableExists
-};
+}

package/lib/util/deepmerge.d.ts

@@ -1 +1 @@
-export function deepmerge<T>(target: T, ...sources: T[]): T
+export function deepmerge<T>(target: T, ...sources: Partial<T>[]): T

package/lib/util/deepmerge.js

@@ -1,37 +1,28 @@
 /**
  * Merge object deeply
- * @param {object} target
- * @param  {...object} sources
- * @returns {object}
+ * @type {<T>(target: T, ...sources: Partial<T>[]) => T}
  */
-function deepmerge(
-    target,
-    ...sources
-) {
-    const targetCopy = { ...target };
-    const isObject = (obj) => obj && typeof obj === 'object';
-    sources.forEach((source) => Object.keys(source).forEach((key) => {
-        const targetValue = targetCopy[key];
-        const sourceValue = source[key];
+function deepmerge(target, ...sources) {
+    const targetCopy = { ...target }
+    const isObject = (obj) => obj && typeof obj === 'object'
+    sources.forEach((source) =>
+        Object.keys(source).forEach((key) => {
+            const targetValue = targetCopy[key]
+            const sourceValue = source[key]
 
-        if (Array.isArray(targetValue) && Array.isArray(sourceValue)) {
-            targetCopy[key] = targetValue.concat(sourceValue);
-        } else if (
-            isObject(targetValue)
-          && isObject(sourceValue)
-        ) {
-            targetCopy[key] = deepmerge(
-                { ...targetValue },
-                sourceValue
-            );
-        } else {
-            targetCopy[key] = sourceValue;
-        }
-    }));
+            if (Array.isArray(targetValue) && Array.isArray(sourceValue)) {
+                targetCopy[key] = targetValue.concat(sourceValue)
+            } else if (isObject(targetValue) && isObject(sourceValue)) {
+                targetCopy[key] = deepmerge({ ...targetValue }, sourceValue)
+            } else {
+                targetCopy[key] = sourceValue
+            }
+        })
+    )
 
-    return targetCopy;
+    return targetCopy
 }
 
 module.exports = {
     deepmerge
-};
+}