@scandipwa/magento-scripts 2.0.3 → 2.0.5

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

@@ -1,6 +1,6 @@
-const { nameKey, propertyKey } = require('../keys');
+const { nameKey, propertyKey } = require('../keys')
 
-const PHP_INTERPRETERS_COMPONENT_NAME = 'PhpInterpreters';
+const PHP_INTERPRETERS_COMPONENT_NAME = 'PhpInterpreters'
 
 /**
  * @param {Array} phpConfigs
@@ -8,13 +8,13 @@ const PHP_INTERPRETERS_COMPONENT_NAME = 'PhpInterpreters';
  * @returns {Promise<Boolean>}
  */
 const setupPHPInterpreters = async (phpConfigs, ctx) => {
-    let hasChanges = false;
+    let hasChanges = false
     const phpInterpretersComponent = phpConfigs.find(
         (phpConfig) => phpConfig[nameKey] === PHP_INTERPRETERS_COMPONENT_NAME
-    );
+    )
 
-    const { php } = ctx.config.docker.getContainers(ctx.ports);
-    const currentInterpreterImage = ctx.debug ? php.debugImage : php.image;
+    const { php } = ctx.config.docker.getContainers(ctx.ports)
+    const currentInterpreterImage = ctx.debug ? php.debugImage : php.image
 
     const defaultPhpInterpreterConfiguration = {
         [nameKey]: currentInterpreterImage,
@@ -28,54 +28,76 @@ const setupPHPInterpreters = async (phpConfigs, ctx) => {
             [propertyKey('RUN_AS_ROOT_VIA_SUDO')]: 'false',
             [propertyKey('DOCKER_ACCOUNT_NAME')]: 'Docker',
             [propertyKey('DOCKER_IMAGE_NAME')]: currentInterpreterImage,
-            [propertyKey('DOCKER_REMOTE_PROJECT_PATH')]: ctx.config.baseConfig.containerMagentoDir
+            [propertyKey('DOCKER_REMOTE_PROJECT_PATH')]:
+                ctx.config.baseConfig.containerMagentoDir
         }
-    };
+    }
 
     if (phpInterpretersComponent) {
         if (!phpInterpretersComponent.interpreters) {
-            hasChanges = true;
-            phpInterpretersComponent.interpreters = {};
+            hasChanges = true
+            phpInterpretersComponent.interpreters = {}
         }
 
         if (!Array.isArray(phpInterpretersComponent.interpreters.interpreter)) {
-            hasChanges = true;
-            phpInterpretersComponent.interpreters.interpreter = [phpInterpretersComponent.interpreters.interpreter];
+            hasChanges = true
+            phpInterpretersComponent.interpreters.interpreter = [
+                phpInterpretersComponent.interpreters.interpreter
+            ]
         }
 
-        const phpInterpreterConfiguration = phpInterpretersComponent.interpreters.interpreter.find(
-            (interpreter) => interpreter[nameKey] === php.image || interpreter[nameKey] === php.debugImage
-        );
+        const phpInterpreterConfiguration =
+            phpInterpretersComponent.interpreters.interpreter.find(
+                (interpreter) =>
+                    interpreter[nameKey] === php.image ||
+                    interpreter[nameKey] === php.debugImage
+            )
 
         if (!phpInterpreterConfiguration) {
-            hasChanges = true;
-            phpInterpretersComponent.interpreters.interpreter.push(defaultPhpInterpreterConfiguration);
+            hasChanges = true
+            phpInterpretersComponent.interpreters.interpreter.push(
+                defaultPhpInterpreterConfiguration
+            )
         } else {
-            if (phpInterpreterConfiguration[nameKey] !== currentInterpreterImage) {
-                hasChanges = true;
-                phpInterpreterConfiguration[nameKey] = currentInterpreterImage;
+            if (
+                phpInterpreterConfiguration[nameKey] !== currentInterpreterImage
+            ) {
+                hasChanges = true
+                phpInterpreterConfiguration[nameKey] = currentInterpreterImage
             }
-            if (phpInterpreterConfiguration.remote_data[propertyKey('DOCKER_IMAGE_NAME')] !== currentInterpreterImage) {
-                hasChanges = true;
-                phpInterpreterConfiguration.remote_data[propertyKey('DOCKER_IMAGE_NAME')] = currentInterpreterImage;
+            if (
+                phpInterpreterConfiguration.remote_data[
+                    propertyKey('DOCKER_IMAGE_NAME')
+                ] !== currentInterpreterImage
+            ) {
+                hasChanges = true
+                phpInterpreterConfiguration.remote_data[
+                    propertyKey('DOCKER_IMAGE_NAME')
+                ] = currentInterpreterImage
             }
 
-            if (phpInterpreterConfiguration.remote_data[propertyKey('DOCKER_REMOTE_PROJECT_PATH')] !== ctx.config.baseConfig.containerMagentoDir) {
-                hasChanges = true;
-                phpInterpreterConfiguration.remote_data[propertyKey('DOCKER_REMOTE_PROJECT_PATH')] = ctx.config.baseConfig.containerMagentoDir;
+            if (
+                phpInterpreterConfiguration.remote_data[
+                    propertyKey('DOCKER_REMOTE_PROJECT_PATH')
+                ] !== ctx.config.baseConfig.containerMagentoDir
+            ) {
+                hasChanges = true
+                phpInterpreterConfiguration.remote_data[
+                    propertyKey('DOCKER_REMOTE_PROJECT_PATH')
+                ] = ctx.config.baseConfig.containerMagentoDir
             }
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         phpConfigs.push({
             [nameKey]: PHP_INTERPRETERS_COMPONENT_NAME,
             interpreters: {
                 interpreter: defaultPhpInterpreterConfiguration
             }
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupPHPInterpreters;
+module.exports = setupPHPInterpreters

package/lib/tasks/file-system/create-phpstorm-config/php-config/php-project-shared-configuration-config.js

@@ -1,59 +1,71 @@
-const {
-    nameKey,
-    valueKey
-} = require('../keys');
+const { nameKey, valueKey } = require('../keys')
 
-const PHP_PROJECT_SHARED_CONFIGURATION_COMPONENT_NAME = 'PhpProjectSharedConfiguration';
+const PHP_PROJECT_SHARED_CONFIGURATION_COMPONENT_NAME =
+    'PhpProjectSharedConfiguration'
 
-const SUGGESTED_CHANGE_DEFAULT_LANGUAGE_LEVEL_OPTION_NAME = 'suggestChangeDefaultLanguageLevel';
+const SUGGESTED_CHANGE_DEFAULT_LANGUAGE_LEVEL_OPTION_NAME =
+    'suggestChangeDefaultLanguageLevel'
 
-const phpLanguageLevelKey = '@_php_language_level';
+const phpLanguageLevelKey = '@_php_language_level'
 
 /**
  * @param {Array} phpConfigs
  * @param {String} currentPhpLanguageLevel
  * @returns {Promise<Boolean>}
  */
-const setupPHPProjectSharedConfiguration = async (phpConfigs, currentPhpLanguageLevel) => {
-    let hasChanges = false;
+const setupPHPProjectSharedConfiguration = async (
+    phpConfigs,
+    currentPhpLanguageLevel
+) => {
+    let hasChanges = false
     const phpProjectSharedConfigurationComponent = phpConfigs.find(
-        (phpConfig) => phpConfig[nameKey] === PHP_PROJECT_SHARED_CONFIGURATION_COMPONENT_NAME
-    );
+        (phpConfig) =>
+            phpConfig[nameKey] ===
+            PHP_PROJECT_SHARED_CONFIGURATION_COMPONENT_NAME
+    )
 
     const defaultSuggestChangeDefaultLanguageLevelOption = {
         [nameKey]: SUGGESTED_CHANGE_DEFAULT_LANGUAGE_LEVEL_OPTION_NAME,
         [valueKey]: currentPhpLanguageLevel
-    };
+    }
 
     if (phpProjectSharedConfigurationComponent) {
-        if (phpProjectSharedConfigurationComponent.option && !Array.isArray(phpProjectSharedConfigurationComponent.option)) {
-            hasChanges = true;
-            phpProjectSharedConfigurationComponent.option = [phpProjectSharedConfigurationComponent.option];
+        if (
+            phpProjectSharedConfigurationComponent.option &&
+            !Array.isArray(phpProjectSharedConfigurationComponent.option)
+        ) {
+            hasChanges = true
+            phpProjectSharedConfigurationComponent.option = [
+                phpProjectSharedConfigurationComponent.option
+            ]
         } else if (!phpProjectSharedConfigurationComponent.option) {
-            hasChanges = true;
-            phpProjectSharedConfigurationComponent.option = [];
+            hasChanges = true
+            phpProjectSharedConfigurationComponent.option = []
         }
 
-        const suggestedChangeDefaultLanguageLevelOption = phpProjectSharedConfigurationComponent.option.find(
-            (phpProjectSharedConfigOption) => phpProjectSharedConfigOption[nameKey] === SUGGESTED_CHANGE_DEFAULT_LANGUAGE_LEVEL_OPTION_NAME
-        );
+        const suggestedChangeDefaultLanguageLevelOption =
+            phpProjectSharedConfigurationComponent.option.find(
+                (phpProjectSharedConfigOption) =>
+                    phpProjectSharedConfigOption[nameKey] ===
+                    SUGGESTED_CHANGE_DEFAULT_LANGUAGE_LEVEL_OPTION_NAME
+            )
 
         if (!suggestedChangeDefaultLanguageLevelOption) {
-            hasChanges = true;
-            phpProjectSharedConfigurationComponent.option.push(defaultSuggestChangeDefaultLanguageLevelOption);
+            hasChanges = true
+            phpProjectSharedConfigurationComponent.option.push(
+                defaultSuggestChangeDefaultLanguageLevelOption
+            )
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         phpConfigs.push({
             [nameKey]: PHP_PROJECT_SHARED_CONFIGURATION_COMPONENT_NAME,
             [phpLanguageLevelKey]: currentPhpLanguageLevel,
-            option: [
-                defaultSuggestChangeDefaultLanguageLevelOption
-            ]
-        });
+            option: [defaultSuggestChangeDefaultLanguageLevelOption]
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupPHPProjectSharedConfiguration;
+module.exports = setupPHPProjectSharedConfiguration

package/lib/tasks/file-system/create-phpstorm-config/php-docker-settings-config/index.js

@@ -1,42 +1,55 @@
-const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser');
-const pathExists = require('../../../../util/path-exists');
-const { setupXMLStructure } = require('../setup-xml-structure');
-const { getPhpDockerSettingsConfig } = require('./php-docker-settings-config');
-const setupPHPDockerContainerSettingsConfig = require('./setup-php-docker-container-settings-config');
+const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser')
+const pathExists = require('../../../../util/path-exists')
+const { setupXMLStructure } = require('../setup-xml-structure')
+const { getPhpDockerSettingsConfig } = require('./php-docker-settings-config')
+const setupPHPDockerContainerSettingsConfig = require('./setup-php-docker-container-settings-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
  */
 const setupPhpDockerSettingsConfig = () => ({
     title: 'Set up PHP Docker Settings configuration',
     task: async (ctx, task) => {
-        const phpDockerSettingsConfig = getPhpDockerSettingsConfig();
+        const phpDockerSettingsConfig = getPhpDockerSettingsConfig()
 
         if (await pathExists(phpDockerSettingsConfig.path)) {
-            const phpDockerSettingsConfigContent = setupXMLStructure(await loadXmlFile(phpDockerSettingsConfig.path));
-            const phpDockerSettingsConfigs = phpDockerSettingsConfigContent.project.component;
+            const phpDockerSettingsConfigContent = setupXMLStructure(
+                await loadXmlFile(phpDockerSettingsConfig.path)
+            )
+            const phpDockerSettingsConfigs =
+                phpDockerSettingsConfigContent.project.component
             const hasChanges = await Promise.all([
-                setupPHPDockerContainerSettingsConfig(phpDockerSettingsConfigs, ctx)
-            ]);
+                setupPHPDockerContainerSettingsConfig(
+                    phpDockerSettingsConfigs,
+                    ctx
+                )
+            ])
 
             if (hasChanges.includes(true)) {
-                await buildXmlFile(phpDockerSettingsConfig.path, phpDockerSettingsConfigContent);
+                await buildXmlFile(
+                    phpDockerSettingsConfig.path,
+                    phpDockerSettingsConfigContent
+                )
             } else {
-                task.skip();
+                task.skip()
             }
 
-            return;
+            return
         }
 
-        const phpDockerSettingsConfigContent = setupXMLStructure({});
-        const phpDockerSettingsConfigs = phpDockerSettingsConfigContent.project.component;
+        const phpDockerSettingsConfigContent = setupXMLStructure({})
+        const phpDockerSettingsConfigs =
+            phpDockerSettingsConfigContent.project.component
 
         await Promise.all([
             setupPHPDockerContainerSettingsConfig(phpDockerSettingsConfigs, ctx)
-        ]);
+        ])
 
-        await buildXmlFile(phpDockerSettingsConfig.path, phpDockerSettingsConfigContent);
+        await buildXmlFile(
+            phpDockerSettingsConfig.path,
+            phpDockerSettingsConfigContent
+        )
     }
-});
+})
 
-module.exports = setupPhpDockerSettingsConfig;
+module.exports = setupPhpDockerSettingsConfig

package/lib/tasks/file-system/create-phpstorm-config/php-docker-settings-config/php-docker-settings-config.js

@@ -1,9 +1,9 @@
-const path = require('path');
+const path = require('path')
 
 const getPhpDockerSettingsConfig = () => ({
     path: path.join(process.cwd(), '.idea', 'php-docker-settings.xml')
-});
+})
 
 module.exports = {
     getPhpDockerSettingsConfig
-};
+}

package/lib/tasks/file-system/create-phpstorm-config/php-docker-settings-config/setup-php-docker-container-settings-config.js

@@ -1,17 +1,23 @@
-const { propertyKey } = require('../keys');
+const { propertyKey } = require('../keys')
 
-const PHP_DOCKER_CONTAINER_SETTINGS_COMPONENT_NAME = 'PhpDockerContainerSettings';
+const PHP_DOCKER_CONTAINER_SETTINGS_COMPONENT_NAME =
+    'PhpDockerContainerSettings'
 
 /**
  * @param {Array} phpDockerSettingsConfigs
  * @param {import('../../../../../typings/context').ListrContext} ctx
  * @returns {Promise<Boolean>}
  */
-const setupPHPDockerContainerSettingsConfig = async (phpDockerSettingsConfigs, ctx) => {
-    let hasChanges = false;
+const setupPHPDockerContainerSettingsConfig = async (
+    phpDockerSettingsConfigs,
+    ctx
+) => {
+    let hasChanges = false
     const phpDockerContainerSettingsComponent = phpDockerSettingsConfigs.find(
-        (phpDockerSettingsConfig) => phpDockerSettingsConfig[propertyKey('name')] === PHP_DOCKER_CONTAINER_SETTINGS_COMPONENT_NAME
-    );
+        (phpDockerSettingsConfig) =>
+            phpDockerSettingsConfig[propertyKey('name')] ===
+            PHP_DOCKER_CONTAINER_SETTINGS_COMPONENT_NAME
+    )
 
     const defaultList = {
         map: {
@@ -34,12 +40,17 @@ const setupPHPDockerContainerSettingsConfig = async (phpDockerSettingsConfigs, c
                                     DockerVolumeBindingImpl: {
                                         option: [
                                             {
-                                                [propertyKey('name')]: 'containerPath',
-                                                [propertyKey('value')]: ctx.config.baseConfig.containerMagentoDir
+                                                [propertyKey('name')]:
+                                                    'containerPath',
+                                                [propertyKey('value')]:
+                                                    ctx.config.baseConfig
+                                                        .containerMagentoDir
                                             },
                                             {
-                                                [propertyKey('name')]: 'hostPath',
-                                                [propertyKey('value')]: '$PROJECT_DIR$'
+                                                [propertyKey('name')]:
+                                                    'hostPath',
+                                                [propertyKey('value')]:
+                                                    '$PROJECT_DIR$'
                                             }
                                         ]
                                     }
@@ -50,17 +61,17 @@ const setupPHPDockerContainerSettingsConfig = async (phpDockerSettingsConfigs, c
                 }
             }
         }
-    };
+    }
 
     if (!phpDockerContainerSettingsComponent) {
-        hasChanges = true;
+        hasChanges = true
         phpDockerSettingsConfigs.push({
             [propertyKey('name')]: PHP_DOCKER_CONTAINER_SETTINGS_COMPONENT_NAME,
             list: defaultList
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupPHPDockerContainerSettingsConfig;
+module.exports = setupPHPDockerContainerSettingsConfig

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

@@ -1,4 +1,4 @@
-const { propertyKey } = require('./keys');
+const { propertyKey } = require('./keys')
 
 const xmlConfiguration = () => ({
     '?xml': {
@@ -9,34 +9,35 @@ const xmlConfiguration = () => ({
         [propertyKey('version')]: '4',
         component: []
     }
-});
+})
 
 const setupXMLStructure = (data) => {
     if (!data) {
-        data = xmlConfiguration();
+        data = xmlConfiguration()
     }
 
     if (data['?xml'] === undefined) {
-        data['?xml'] = xmlConfiguration()['?xml'];
+        data['?xml'] = xmlConfiguration()['?xml']
     }
 
     if (data.project === undefined) {
-        data.project = xmlConfiguration().project;
+        data.project = xmlConfiguration().project
     }
 
     if (data.project.component === undefined) {
-        data.project.component = [];
+        data.project.component = []
     }
 
-    if (!Array.isArray(data.project.component) && Boolean(data.project.component)) {
-        data.project.component = [
-            data.project.component
-        ];
+    if (
+        !Array.isArray(data.project.component) &&
+        Boolean(data.project.component)
+    ) {
+        data.project.component = [data.project.component]
     }
 
-    return data;
-};
+    return data
+}
 
 module.exports = {
     setupXMLStructure
-};
+}

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

@@ -1,61 +1,81 @@
-const path = require('path');
-const fs = require('fs');
-const { loadXmlFile, buildXmlFile } = require('../../../config/xml-parser');
-const pathExists = require('../../../util/path-exists');
-const { valueKey, nameKey } = require('./keys');
-const { setupXMLStructure } = require('./setup-xml-structure');
+const path = require('path')
+const fs = require('fs')
+const { loadXmlFile, buildXmlFile } = require('../../../config/xml-parser')
+const pathExists = require('../../../util/path-exists')
+const { valueKey, nameKey } = require('./keys')
+const { setupXMLStructure } = require('./setup-xml-structure')
 
-const STYLELINT_CONFIGURATION_COMPONENT_NAME = 'StylelintConfiguration';
+const STYLELINT_CONFIGURATION_COMPONENT_NAME = 'StylelintConfiguration'
 
-const pathToStylelintConfig = path.join(process.cwd(), '.idea', 'stylesheetLinters', 'stylelint.xml');
-const pathToStylelintConfigDir = path.parse(pathToStylelintConfig).dir;
+const pathToStylelintConfig = path.join(
+    process.cwd(),
+    '.idea',
+    'stylesheetLinters',
+    'stylelint.xml'
+)
+const pathToStylelintConfigDir = path.parse(pathToStylelintConfig).dir
 
-const DEFAULT_STYLE_PATTERN = '{**/*,*}.{css,scss}';
+const DEFAULT_STYLE_PATTERN = '{**/*,*}.{css,scss}'
 
 const defaultESLintComponentConfiguration = {
     [nameKey]: STYLELINT_CONFIGURATION_COMPONENT_NAME,
     'file-patterns': {
         [valueKey]: DEFAULT_STYLE_PATTERN
     }
-};
+}
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const setupStylelintConfig = () => ({
     title: 'Set up Stylelint configuration',
     task: async (ctx, task) => {
         if (await pathExists(pathToStylelintConfig)) {
-            let hasChanges = false;
-            const styleLintConfigurationData = setupXMLStructure(await loadXmlFile(pathToStylelintConfig));
+            let hasChanges = false
+            const styleLintConfigurationData = setupXMLStructure(
+                await loadXmlFile(pathToStylelintConfig)
+            )
 
-            if (styleLintConfigurationData.project.component && !Array.isArray(styleLintConfigurationData.project.component)) {
-                hasChanges = true;
-                styleLintConfigurationData.project.component = [styleLintConfigurationData.project.component];
+            if (
+                styleLintConfigurationData.project.component &&
+                !Array.isArray(styleLintConfigurationData.project.component)
+            ) {
+                hasChanges = true
+                styleLintConfigurationData.project.component = [
+                    styleLintConfigurationData.project.component
+                ]
             }
 
-            const styleLintConfigurationComponent = styleLintConfigurationData.project.component.find(
-                (component) => component[nameKey] === STYLELINT_CONFIGURATION_COMPONENT_NAME
-            );
+            const styleLintConfigurationComponent =
+                styleLintConfigurationData.project.component.find(
+                    (component) =>
+                        component[nameKey] ===
+                        STYLELINT_CONFIGURATION_COMPONENT_NAME
+                )
 
             if (!styleLintConfigurationComponent) {
-                hasChanges = true;
-                styleLintConfigurationData.project.component.push(defaultESLintComponentConfiguration);
+                hasChanges = true
+                styleLintConfigurationData.project.component.push(
+                    defaultESLintComponentConfiguration
+                )
             }
 
             if (hasChanges) {
-                await buildXmlFile(pathToStylelintConfig, styleLintConfigurationData);
+                await buildXmlFile(
+                    pathToStylelintConfig,
+                    styleLintConfigurationData
+                )
             } else {
-                task.skip();
+                task.skip()
             }
 
-            return;
+            return
         }
 
-        if (!await pathExists(pathToStylelintConfigDir)) {
+        if (!(await pathExists(pathToStylelintConfigDir))) {
             await fs.promises.mkdir(pathToStylelintConfigDir, {
                 recursive: true
-            });
+            })
         }
 
         const styleLintConfigurationData = {
@@ -65,14 +85,12 @@ const setupStylelintConfig = () => ({
             },
             project: {
                 '@_version': '4',
-                component: [
-                    defaultESLintComponentConfiguration
-                ]
+                component: [defaultESLintComponentConfiguration]
             }
-        };
+        }
 
-        await buildXmlFile(pathToStylelintConfig, styleLintConfigurationData);
+        await buildXmlFile(pathToStylelintConfig, styleLintConfigurationData)
     }
-});
+})
 
-module.exports = setupStylelintConfig;
+module.exports = setupStylelintConfig