@scandipwa/magento-scripts 1.14.0 → 1.14.1-alpha.2

package/lib/config/templates/php-fpm.template.conf

@@ -18,3 +18,4 @@ pm.process_idle_timeout = 10s
 pm.status_path = /fpmstatus
 listen = 127.0.0.1:<%= it.ports.fpm %>
 
+env[PATH] = $PATH

package/lib/config/versions/magento-2.3.7-p2.js

@@ -0,0 +1,47 @@
+const path = require('path');
+const { defaultMagentoConfig } = require('../magento-config');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.3.7-p2',
+    configuration: {
+        php: {
+            version: '7.4.27',
+            configTemplate: path.join(templateDir || '', 'php.template.ini'),
+            extensions: {
+                gd: {},
+                intl: {},
+                zlib: {},
+                openssl: {},
+                sockets: {},
+                SimpleXML: {},
+                xdebug: {
+                    version: '3.1.2'
+                }
+            }
+        },
+        nginx: {
+            version: '1.18.0',
+            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+        },
+        redis: {
+            version: '6'
+        },
+        mysql: {
+            version: '5.7'
+        },
+        mariadb: {
+            version: '10.2'
+        },
+        elasticsearch: {
+            version: '7.9.3'
+        },
+        composer: {
+            version: '2'
+        }
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

package/lib/config/versions/magento-2.3.7-p3.js

@@ -0,0 +1,47 @@
+const path = require('path');
+const { defaultMagentoConfig } = require('../magento-config');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.3.7-p3',
+    configuration: {
+        php: {
+            version: '7.4.27',
+            configTemplate: path.join(templateDir || '', 'php.template.ini'),
+            extensions: {
+                gd: {},
+                intl: {},
+                zlib: {},
+                openssl: {},
+                sockets: {},
+                SimpleXML: {},
+                xdebug: {
+                    version: '3.1.2'
+                }
+            }
+        },
+        nginx: {
+            version: '1.18.0',
+            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+        },
+        redis: {
+            version: '6'
+        },
+        mysql: {
+            version: '5.7'
+        },
+        mariadb: {
+            version: '10.2'
+        },
+        elasticsearch: {
+            version: '7.9.3'
+        },
+        composer: {
+            version: '2'
+        }
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

package/lib/config/versions/magento-2.4.3-p2.js

@@ -0,0 +1,51 @@
+const path = require('path');
+const { defaultMagentoConfig } = require('../magento-config');
+const { libsodium } = require('../php/extensions');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.4.3-p2',
+    isDefault: true,
+    configuration: {
+        php: {
+            version: '7.4.27',
+            configTemplate: path.join(templateDir || '', 'php.template.ini'),
+            extensions: {
+                gd: {},
+                intl: {},
+                zlib: {},
+                openssl: {},
+                sockets: {},
+                SimpleXML: {},
+                libsodium,
+                fileinfo: {},
+                xdebug: {
+                    version: '3.1.2'
+                }
+            }
+        },
+        nginx: {
+            version: '1.18.0',
+            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+        },
+        redis: {
+            version: '6.0'
+        },
+        mysql: {
+            version: '8.0'
+        },
+        mariadb: {
+            version: '10.4'
+        },
+        elasticsearch: {
+            version: '7.12.1'
+        },
+        composer: {
+            version: '2'
+        }
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

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

@@ -0,0 +1,51 @@
+const path = require('path');
+const { defaultMagentoConfig } = require('../magento-config');
+const { libsodium } = require('../php/extensions');
+
+module.exports = ({ templateDir } = {}) => ({
+    magentoVersion: '2.4.4',
+    isDefault: true,
+    configuration: {
+        php: {
+            version: '8.1.4',
+            configTemplate: path.join(templateDir || '', 'php.template.ini'),
+            extensions: {
+                gd: {},
+                intl: {},
+                zlib: {},
+                openssl: {},
+                sockets: {},
+                SimpleXML: {},
+                libsodium,
+                fileinfo: {},
+                xdebug: {
+                    version: '3.1.4'
+                }
+            }
+        },
+        nginx: {
+            version: '1.18.0',
+            configTemplate: path.join(templateDir || '', 'nginx.template.conf')
+        },
+        redis: {
+            version: '6.0'
+        },
+        mysql: {
+            version: '8.0'
+        },
+        mariadb: {
+            version: '10.4'
+        },
+        elasticsearch: {
+            version: '7.16.3'
+        },
+        composer: {
+            version: '2'
+        }
+    },
+    magento: defaultMagentoConfig,
+    host: 'localhost',
+    ssl: {
+        enabled: false
+    }
+});

package/lib/config/xml-parser.js

@@ -0,0 +1,61 @@
+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}
+ */
+const xmlParserConfig = {
+    ignoreAttributes: false,
+    parseAttributeValue: false,
+    trimValues: true,
+    allowBooleanAttributes: true
+};
+
+/**
+ * @type {Partial<import('fast-xml-parser').XmlBuilderOptions>}
+ */
+const xmlBuilderConfig = {
+    ...xmlParserConfig,
+    format: true,
+    suppressEmptyNode: true,
+    suppressBooleanAttributes: false
+};
+
+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');
+
+    return parser.parse(fileData);
+};
+
+/**
+ * Build xml from js object and write it to file
+ * @param {String} filePath
+ * @param {String} fileData
+ */
+const buildXmlFile = async (filePath, fileData) => {
+    const xmlFileData = builder.build(fileData);
+
+    const { dir } = path.parse(filePath);
+
+    if (!await pathExists(dir)) {
+        await fs.promises.mkdir(dir, {
+            recursive: true
+        });
+    }
+
+    await fs.promises.writeFile(filePath, xmlFileData, 'utf-8');
+};
+
+module.exports = {
+    loadXmlFile,
+    buildXmlFile
+};

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

@@ -0,0 +1,248 @@
+/* eslint-disable no-param-reassign */
+const { loadXmlFile, buildXmlFile } = require('../../../config/xml-parser');
+const pathExists = require('../../../util/path-exists');
+const setConfigFile = require('../../../util/set-config');
+
+/**
+ * Get link to data-source field, create fields if necessary
+ *
+ * @param {Object} data
+ * @param {Object} defaultData Default data structure that will be used if original data is missing
+ */
+const getToDataSource = (data, defaultData) => {
+    if (!data.project) {
+        data.project = defaultData.project;
+    }
+
+    if (!data.project.component) {
+        data.project.component = defaultData.project.component;
+    }
+
+    if (!data.project.component['data-source']) {
+        data.project.component['data-source'] = defaultData.project.component['data-source'];
+    }
+
+    return data.project.component['data-source'];
+};
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const setupDataSourceLocalConfig = () => ({
+    title: 'Set up datasource local configuration',
+    task: async (ctx, task) => {
+        const {
+            config: {
+                phpStorm,
+                phpStorm: {
+                    database
+                }
+            }
+        } = ctx;
+
+        if (await pathExists(database.dataSourcesLocal.path)) {
+            let hasChanges = false;
+            const dataSourcesLocalData = await loadXmlFile(database.dataSourcesLocal.path);
+            const dataSource = getToDataSource(
+                dataSourcesLocalData,
+                {
+                    project: {
+                        '@_version': '4',
+                        component: {
+                            '@_name': 'dataSourceStorageLocal',
+                            '@_created-in': 'PS-212.5284.49',
+                            'data-source': {
+                                '@_uuid': 'a2eadb3c-6fc9-4d85-b5f4-d8114906ce2f'
+                            }
+                        }
+                    }
+                }
+            );
+
+            if (dataSource['@_name'] !== database.dataSourceManagerName) {
+                hasChanges = true;
+                dataSource['@_name'] = database.dataSourceManagerName;
+            }
+
+            if (dataSource['@_uuid'] === undefined) {
+                hasChanges = true;
+                dataSource['@_uuid'] = 'a2eadb3c-6fc9-4d85-b5f4-d8114906ce2f';
+            }
+
+            const defaultDatabaseInfoConfig = {
+                '@_product': '',
+                '@_version': '',
+                '@_jdbc-version': '',
+                '@_driver-name': '',
+                '@_driver-version': '',
+                '@_dbms': 'MYSQL',
+                '@_exact-version': '0'
+            };
+            const isDatabaseInfoChangeNeeded = dataSource['database-info']
+                ? Object.entries(defaultDatabaseInfoConfig)
+                    .some(([key]) => !(key in dataSource['database-info']))
+                : true;
+
+            if (isDatabaseInfoChangeNeeded) {
+                hasChanges = true;
+                if (!dataSource['database-info']) {
+                    dataSource['database-info'] = defaultDatabaseInfoConfig;
+                } else {
+                    Object.entries(defaultDatabaseInfoConfig).forEach(([key, value]) => {
+                        if (!(key in dataSource['database-info'])) {
+                            dataSource['database-info'][key] = value;
+                        }
+                        // ^^^ only set missing properties, only ones should be in place
+                    });
+                }
+            }
+
+            const dataSourceDefaultData = {
+                'secret-storage': 'master_key',
+                'user-name': 'magento'
+            };
+
+            const isDataSourceDataChangeNeeded = dataSource
+                ? Object.entries(dataSourceDefaultData)
+                    .some(([key, value]) => dataSource[key] !== value)
+                : true;
+
+            if (isDataSourceDataChangeNeeded) {
+                hasChanges = true;
+                Object.entries(dataSourceDefaultData).forEach(([key, value]) => {
+                    dataSource[key] = value;
+                });
+            }
+
+            if (!('schema-mapping' in dataSource)) {
+                hasChanges = true;
+                dataSource['schema-mapping'] = '';
+            }
+
+            if (hasChanges) {
+                await buildXmlFile(database.dataSourcesLocal.path, dataSourcesLocalData);
+            } else {
+                task.skip();
+            }
+        } else {
+            try {
+                await setConfigFile({
+                    configPathname: phpStorm.database.dataSourcesLocal.path,
+                    template: phpStorm.database.dataSourcesLocal.templatePath,
+                    overwrite: true,
+                    templateArgs: {
+                        phpStorm
+                    }
+                });
+            } catch (e) {
+                throw new Error(`Unexpected error accrued during dataSources.local.xml config creation\n\n${e}`);
+            }
+        }
+    }
+});
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const setupDataSourceConfig = () => ({
+    task: async (ctx, task) => {
+        const {
+            config: {
+                phpStorm,
+                phpStorm: {
+                    database
+                }
+            },
+            ports
+        } = ctx;
+        const jdbcUrl = `jdbc:mysql://localhost:${ports.mysql}/magento`;
+
+        if (await pathExists(database.dataSources.path)) {
+            let hasChanges = false;
+            const dataSourcesData = await loadXmlFile(database.dataSources.path);
+            const dataSource = getToDataSource(
+                dataSourcesData,
+                {
+                    project: {
+                        '@_version': '4',
+                        component: {
+                            '@_name': 'DataSourceManagerImpl',
+                            '@_format': 'xml',
+                            '@_multifile-model': true,
+                            'data-source': {
+                                '@_source': 'LOCAL',
+                                '@_uuid': 'a2eadb3c-6fc9-4d85-b5f4-d8114906ce2f'
+                            }
+                        }
+                    }
+                }
+            );
+
+            if (dataSource['@_uuid'] === undefined) {
+                hasChanges = true;
+                dataSource['@_uuid'] = 'a2eadb3c-6fc9-4d85-b5f4-d8114906ce2f';
+            }
+
+            const expectedDataSourceData = {
+                '@_name': database.dataSourceManagerName,
+                'driver-ref': 'mysql.8',
+                synchronize: true,
+                'jdbc-driver': 'com.mysql.cj.jdbc.Driver',
+                'jdbc-url': jdbcUrl,
+                'working-dir': '$ProjectFileDir$',
+                '@_source': 'LOCAL'
+            };
+
+            const isDataSourceNeedChanges = dataSource
+                ? Object.entries(expectedDataSourceData)
+                    .some(([key]) => !(key in dataSource))
+                : true;
+
+            if (isDataSourceNeedChanges) {
+                hasChanges = true;
+                if (!dataSource) {
+                    dataSourcesData.project.component['data-source'] = expectedDataSourceData;
+                } else {
+                    Object.entries(expectedDataSourceData).forEach(([key, value]) => {
+                        if (!(key in dataSource)) {
+                            dataSource[key] = value;
+                        }
+                    });
+                }
+            }
+
+            if (hasChanges) {
+                await buildXmlFile(database.dataSources.path, dataSourcesData);
+            } else {
+                task.skip();
+            }
+        } else {
+            try {
+                await setConfigFile({
+                    configPathname: phpStorm.database.dataSources.path,
+                    template: phpStorm.database.dataSources.templatePath,
+                    overwrite: true,
+                    templateArgs: {
+                        phpStorm,
+                        jdbcUrl
+                    }
+                });
+            } catch (e) {
+                throw new Error(`Unexpected error accrued during dataSources.xml config creation\n\n${e}`);
+            }
+        }
+    }
+});
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const setupDatabaseConfig = () => ({
+    title: 'Set up database configuration',
+    task: (ctx, task) => task.newListr([
+        setupDataSourceLocalConfig(),
+        setupDataSourceConfig()
+    ])
+});
+
+module.exports = setupDatabaseConfig;

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

@@ -0,0 +1,85 @@
+const path = require('path');
+const { loadXmlFile, buildXmlFile } = require('../../../config/xml-parser');
+const pathExists = require('../../../util/path-exists');
+const { valueKey, nameKey } = require('./keys');
+const { getCSAThemes } = require('../../../util/CSA-theme');
+const { formatPathForPHPStormConfig } = require('./xml-utils');
+
+const ESLINT_COMPONENT_NAME = 'EslintConfiguration';
+
+const pathToESLintConfig = path.join(process.cwd(), '.idea', 'jsLinters', 'eslint.xml');
+
+const defaultESLintComponentConfiguration = {
+    [nameKey]: ESLINT_COMPONENT_NAME,
+    option: {
+        [nameKey]: 'fix-on-save',
+        [valueKey]: 'true'
+    }
+};
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const setupESLintConfig = () => ({
+    title: 'Set up ESLint configuration',
+    task: async (ctx, task) => {
+        if (await pathExists(pathToESLintConfig)) {
+            let hasChanges = false;
+            const esLintConfigurationData = await loadXmlFile(pathToESLintConfig);
+
+            if (esLintConfigurationData.project.component && !Array.isArray(esLintConfigurationData.project.component)) {
+                hasChanges = true;
+                esLintConfigurationData.project.component = [esLintConfigurationData.project.component];
+            }
+
+            const esLintConfigurationComponent = esLintConfigurationData.project.component.find(
+                (config) => config[nameKey] === ESLINT_COMPONENT_NAME
+            );
+
+            if (!esLintConfigurationComponent) {
+                hasChanges = true;
+                esLintConfigurationData.project.component.push(defaultESLintComponentConfiguration);
+            }
+
+            if (hasChanges) {
+                await buildXmlFile(pathToESLintConfig, esLintConfigurationData);
+            } else {
+                task.skip();
+            }
+
+            return;
+        }
+
+        const styleLintConfigurationData = {
+            '?xml': {
+                '@_version': '1.0',
+                '@_encoding': 'UTF-8'
+            },
+            project: {
+                '@_version': '4',
+                component: defaultESLintComponentConfiguration
+            }
+        };
+        const themes = await getCSAThemes();
+
+        if (themes.length > 0) {
+            const theme = themes[0];
+            if (await pathExists(theme.themePath)) {
+                styleLintConfigurationData.project.component['work-dir-pattern'] = {
+                    [valueKey]: formatPathForPHPStormConfig(theme.themePath)
+                };
+                const packageJsonPath = path.join(theme.themePath, 'package.json');
+                if (await pathExists(packageJsonPath)) {
+                    styleLintConfigurationData.project.component['custom-configuration-file'] = {
+                        '@_used': 'true',
+                        '@_path': formatPathForPHPStormConfig(packageJsonPath)
+                    };
+                }
+            }
+        }
+
+        await buildXmlFile(pathToESLintConfig, styleLintConfigurationData);
+    }
+});
+
+module.exports = setupESLintConfig;