@scandipwa/magento-scripts 1.14.1-alpha.1 → 1.14.1-alpha.10

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

@@ -1,66 +0,0 @@
-const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser');
-const pathExists = require('../../../../util/path-exists');
-const setupComposerSettings = require('./composer-settings-config');
-const setupFormatOnSave = require('./format-setting-config');
-const setupPHPDebugGeneral = require('./php-debug-general-config');
-const setupPHPServers = require('./php-server-config');
-const setupPropertiesComponent = require('./properties-component-config');
-const setupRunManager = require('./run-manager-config');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
- */
-const setupWorkspaceConfig = () => ({
-    title: 'Set up Workspace configuration',
-    task: async (ctx, task) => {
-        const {
-            config: {
-                phpStorm
-            }
-        } = ctx;
-
-        if (await pathExists(phpStorm.xdebug.path)) {
-            const workspaceConfiguration = await loadXmlFile(phpStorm.xdebug.path);
-            const workspaceConfigs = workspaceConfiguration.project.component;
-            const hasChanges = await Promise.all([
-                setupPHPDebugGeneral(workspaceConfigs, phpStorm),
-                setupPHPServers(workspaceConfigs, phpStorm),
-                setupRunManager(workspaceConfigs, phpStorm),
-                setupPropertiesComponent(workspaceConfigs)
-            ]);
-
-            if (hasChanges.includes(true)) {
-                await buildXmlFile(phpStorm.php.path, workspaceConfiguration);
-            } else {
-                task.skip();
-            }
-
-            return;
-        }
-
-        const workspaceConfiguration = {
-            '?xml': {
-                '@_version': '1.0',
-                '@_encoding': 'UTF-8'
-            },
-            project: {
-                '@_version': '4',
-                component: []
-            }
-        };
-        const workspaceConfigs = workspaceConfiguration.project.component;
-
-        await Promise.all([
-            setupPHPDebugGeneral(workspaceConfigs, phpStorm),
-            setupPHPServers(workspaceConfigs, phpStorm),
-            setupRunManager(workspaceConfigs, phpStorm),
-            setupPropertiesComponent(workspaceConfigs),
-            setupComposerSettings(workspaceConfigs),
-            setupFormatOnSave(workspaceConfigs)
-        ]);
-
-        await buildXmlFile(phpStorm.xdebug.path, workspaceConfiguration);
-    }
-});
-
-module.exports = setupWorkspaceConfig;

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-debug-general-config.js

@@ -1,64 +0,0 @@
-const {
-    nameKey
-} = require('../keys');
-
-const PHP_DEBUG_GENERAL_COMPONENT_NAME = 'PhpDebugGeneral';
-
-const portKey = '@_port';
-const xdebugDebugPortKey = '@_xdebug_debug_port';
-const ignoreConnectionsThroughUnregisteredServersKey = '@_ignore_connections_through_unregistered_servers';
-
-/**
- * @param {Array} workspaceConfigs
- * @param {import('../../../../../typings/phpstorm').PHPStormConfig} phpStormConfiguration
- * @returns {Promise<Boolean>}
- */
-const setupPHPDebugGeneral = async (workspaceConfigs, phpStormConfiguration) => {
-    const { xdebug } = phpStormConfiguration;
-    let hasChanges = false;
-    const phpDebugGeneralComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === PHP_DEBUG_GENERAL_COMPONENT_NAME
-    );
-
-    if (phpDebugGeneralComponent) {
-        if (phpDebugGeneralComponent.xdebug_debug_ports && !Array.isArray(phpDebugGeneralComponent.xdebug_debug_ports)) {
-            hasChanges = true;
-            phpDebugGeneralComponent.xdebug_debug_ports = [phpDebugGeneralComponent.xdebug_debug_ports];
-        } else if (!phpDebugGeneralComponent.xdebug_debug_ports) {
-            hasChanges = true;
-            phpDebugGeneralComponent.xdebug_debug_ports = [];
-        }
-
-        if (!(xdebugDebugPortKey in phpDebugGeneralComponent)) {
-            hasChanges = true;
-            phpDebugGeneralComponent[xdebugDebugPortKey] = xdebug.v3Port;
-        }
-
-        const missingXDebugPorts = [xdebug.v3Port, xdebug.v2Port].filter(
-            (port) => !phpDebugGeneralComponent.xdebug_debug_ports.some((xPort) => xPort[portKey] === port)
-        );
-
-        if (missingXDebugPorts.length > 0) {
-            hasChanges = true;
-            missingXDebugPorts.forEach((port) => {
-                phpDebugGeneralComponent.xdebug_debug_ports.push({
-                    [portKey]: port
-                });
-            });
-        }
-    } else {
-        hasChanges = true;
-        workspaceConfigs.push({
-            [nameKey]: PHP_DEBUG_GENERAL_COMPONENT_NAME,
-            [xdebugDebugPortKey]: xdebug.v3Port,
-            [ignoreConnectionsThroughUnregisteredServersKey]: 'true',
-            xdebug_debug_ports: [xdebug.v3Port, xdebug.v2Port].map((port) => ({
-                [portKey]: port
-            }))
-        });
-    }
-
-    return hasChanges;
-};
-
-module.exports = setupPHPDebugGeneral;

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-server-config.js

@@ -1,60 +0,0 @@
-const { nameKey } = require('../keys');
-
-const PHP_SERVERS_COMPONENT_NAME = 'PhpServers';
-
-const hostKey = '@_host';
-
-/**
- * @param {Array} workspaceConfigs
- * @param {import('../../../../../typings/phpstorm').PHPStormConfig} phpStormConfiguration
- * @returns {Promise<Boolean>}
- */
-const setupPHPServers = async (workspaceConfigs, phpStormConfiguration) => {
-    const { xdebug } = phpStormConfiguration;
-    let hasChanges = false;
-    const phpServersComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === PHP_SERVERS_COMPONENT_NAME
-    );
-
-    const defaultServerConfig = {
-        [hostKey]: xdebug.debugServerAddress,
-        id: '7e16e907-9ce3-4559-9d26-a30a5650d11f',
-        [nameKey]: xdebug.serverName
-    };
-
-    if (phpServersComponent) {
-        if (phpServersComponent.servers && !Array.isArray(phpServersComponent.servers)) {
-            hasChanges = true;
-            phpServersComponent.servers = [phpServersComponent.servers];
-        } else if (!phpServersComponent.servers) {
-            hasChanges = true;
-            phpServersComponent.servers = [];
-        }
-
-        const serverConfiguration = phpServersComponent.servers.find((server) => server.server[nameKey] === xdebug.serverName);
-
-        if (serverConfiguration && serverConfiguration.server[hostKey] !== xdebug.debugServerAddress) {
-            hasChanges = true;
-            serverConfiguration.server[hostKey] = xdebug.debugServerAddress;
-        } else if (!serverConfiguration) {
-            hasChanges = true;
-            phpServersComponent.servers.push({
-                server: defaultServerConfig
-            });
-        }
-    } else {
-        hasChanges = true;
-        workspaceConfigs.push({
-            [nameKey]: PHP_SERVERS_COMPONENT_NAME,
-            servers: [
-                {
-                    server: defaultServerConfig
-                }
-            ]
-        });
-    }
-
-    return hasChanges;
-};
-
-module.exports = setupPHPServers;

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/properties-component-config.js

@@ -1,51 +0,0 @@
-const path = require('path');
-// const { baseConfig } = require('../../../../config');
-const { getCSAThemes } = require('../../../../util/CSA-theme');
-const pathExists = require('../../../../util/path-exists');
-const { nameKey } = require('../keys');
-// const { formatPathForPHPStormConfig } = require('../xml-utils');
-
-const PROPERTIES_COMPONENT_NAME = 'PropertiesComponent';
-
-const defaultProperties = {
-    keyToString: {
-        'RunOnceActivity.OpenProjectViewOnStart': 'true',
-        'RunOnceActivity.ShowReadmeOnStart': 'true'
-    }
-};
-
-/**
- * @param {Array} workspaceConfigs
- * @returns {Promise<Boolean>}
- */
-const setupPropertiesComponent = async (workspaceConfigs) => {
-    let hasChanges = false;
-    const propertiesComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === PROPERTIES_COMPONENT_NAME
-    );
-
-    if (propertiesComponent) {
-        // check later
-    } else {
-        hasChanges = true;
-        const themes = await getCSAThemes();
-        if (themes.length > 0) {
-            const theme = themes[0];
-            const themeESLintPath = path.join(process.cwd(), theme.themePath, 'node_modules', 'eslint');
-            if (await pathExists(themeESLintPath)) {
-                defaultProperties.keyToString['node.js.selected.package.eslint'] = themeESLintPath;
-                defaultProperties.keyToString['js.linters.configure.manually.selectedeslint'] = 'true';
-                defaultProperties.keyToString['node.js.detected.package.eslint'] = 'true';
-                defaultProperties.keyToString['settings.editor.selected.configurable'] = 'settings.javascript.linters.eslint';
-            }
-        }
-        workspaceConfigs.push({
-            [nameKey]: PROPERTIES_COMPONENT_NAME,
-            '#text': JSON.stringify(defaultProperties)
-        });
-    }
-
-    return hasChanges;
-};
-
-module.exports = setupPropertiesComponent;

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/run-manager-config.js

@@ -1,74 +0,0 @@
-const { nameKey } = require('../keys');
-
-const RUN_MANAGER_COMPONENT_NAME = 'RunManager';
-
-const PHP_REMOTE_DEBUG_RUN_CONFIGURATION_TYPE = 'PhpRemoteDebugRunConfigurationType';
-
-const serverNameKey = '@_server_name';
-const sessionIdKey = '@_session_id';
-
-/**
- * @param {Array} workspaceConfigs
- * @param {import('../../../../../typings/phpstorm').PHPStormConfig} phpStormConfiguration
- * @returns {Promise<Boolean>}
- */
-const setupRunManager = async (workspaceConfigs, phpStormConfiguration) => {
-    const { xdebug } = phpStormConfiguration;
-    let hasChanges = false;
-    const runManagerComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === RUN_MANAGER_COMPONENT_NAME
-    );
-
-    const defaultRunManagerConfiguration = {
-        [nameKey]: xdebug.runManagerName,
-        '@_type': PHP_REMOTE_DEBUG_RUN_CONFIGURATION_TYPE,
-        '@_factoryName': 'PHP Remote Debug',
-        '@_filter_connections': 'FILTER',
-        [serverNameKey]: xdebug.serverName,
-        [sessionIdKey]: xdebug.sessionId,
-        method: {
-            '@_v': '2'
-        }
-    };
-
-    if (runManagerComponent) {
-        if (runManagerComponent.configuration && !Array.isArray(runManagerComponent.configuration)) {
-            hasChanges = true;
-            runManagerComponent.configuration = [runManagerComponent.configuration];
-        } else if (!runManagerComponent.configuration) {
-            hasChanges = true;
-            runManagerComponent.configuration = [];
-        }
-
-        const phpRemoteDebugRunConfiguration = runManagerComponent.configuration.find(
-            (configuration) => configuration['@_type'] === PHP_REMOTE_DEBUG_RUN_CONFIGURATION_TYPE && configuration[nameKey] === xdebug.runManagerName
-        );
-
-        if (phpRemoteDebugRunConfiguration) {
-            if (phpRemoteDebugRunConfiguration[serverNameKey] !== xdebug.serverName) {
-                hasChanges = true;
-                phpRemoteDebugRunConfiguration[serverNameKey] = xdebug.serverName;
-            }
-
-            if (phpRemoteDebugRunConfiguration[sessionIdKey] !== xdebug.sessionId) {
-                hasChanges = true;
-                phpRemoteDebugRunConfiguration[sessionIdKey] = xdebug.sessionId;
-            }
-        } else {
-            hasChanges = true;
-            runManagerComponent.configuration.push(defaultRunManagerConfiguration);
-        }
-    } else {
-        hasChanges = true;
-        workspaceConfigs.push({
-            [nameKey]: RUN_MANAGER_COMPONENT_NAME,
-            configuration: [
-                defaultRunManagerConfiguration
-            ]
-        });
-    }
-
-    return hasChanges;
-};
-
-module.exports = setupRunManager;

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

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

package/lib/tasks/magento/setup-magento/adjust-magento-configuration.js

@@ -1,27 +0,0 @@
-const { isTableExists } = require('../../../util/database');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const adjustMagentoConfiguration = () => ({
-    title: 'Adjusting Magento Database Configuration',
-    skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
-    task: async (ctx) => {
-        const { mysqlConnection } = ctx;
-
-        // delete varnish configuration if exists
-        await mysqlConnection.query(`
-            DELETE FROM core_config_data WHERE path LIKE '%varnish%';
-        `);
-
-        // update cache policy to not use varnish
-        // 0 - magento cache, 2 - varnish cache
-        await mysqlConnection.query(`
-            UPDATE core_config_data
-            SET value = ?
-            WHERE path = ?;
-        `, ['0', 'system/full_page_cache/caching_application']);
-    }
-});
-
-module.exports = adjustMagentoConfiguration;

package/lib/tasks/magento/setup-magento/disable-page-cache.js

@@ -1,11 +0,0 @@
-const magentoTask = require('../../../util/magento-task');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const disablePageCache = () => ({
-    title: 'Disabling full_page cache in Magento',
-    task: (ctx, task) => task.newListr(magentoTask('cache:disable full_page'))
-});
-
-module.exports = disablePageCache;

package/typings/phpstorm.d.ts

@@ -1,33 +0,0 @@
-export interface PHPStormConfig {
-    xdebug: {
-        v2Port: string;
-        v3Port: string;
-        debugServerAddress: string;
-        serverName: string;
-        runManagerName: string;
-        sessionId: string;
-        path: string;
-        templatePath: string;
-    }
-    php: {
-        phpLanguageLevel: string;
-        path: string;
-        templatePath: string;
-    }
-    database: {
-        driver: string;
-        dataSourceManagerName: string;
-        dataSourcesLocal: {
-            path: string;
-            templatePath: string;
-        }
-        dataSources: {
-            path: string;
-            templatePath: string;
-        }
-    }
-    inspectionTools: {
-        path: string;
-        templatePath: string;
-    }
-}