@scandipwa/magento-scripts 2.0.3 → 2.0.5

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

@@ -1,21 +1,21 @@
-const path = require('path');
-const pathExists = require('../../../../util/path-exists');
-const { nameKey } = require('../keys');
-const { formatPathForPHPStormConfig } = require('../xml-utils');
+const path = require('path')
+const pathExists = require('../../../../util/path-exists')
+const { nameKey } = require('../keys')
+const { formatPathForPHPStormConfig } = require('../xml-utils')
 
-const COMPOSER_SETTINGS_COMPONENT_NAME = 'ComposerSettings';
+const COMPOSER_SETTINGS_COMPONENT_NAME = 'ComposerSettings'
 
-const composerKey = '@_composer';
-const doNotAskKey = '@_doNotAsk';
-const synchronizationStateKey = '@_synchronizationState';
+const composerKey = '@_composer'
+const doNotAskKey = '@_doNotAsk'
+const synchronizationStateKey = '@_synchronizationState'
 
-const composerJsonPath = path.join(process.cwd(), 'composer.json');
-const composerJsonFormattedPath = formatPathForPHPStormConfig(composerJsonPath);
+const composerJsonPath = path.join(process.cwd(), 'composer.json')
+const composerJsonFormattedPath = formatPathForPHPStormConfig(composerJsonPath)
 
 const defaultComposerSettingsProperties = {
     [doNotAskKey]: 'true',
     [synchronizationStateKey]: 'SYNCHRONIZE'
-};
+}
 
 /**
  * @param {Array} workspaceConfigs
@@ -23,39 +23,47 @@ const defaultComposerSettingsProperties = {
  * @returns {Promise<Boolean>}
  */
 const setupComposerSettings = async (workspaceConfigs, ctx) => {
-    let hasChanges = false;
+    let hasChanges = false
     const composerSettingsComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === COMPOSER_SETTINGS_COMPONENT_NAME
-    );
+        (workspaceConfig) =>
+            workspaceConfig[nameKey] === COMPOSER_SETTINGS_COMPONENT_NAME
+    )
 
-    const isComposerJsonExists = await pathExists(composerJsonPath);
-    const { php } = ctx.config.docker.getContainers(ctx.ports);
+    const isComposerJsonExists = await pathExists(composerJsonPath)
+    const { php } = ctx.config.docker.getContainers(ctx.ports)
     const defaultInterpreterConfig = {
         [nameKey]: ctx.debug ? php.debugImage : php.image,
         [composerKey]: 'composer'
-    };
+    }
 
     if (composerSettingsComponent) {
         if (
-            composerSettingsComponent.pharConfigPath === undefined
-            && isComposerJsonExists
+            composerSettingsComponent.pharConfigPath === undefined &&
+            isComposerJsonExists
         ) {
-            hasChanges = true;
-            composerSettingsComponent.pharConfigPath = composerJsonFormattedPath;
+            hasChanges = true
+            composerSettingsComponent.pharConfigPath = composerJsonFormattedPath
         }
 
-        const interpreterConfig = composerSettingsComponent.execution && composerSettingsComponent.execution.interpreter;
+        const interpreterConfig =
+            composerSettingsComponent.execution &&
+            composerSettingsComponent.execution.interpreter
 
         if (!interpreterConfig) {
-            hasChanges = true;
-            composerSettingsComponent.execution = composerSettingsComponent.execution || {};
-            composerSettingsComponent.execution.interpreter = defaultInterpreterConfig;
-        } else if (interpreterConfig[nameKey] !== defaultInterpreterConfig[nameKey]) {
-            hasChanges = true;
-            composerSettingsComponent.execution.interpreter[nameKey] = defaultInterpreterConfig[nameKey];
+            hasChanges = true
+            composerSettingsComponent.execution =
+                composerSettingsComponent.execution || {}
+            composerSettingsComponent.execution.interpreter =
+                defaultInterpreterConfig
+        } else if (
+            interpreterConfig[nameKey] !== defaultInterpreterConfig[nameKey]
+        ) {
+            hasChanges = true
+            composerSettingsComponent.execution.interpreter[nameKey] =
+                defaultInterpreterConfig[nameKey]
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         workspaceConfigs.push({
             [nameKey]: COMPOSER_SETTINGS_COMPONENT_NAME,
             ...defaultComposerSettingsProperties,
@@ -63,10 +71,10 @@ const setupComposerSettings = async (workspaceConfigs, ctx) => {
             execution: {
                 interpreter: defaultInterpreterConfig
             }
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupComposerSettings;
+module.exports = setupComposerSettings

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

@@ -1,57 +1,69 @@
-const {
-    nameKey,
-    valueKey
-} = require('../keys');
+const { nameKey, valueKey } = require('../keys')
 
-const FORMAT_ON_SAVE_OPTIONS_COMPONENT_NAME = 'FormatOnSaveOptions';
+const FORMAT_ON_SAVE_OPTIONS_COMPONENT_NAME = 'FormatOnSaveOptions'
 
-const MY_FORMAT_ONLY_CHANGED_LINES_OPTION_NAME = 'myFormatOnlyChangedLines';
-const MY_RUN_ON_SAVE_OPTION_NAME = 'myRunOnSave';
+const MY_FORMAT_ONLY_CHANGED_LINES_OPTION_NAME = 'myFormatOnlyChangedLines'
+const MY_RUN_ON_SAVE_OPTION_NAME = 'myRunOnSave'
 
 /**
  * @param {Array} workspaceConfigs
  * @returns {Promise<Boolean>}
  */
 const setupFormatOnSave = async (workspaceConfigs) => {
-    let hasChanges = false;
+    let hasChanges = false
     const formatOnSaveOptionsComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === FORMAT_ON_SAVE_OPTIONS_COMPONENT_NAME
-    );
+        (workspaceConfig) =>
+            workspaceConfig[nameKey] === FORMAT_ON_SAVE_OPTIONS_COMPONENT_NAME
+    )
 
     if (formatOnSaveOptionsComponent) {
-        if (formatOnSaveOptionsComponent.option && !Array.isArray(formatOnSaveOptionsComponent.option)) {
-            hasChanges = true;
-            formatOnSaveOptionsComponent.option = [formatOnSaveOptionsComponent.option];
+        if (
+            formatOnSaveOptionsComponent.option &&
+            !Array.isArray(formatOnSaveOptionsComponent.option)
+        ) {
+            hasChanges = true
+            formatOnSaveOptionsComponent.option = [
+                formatOnSaveOptionsComponent.option
+            ]
         } else if (!formatOnSaveOptionsComponent.option) {
-            hasChanges = true;
-            formatOnSaveOptionsComponent.option = [];
+            hasChanges = true
+            formatOnSaveOptionsComponent.option = []
         }
 
-        const missingOptions = [MY_FORMAT_ONLY_CHANGED_LINES_OPTION_NAME, MY_RUN_ON_SAVE_OPTION_NAME].filter(
-            (optionName) => !formatOnSaveOptionsComponent.option.some((option) => option[nameKey] === optionName)
-        );
+        const missingOptions = [
+            MY_FORMAT_ONLY_CHANGED_LINES_OPTION_NAME,
+            MY_RUN_ON_SAVE_OPTION_NAME
+        ].filter(
+            (optionName) =>
+                !formatOnSaveOptionsComponent.option.some(
+                    (option) => option[nameKey] === optionName
+                )
+        )
 
         if (missingOptions.length > 0) {
-            hasChanges = true;
+            hasChanges = true
             missingOptions.forEach((missingOption) => {
                 formatOnSaveOptionsComponent.option.push({
                     [nameKey]: missingOption,
                     [valueKey]: 'true'
-                });
-            });
+                })
+            })
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         workspaceConfigs.push({
             [nameKey]: FORMAT_ON_SAVE_OPTIONS_COMPONENT_NAME,
-            option: [MY_FORMAT_ONLY_CHANGED_LINES_OPTION_NAME, MY_RUN_ON_SAVE_OPTION_NAME].map((option) => ({
+            option: [
+                MY_FORMAT_ONLY_CHANGED_LINES_OPTION_NAME,
+                MY_RUN_ON_SAVE_OPTION_NAME
+            ].map((option) => ({
                 [nameKey]: option,
                 [valueKey]: 'true'
             }))
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupFormatOnSave;
+module.exports = setupFormatOnSave

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

@@ -1,30 +1,34 @@
-const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser');
-const pathExists = require('../../../../util/path-exists');
-const { setupXMLStructure } = require('../setup-xml-structure');
-const setupComposerSettings = require('./composer-settings-config');
-const setupFormatOnSave = require('./format-setting-config');
-const setupMessDetectorProjectConfiguration = require('./mess-detector-project-configuration-config');
-const setupPHPCodeSnifferProjectConfiguration = require('./php-code-sniffer-project-configuration-config');
-const setupPHPCSFixerProjectConfiguration = require('./php-cs-fixer-project-configuration-config');
-const setupPHPDebugGeneral = require('./php-debug-general-config');
-const setupPHPServers = require('./php-server-config');
-const setupPHPStanProjectConfiguration = require('./php-stan-project-configuration-config.js');
-const setupPHPWorkspaceProjectConfiguration = require('./php-workspace-project-configuration-config');
-const setupPropertiesComponent = require('./properties-component-config');
-const setupPSalmProjectConfiguration = require('./psalm-project-configuration-config.js');
-const setupRunManager = require('./run-manager-config');
-const { getWorkspaceConfig } = require('./workspace-config');
+const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser')
+const pathExists = require('../../../../util/path-exists')
+const { setupXMLStructure } = require('../setup-xml-structure')
+const setupComposerSettings = require('./composer-settings-config')
+const setupFormatOnSave = require('./format-setting-config')
+const setupMessDetectorProjectConfiguration = require('./mess-detector-project-configuration-config')
+const setupPHPCodeSnifferProjectConfiguration = require('./php-code-sniffer-project-configuration-config')
+const setupPHPCSFixerProjectConfiguration = require('./php-cs-fixer-project-configuration-config')
+const setupPHPDebugGeneral = require('./php-debug-general-config')
+const setupPHPServers = require('./php-server-config')
+const setupPHPStanProjectConfiguration = require('./php-stan-project-configuration-config.js')
+const setupPHPWorkspaceProjectConfiguration = require('./php-workspace-project-configuration-config')
+const setupPropertiesComponent = require('./properties-component-config')
+const setupPSalmProjectConfiguration = require('./psalm-project-configuration-config.js')
+const setupRunManager = require('./run-manager-config')
+const { getWorkspaceConfig } = require('./workspace-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
  */
 const setupWorkspaceConfig = () => ({
     title: 'Set up Workspace configuration',
     task: async (ctx, task) => {
-        const workspaceConfig = getWorkspaceConfig(ctx.config.overridenConfiguration);
+        const workspaceConfig = getWorkspaceConfig(
+            ctx.config.overridenConfiguration
+        )
         if (await pathExists(workspaceConfig.path)) {
-            const workspaceConfiguration = setupXMLStructure(await loadXmlFile(workspaceConfig.path));
-            const workspaceConfigs = workspaceConfiguration.project.component;
+            const workspaceConfiguration = setupXMLStructure(
+                await loadXmlFile(workspaceConfig.path)
+            )
+            const workspaceConfigs = workspaceConfiguration.project.component
             const hasChanges = await Promise.all([
                 setupMessDetectorProjectConfiguration(workspaceConfigs),
                 setupPHPCSFixerProjectConfiguration(workspaceConfigs),
@@ -37,19 +41,19 @@ const setupWorkspaceConfig = () => ({
                 setupComposerSettings(workspaceConfigs, ctx),
                 setupRunManager(workspaceConfigs, workspaceConfig),
                 setupPropertiesComponent(workspaceConfigs)
-            ]);
+            ])
 
             if (hasChanges.includes(true)) {
-                await buildXmlFile(workspaceConfig.path, workspaceConfiguration);
+                await buildXmlFile(workspaceConfig.path, workspaceConfiguration)
             } else {
-                task.skip();
+                task.skip()
             }
 
-            return;
+            return
         }
 
-        const workspaceConfiguration = setupXMLStructure();
-        const workspaceConfigs = workspaceConfiguration.project.component;
+        const workspaceConfiguration = setupXMLStructure()
+        const workspaceConfigs = workspaceConfiguration.project.component
 
         await Promise.all([
             setupMessDetectorProjectConfiguration(workspaceConfigs),
@@ -64,10 +68,10 @@ const setupWorkspaceConfig = () => ({
             setupPropertiesComponent(workspaceConfigs),
             setupComposerSettings(workspaceConfigs, ctx),
             setupFormatOnSave(workspaceConfigs)
-        ]);
+        ])
 
-        await buildXmlFile(workspaceConfig.path, workspaceConfiguration);
+        await buildXmlFile(workspaceConfig.path, workspaceConfiguration)
     }
-});
+})
 
-module.exports = setupWorkspaceConfig;
+module.exports = setupWorkspaceConfig

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/mess-detector-project-configuration-config.js

@@ -1,50 +1,60 @@
-const { nameKey, valueKey } = require('../keys');
+const { nameKey, valueKey } = require('../keys')
 
-const MESS_DETECTOR_PROJECT_CONFIGURATION_COMPONENT_NAME = 'MessDetectorProjectConfiguration';
+const MESS_DETECTOR_PROJECT_CONFIGURATION_COMPONENT_NAME =
+    'MessDetectorProjectConfiguration'
 
-const selectedConfigurationIdName = 'selectedConfigurationId';
-const value = 'DEFAULT_INTERPRETER';
+const selectedConfigurationIdName = 'selectedConfigurationId'
+const value = 'DEFAULT_INTERPRETER'
 
 const defaultOption = {
     [nameKey]: selectedConfigurationIdName,
     [valueKey]: value
-};
+}
 
 /**
  * @param {Array} workspaceConfigs
  * @returns {Promise<Boolean>}
  */
 const setupMessDetectorProjectConfiguration = async (workspaceConfigs) => {
-    let hasChanges = false;
+    let hasChanges = false
     const messDetectorProjectConfigurationComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === MESS_DETECTOR_PROJECT_CONFIGURATION_COMPONENT_NAME
-    );
+        (workspaceConfig) =>
+            workspaceConfig[nameKey] ===
+            MESS_DETECTOR_PROJECT_CONFIGURATION_COMPONENT_NAME
+    )
 
     if (messDetectorProjectConfigurationComponent) {
-        if (messDetectorProjectConfigurationComponent.option && !Array.isArray(messDetectorProjectConfigurationComponent.option)) {
-            hasChanges = true;
-            messDetectorProjectConfigurationComponent.option = [messDetectorProjectConfigurationComponent.option];
+        if (
+            messDetectorProjectConfigurationComponent.option &&
+            !Array.isArray(messDetectorProjectConfigurationComponent.option)
+        ) {
+            hasChanges = true
+            messDetectorProjectConfigurationComponent.option = [
+                messDetectorProjectConfigurationComponent.option
+            ]
         } else if (!messDetectorProjectConfigurationComponent.option) {
-            hasChanges = true;
-            messDetectorProjectConfigurationComponent.option = [];
+            hasChanges = true
+            messDetectorProjectConfigurationComponent.option = []
         }
 
         if (
-            messDetectorProjectConfigurationComponent.option.length > 0
-            && !messDetectorProjectConfigurationComponent.option.some((option) => option[nameKey] === selectedConfigurationIdName)
+            messDetectorProjectConfigurationComponent.option.length > 0 &&
+            !messDetectorProjectConfigurationComponent.option.some(
+                (option) => option[nameKey] === selectedConfigurationIdName
+            )
         ) {
-            messDetectorProjectConfigurationComponent.option = [defaultOption];
-            hasChanges = true;
+            messDetectorProjectConfigurationComponent.option = [defaultOption]
+            hasChanges = true
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         workspaceConfigs.push({
             [nameKey]: MESS_DETECTOR_PROJECT_CONFIGURATION_COMPONENT_NAME,
             option: [defaultOption]
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupMessDetectorProjectConfiguration;
+module.exports = setupMessDetectorProjectConfiguration

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-code-sniffer-project-configuration-config.js

@@ -1,50 +1,60 @@
-const { nameKey, valueKey } = require('../keys');
+const { nameKey, valueKey } = require('../keys')
 
-const PHP_CODE_SNIFFER_PROJECT_CONFIGURATION_COMPONENT_NAME = 'PHPCodeSnifferProjectConfiguration';
+const PHP_CODE_SNIFFER_PROJECT_CONFIGURATION_COMPONENT_NAME =
+    'PHPCodeSnifferProjectConfiguration'
 
-const selectedConfigurationIdName = 'selectedConfigurationId';
-const value = 'DEFAULT_INTERPRETER';
+const selectedConfigurationIdName = 'selectedConfigurationId'
+const value = 'DEFAULT_INTERPRETER'
 
 const defaultOption = {
     [nameKey]: selectedConfigurationIdName,
     [valueKey]: value
-};
+}
 
 /**
  * @param {Array} workspaceConfigs
  * @returns {Promise<Boolean>}
  */
 const setupPHPCodeSnifferProjectConfiguration = async (workspaceConfigs) => {
-    let hasChanges = false;
+    let hasChanges = false
     const phpCodeSnifferProjectConfigurationComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === PHP_CODE_SNIFFER_PROJECT_CONFIGURATION_COMPONENT_NAME
-    );
+        (workspaceConfig) =>
+            workspaceConfig[nameKey] ===
+            PHP_CODE_SNIFFER_PROJECT_CONFIGURATION_COMPONENT_NAME
+    )
 
     if (phpCodeSnifferProjectConfigurationComponent) {
-        if (phpCodeSnifferProjectConfigurationComponent.option && !Array.isArray(phpCodeSnifferProjectConfigurationComponent.option)) {
-            hasChanges = true;
-            phpCodeSnifferProjectConfigurationComponent.option = [phpCodeSnifferProjectConfigurationComponent.option];
+        if (
+            phpCodeSnifferProjectConfigurationComponent.option &&
+            !Array.isArray(phpCodeSnifferProjectConfigurationComponent.option)
+        ) {
+            hasChanges = true
+            phpCodeSnifferProjectConfigurationComponent.option = [
+                phpCodeSnifferProjectConfigurationComponent.option
+            ]
         } else if (!phpCodeSnifferProjectConfigurationComponent.option) {
-            hasChanges = true;
-            phpCodeSnifferProjectConfigurationComponent.option = [];
+            hasChanges = true
+            phpCodeSnifferProjectConfigurationComponent.option = []
         }
 
         if (
-            phpCodeSnifferProjectConfigurationComponent.option.length > 0
-            && !phpCodeSnifferProjectConfigurationComponent.option.some((option) => option[nameKey] === selectedConfigurationIdName)
+            phpCodeSnifferProjectConfigurationComponent.option.length > 0 &&
+            !phpCodeSnifferProjectConfigurationComponent.option.some(
+                (option) => option[nameKey] === selectedConfigurationIdName
+            )
         ) {
-            phpCodeSnifferProjectConfigurationComponent.option = [defaultOption];
-            hasChanges = true;
+            phpCodeSnifferProjectConfigurationComponent.option = [defaultOption]
+            hasChanges = true
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         workspaceConfigs.push({
             [nameKey]: PHP_CODE_SNIFFER_PROJECT_CONFIGURATION_COMPONENT_NAME,
             option: [defaultOption]
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupPHPCodeSnifferProjectConfiguration;
+module.exports = setupPHPCodeSnifferProjectConfiguration

package/lib/tasks/file-system/create-phpstorm-config/workspace-config/php-cs-fixer-project-configuration-config.js

@@ -1,50 +1,60 @@
-const { nameKey, valueKey } = require('../keys');
+const { nameKey, valueKey } = require('../keys')
 
-const PHP_CS_FIXER_PROJECT_CONFIGURATION_COMPONENT_NAME = 'PHPCSFixerProjectConfiguration';
+const PHP_CS_FIXER_PROJECT_CONFIGURATION_COMPONENT_NAME =
+    'PHPCSFixerProjectConfiguration'
 
-const selectedConfigurationIdName = 'selectedConfigurationId';
-const value = 'DEFAULT_INTERPRETER';
+const selectedConfigurationIdName = 'selectedConfigurationId'
+const value = 'DEFAULT_INTERPRETER'
 
 const defaultOption = {
     [nameKey]: selectedConfigurationIdName,
     [valueKey]: value
-};
+}
 
 /**
  * @param {Array} workspaceConfigs
  * @returns {Promise<Boolean>}
  */
 const setupPHPCSFixerProjectConfiguration = async (workspaceConfigs) => {
-    let hasChanges = false;
+    let hasChanges = false
     const phpCSFixeProjectConfigurationComponent = workspaceConfigs.find(
-        (workspaceConfig) => workspaceConfig[nameKey] === PHP_CS_FIXER_PROJECT_CONFIGURATION_COMPONENT_NAME
-    );
+        (workspaceConfig) =>
+            workspaceConfig[nameKey] ===
+            PHP_CS_FIXER_PROJECT_CONFIGURATION_COMPONENT_NAME
+    )
 
     if (phpCSFixeProjectConfigurationComponent) {
-        if (phpCSFixeProjectConfigurationComponent.option && !Array.isArray(phpCSFixeProjectConfigurationComponent.option)) {
-            hasChanges = true;
-            phpCSFixeProjectConfigurationComponent.option = [phpCSFixeProjectConfigurationComponent.option];
+        if (
+            phpCSFixeProjectConfigurationComponent.option &&
+            !Array.isArray(phpCSFixeProjectConfigurationComponent.option)
+        ) {
+            hasChanges = true
+            phpCSFixeProjectConfigurationComponent.option = [
+                phpCSFixeProjectConfigurationComponent.option
+            ]
         } else if (!phpCSFixeProjectConfigurationComponent.option) {
-            hasChanges = true;
-            phpCSFixeProjectConfigurationComponent.option = [];
+            hasChanges = true
+            phpCSFixeProjectConfigurationComponent.option = []
         }
 
         if (
-            phpCSFixeProjectConfigurationComponent.option.length > 0
-            && !phpCSFixeProjectConfigurationComponent.option.some((option) => option[nameKey] === selectedConfigurationIdName)
+            phpCSFixeProjectConfigurationComponent.option.length > 0 &&
+            !phpCSFixeProjectConfigurationComponent.option.some(
+                (option) => option[nameKey] === selectedConfigurationIdName
+            )
         ) {
-            phpCSFixeProjectConfigurationComponent.option = [defaultOption];
-            hasChanges = true;
+            phpCSFixeProjectConfigurationComponent.option = [defaultOption]
+            hasChanges = true
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         workspaceConfigs.push({
             [nameKey]: PHP_CS_FIXER_PROJECT_CONFIGURATION_COMPONENT_NAME,
             option: [defaultOption]
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupPHPCSFixerProjectConfiguration;
+module.exports = setupPHPCSFixerProjectConfiguration