@scandipwa/magento-scripts 2.0.3 → 2.0.5

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

@@ -1,16 +1,12 @@
-const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser');
-const pathExists = require('../../../../util/path-exists');
-const {
-    nameKey,
-    valueKey,
-    classKey
-} = require('../keys');
-const setupESLintInspection = require('./eslint-inspection-config');
-const { getInspectionToolsConfig } = require('./inspection-tools-config');
-const setupMessDetectorValidationInspection = require('./mess-detector-validation-inspection-config');
-const setupPhpCSFixerValidationInspection = require('./php-cs-fixer-validation-inspection-config');
-const setupPhpCSValidationInspection = require('./php-cs-validation-inspection-config');
-const setupStyleLintInspection = require('./stylelint-inspection-config');
+const { loadXmlFile, buildXmlFile } = require('../../../../config/xml-parser')
+const pathExists = require('../../../../util/path-exists')
+const { nameKey, valueKey, classKey } = require('../keys')
+const setupESLintInspection = require('./eslint-inspection-config')
+const { getInspectionToolsConfig } = require('./inspection-tools-config')
+const setupMessDetectorValidationInspection = require('./mess-detector-validation-inspection-config')
+const setupPhpCSFixerValidationInspection = require('./php-cs-fixer-validation-inspection-config')
+const setupPhpCSValidationInspection = require('./php-cs-validation-inspection-config')
+const setupStyleLintInspection = require('./stylelint-inspection-config')
 
 const inspectionProfileDefaults = {
     component: {
@@ -31,52 +27,64 @@ const inspectionProfileDefaults = {
             ]
         }
     }
-};
+}
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../../typings/context').ListrContext>}
  */
 const setupInspectionToolsConfigTask = () => ({
     title: 'Set up inspection tools configuration',
     task: async (ctx, task) => {
-        const inspectionToolsConfig = getInspectionToolsConfig();
+        const inspectionToolsConfig = getInspectionToolsConfig()
         if (await pathExists(inspectionToolsConfig.path)) {
-            const inspectionToolsData = await loadXmlFile(inspectionToolsConfig.path);
+            const inspectionToolsData = await loadXmlFile(
+                inspectionToolsConfig.path
+            )
 
             if (!inspectionToolsData.component) {
-                inspectionToolsData.component = inspectionProfileDefaults.component;
+                inspectionToolsData.component =
+                    inspectionProfileDefaults.component
             }
 
             if (!inspectionToolsData.component.profile) {
-                inspectionToolsData.component.profile = inspectionProfileDefaults.component.profile;
+                inspectionToolsData.component.profile =
+                    inspectionProfileDefaults.component.profile
             }
 
             if (!inspectionToolsData.component.profile.inspection_tool) {
-                inspectionToolsData.component.profile.inspection_tool = [];
+                inspectionToolsData.component.profile.inspection_tool = []
             }
 
-            // eslint-disable-next-line max-len
-            if (!Array.isArray(inspectionToolsData.component.profile.inspection_tool) && Boolean(inspectionToolsData.component.profile.inspection_tool)) {
+            if (
+                !Array.isArray(
+                    inspectionToolsData.component.profile.inspection_tool
+                ) &&
+                Boolean(inspectionToolsData.component.profile.inspection_tool)
+            ) {
                 inspectionToolsData.component.profile.inspection_tool = [
                     inspectionToolsData.component.profile.inspection_tool
-                ];
+                ]
             }
 
-            const inspectionTools = inspectionToolsData.component.profile.inspection_tool;
+            const inspectionTools =
+                inspectionToolsData.component.profile.inspection_tool
             const hasChanges = await Promise.all([
                 setupPhpCSFixerValidationInspection(inspectionTools),
                 setupPhpCSValidationInspection(inspectionTools),
                 setupStyleLintInspection(inspectionTools),
                 setupMessDetectorValidationInspection(inspectionTools)
-            ]);
+            ])
 
             if (hasChanges.includes(true)) {
-                await buildXmlFile(inspectionToolsConfig.path, inspectionToolsData);
+                await buildXmlFile(
+                    inspectionToolsConfig.path,
+                    inspectionToolsData
+                )
             } else {
-                task.skip();
+                task.skip()
             }
 
-            return;
+            return
         }
 
         const inspectionToolsData = {
@@ -98,8 +106,9 @@ const setupInspectionToolsConfigTask = () => ({
                     ]
                 }
             }
-        };
-        const inspectionTools = inspectionToolsData.component.profile.inspection_tool;
+        }
+        const inspectionTools =
+            inspectionToolsData.component.profile.inspection_tool
 
         await Promise.all([
             setupPhpCSFixerValidationInspection(inspectionTools),
@@ -108,10 +117,10 @@ const setupInspectionToolsConfigTask = () => ({
             setupMessDetectorValidationInspection(inspectionTools),
             setupStyleLintInspection(inspectionTools),
             setupESLintInspection(inspectionTools)
-        ]);
+        ])
 
-        await buildXmlFile(inspectionToolsConfig.path, inspectionToolsData);
+        await buildXmlFile(inspectionToolsConfig.path, inspectionToolsData)
     }
-});
+})
 
-module.exports = setupInspectionToolsConfigTask;
+module.exports = setupInspectionToolsConfigTask

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

@@ -1,11 +1,19 @@
-const path = require('path');
-const { baseConfig } = require('../../../../config');
+const path = require('path')
+const { baseConfig } = require('../../../../config')
 
 const getInspectionToolsConfig = () => ({
-    path: path.join(process.cwd(), '.idea', 'inspectionProfiles', 'Project_Default.xml'),
-    templatePath: path.join(baseConfig.templateDir, 'Project_Default.template.xml')
-});
+    path: path.join(
+        process.cwd(),
+        '.idea',
+        'inspectionProfiles',
+        'Project_Default.xml'
+    ),
+    templatePath: path.join(
+        baseConfig.templateDir,
+        'Project_Default.template.xml'
+    )
+})
 
 module.exports = {
     getInspectionToolsConfig
-};
+}

package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/magento-coding-standard-config.js

@@ -1,26 +1,26 @@
-const { nameKey, valueKey } = require('../keys');
+const { nameKey, valueKey } = require('../keys')
 const {
     options: {
         CODING_STANDARD_OPTION_NAME,
         MAGENTO2_CODING_STANDARD_OPTION_VALUE
     }
-} = require('./config');
+} = require('./config')
 
 const setupMagento2CodingStandardOption = async (config) => {
-    let hasChanges = false;
+    let hasChanges = false
     const codingStandardOption = config.option.find(
         (option) => option[nameKey] === CODING_STANDARD_OPTION_NAME
-    );
+    )
 
     if (!codingStandardOption) {
-        hasChanges = true;
+        hasChanges = true
         config.option.push({
             [nameKey]: CODING_STANDARD_OPTION_NAME,
             [valueKey]: MAGENTO2_CODING_STANDARD_OPTION_VALUE
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupMagento2CodingStandardOption;
+module.exports = setupMagento2CodingStandardOption

package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/mess-detector-validation-inspection-config.js

@@ -1,8 +1,6 @@
-const { phpMDRuleSetFormattedPath } = require('./paths');
+const { phpMDRuleSetFormattedPath } = require('./paths')
 const {
-    classes: {
-        MESS_DETECTOR_VALIDATION_INSPECTION
-    },
+    classes: { MESS_DETECTOR_VALIDATION_INSPECTION },
     options: {
         CODESIZE_OPTION_NAME,
         CONTROVERSIAL_OPTION_NAME,
@@ -12,13 +10,9 @@ const {
         CUSTOM_RULESETS_OPTION_NAME,
         PHP_MD_RULESET_OPTION_VALUE
     }
-} = require('./config');
-const {
-    classKey,
-    nameKey,
-    valueKey
-} = require('../keys');
-const setupDefaultProperties = require('./default-properties-config');
+} = require('./config')
+const { classKey, nameKey, valueKey } = require('../keys')
+const setupDefaultProperties = require('./default-properties-config')
 
 const messDetectorBooleanOptionNames = [
     CODESIZE_OPTION_NAME,
@@ -26,7 +20,7 @@ const messDetectorBooleanOptionNames = [
     DESIGN_OPTION_NAME,
     UNUSED_CODE_OPTION_NAME,
     NAMING_OPTION_NAME
-];
+]
 
 const messDetectorDefaultRuleSetsListContent = {
     RulesetDescriptor: {
@@ -41,7 +35,7 @@ const messDetectorDefaultRuleSetsListContent = {
             }
         ]
     }
-};
+}
 
 const messDetectorDefaultOptions = [
     ...messDetectorBooleanOptionNames.map((optionName) => ({
@@ -52,91 +46,103 @@ const messDetectorDefaultOptions = [
         [nameKey]: CUSTOM_RULESETS_OPTION_NAME,
         list: messDetectorDefaultRuleSetsListContent
     }
-];
+]
 
 /**
  * @param {Array} inspectionToolsData
  * @returns {Promise<Boolean>}
  */
 const setupMessDetectorValidationInspection = async (inspectionToolsData) => {
-    let hasChanges = false;
-    const messDetectorConfig = inspectionToolsData.find((inspectionToolData) => inspectionToolData[classKey] === MESS_DETECTOR_VALIDATION_INSPECTION);
+    let hasChanges = false
+    const messDetectorConfig = inspectionToolsData.find(
+        (inspectionToolData) =>
+            inspectionToolData[classKey] === MESS_DETECTOR_VALIDATION_INSPECTION
+    )
     if (messDetectorConfig) {
-        const hasChangesInProperties = setupDefaultProperties(messDetectorConfig, {
-            enabled: 'true',
-            enabled_by_default: 'true',
-            level: 'WEAK WARNING'
-        });
+        const hasChangesInProperties = setupDefaultProperties(
+            messDetectorConfig,
+            {
+                enabled: 'true',
+                enabled_by_default: 'true',
+                level: 'WEAK WARNING'
+            }
+        )
 
         if (hasChangesInProperties) {
-            hasChanges = true;
+            hasChanges = true
         }
 
         if (messDetectorConfig.option) {
             messDetectorBooleanOptionNames.forEach((optionName) => {
                 const booleanOption = messDetectorConfig.option.find(
                     (o) => o[nameKey] === optionName
-                );
+                )
 
                 if (!booleanOption) {
-                    hasChanges = true;
+                    hasChanges = true
                     messDetectorConfig.option.push({
                         [nameKey]: optionName,
                         [valueKey]: 'true'
-                    });
+                    })
                 }
-            });
+            })
 
             const customRulesetsOption = messDetectorConfig.option.find(
                 (o) => o[nameKey] === CUSTOM_RULESETS_OPTION_NAME
-            );
+            )
 
             if (customRulesetsOption) {
                 if (!customRulesetsOption.list) {
-                    hasChanges = true;
-                    customRulesetsOption.list = [];
+                    hasChanges = true
+                    customRulesetsOption.list = []
                 }
 
-                if (customRulesetsOption.list && !Array.isArray(customRulesetsOption.list)) {
-                    hasChanges = true;
-                    customRulesetsOption.list = [customRulesetsOption.list];
+                if (
+                    customRulesetsOption.list &&
+                    !Array.isArray(customRulesetsOption.list)
+                ) {
+                    hasChanges = true
+                    customRulesetsOption.list = [customRulesetsOption.list]
                 }
 
                 const correctRulesetsExists = customRulesetsOption.list.some(
-                    (r) => r.RulesetDescriptor.option.some(
-                        (o) => o[nameKey] === 'path' && o[valueKey] === phpMDRuleSetFormattedPath
-                    )
-                );
+                    (r) =>
+                        r.RulesetDescriptor.option.some(
+                            (o) =>
+                                o[nameKey] === 'path' &&
+                                o[valueKey] === phpMDRuleSetFormattedPath
+                        )
+                )
 
                 if (!correctRulesetsExists) {
-                    hasChanges = true;
+                    hasChanges = true
                     customRulesetsOption.list.push(
                         messDetectorDefaultRuleSetsListContent
-                    );
+                    )
                 }
             } else {
-                hasChanges = true;
+                hasChanges = true
                 messDetectorConfig.option.push({
                     [nameKey]: CUSTOM_RULESETS_OPTION_NAME,
                     list: messDetectorDefaultRuleSetsListContent
-                });
+                })
             }
         } else {
-            hasChanges = true;
-            messDetectorConfig.option = messDetectorDefaultOptions;
+            hasChanges = true
+            messDetectorConfig.option = messDetectorDefaultOptions
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         inspectionToolsData.push({
             [classKey]: MESS_DETECTOR_VALIDATION_INSPECTION,
             '@_enabled': 'true',
             '@_level': 'WEAK WARNING',
             '@_enabled_by_default': 'true',
             option: messDetectorDefaultOptions
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupMessDetectorValidationInspection;
+module.exports = setupMessDetectorValidationInspection

package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/paths.js

@@ -1,15 +1,44 @@
-const path = require('path');
-const { formatPathForPHPStormConfig } = require('../xml-utils');
+const path = require('path')
+const { formatPathForPHPStormConfig } = require('../xml-utils')
 
-const phpCompatibilityPath = path.join(process.cwd(), 'vendor', 'phpcompatibility', 'php-compatibility', 'PHPCompatibility');
-const phpCompatibilityRuleSetPath = path.join(phpCompatibilityPath, 'ruleset.xml');
-const phpCompatibilityFormattedPath = formatPathForPHPStormConfig(phpCompatibilityPath);
-const phpCSConfigurationPath = path.join(process.cwd(), '.php_cs.dist');
-const phpCSConfigFormattedPath = formatPathForPHPStormConfig(phpCSConfigurationPath);
-const phpCSFixerConfigurationPath = path.join(process.cwd(), '.php-cs-fixer.dist.php');
-const phpCSFixerConfigurationFormattedPath = formatPathForPHPStormConfig(phpCSFixerConfigurationPath);
-const phpMDRuleSetPath = path.join(process.cwd(), 'dev', 'tests', 'static', 'testsuite', 'Magento', 'Test', 'Php', '_files', 'phpmd', 'ruleset.xml');
-const phpMDRuleSetFormattedPath = formatPathForPHPStormConfig(phpMDRuleSetPath);
+const phpCompatibilityPath = path.join(
+    process.cwd(),
+    'vendor',
+    'phpcompatibility',
+    'php-compatibility',
+    'PHPCompatibility'
+)
+const phpCompatibilityRuleSetPath = path.join(
+    phpCompatibilityPath,
+    'ruleset.xml'
+)
+const phpCompatibilityFormattedPath =
+    formatPathForPHPStormConfig(phpCompatibilityPath)
+const phpCSConfigurationPath = path.join(process.cwd(), '.php_cs.dist')
+const phpCSConfigFormattedPath = formatPathForPHPStormConfig(
+    phpCSConfigurationPath
+)
+const phpCSFixerConfigurationPath = path.join(
+    process.cwd(),
+    '.php-cs-fixer.dist.php'
+)
+const phpCSFixerConfigurationFormattedPath = formatPathForPHPStormConfig(
+    phpCSFixerConfigurationPath
+)
+const phpMDRuleSetPath = path.join(
+    process.cwd(),
+    'dev',
+    'tests',
+    'static',
+    'testsuite',
+    'Magento',
+    'Test',
+    'Php',
+    '_files',
+    'phpmd',
+    'ruleset.xml'
+)
+const phpMDRuleSetFormattedPath = formatPathForPHPStormConfig(phpMDRuleSetPath)
 
 module.exports = {
     phpCompatibilityPath,
@@ -21,4 +50,4 @@ module.exports = {
     phpCSFixerConfigurationFormattedPath,
     phpMDRuleSetPath,
     phpMDRuleSetFormattedPath
-};
+}

package/lib/tasks/file-system/create-phpstorm-config/inspection-tools-config/php-cs-fixer-validation-inspection-config.js

@@ -1,60 +1,63 @@
 const {
-    classes: {
-        PHP_CS_FIXER_VALIDATION_INSPECTION
-    }
-} = require('./config');
-const { classKey } = require('../keys');
-const setupCodingStandardOption = require('./coding-standard-config');
-const setupCustomRuleSetPathOption = require('./custom-ruleset-path-config');
-const setupDefaultProperties = require('./default-properties-config');
+    classes: { PHP_CS_FIXER_VALIDATION_INSPECTION }
+} = require('./config')
+const { classKey } = require('../keys')
+const setupCodingStandardOption = require('./coding-standard-config')
+const setupCustomRuleSetPathOption = require('./custom-ruleset-path-config')
+const setupDefaultProperties = require('./default-properties-config')
 
 /**
  * @param {Array} inspectionToolsData
  * @returns {Promise<Boolean>}
  */
 const setupPhpCSFixerValidationInspection = async (inspectionToolsData) => {
-    let hasChanges = false;
+    let hasChanges = false
     const phpCSFixerConfig = inspectionToolsData.find(
-        (inspectionToolData) => inspectionToolData[classKey] === PHP_CS_FIXER_VALIDATION_INSPECTION
-    );
+        (inspectionToolData) =>
+            inspectionToolData[classKey] === PHP_CS_FIXER_VALIDATION_INSPECTION
+    )
 
     if (phpCSFixerConfig) {
-        const hasChangesInProperties = setupDefaultProperties(phpCSFixerConfig);
+        const hasChangesInProperties = setupDefaultProperties(phpCSFixerConfig)
         if (hasChangesInProperties) {
-            hasChanges = true;
+            hasChanges = true
         }
 
         if (phpCSFixerConfig.option) {
-            const hasCodingStandardChanges = await setupCodingStandardOption(phpCSFixerConfig);
+            const hasCodingStandardChanges = await setupCodingStandardOption(
+                phpCSFixerConfig
+            )
             if (hasCodingStandardChanges) {
-                hasChanges = true;
+                hasChanges = true
             }
 
-            const hasCustomRuleSetChanges = await setupCustomRuleSetPathOption(phpCSFixerConfig);
+            const hasCustomRuleSetChanges = await setupCustomRuleSetPathOption(
+                phpCSFixerConfig
+            )
             if (hasCustomRuleSetChanges) {
-                hasChanges = true;
+                hasChanges = true
             }
         } else {
-            hasChanges = true;
-            phpCSFixerConfig.option = [];
-            await setupCodingStandardOption(phpCSFixerConfig);
-            await setupCustomRuleSetPathOption(phpCSFixerConfig);
+            hasChanges = true
+            phpCSFixerConfig.option = []
+            await setupCodingStandardOption(phpCSFixerConfig)
+            await setupCustomRuleSetPathOption(phpCSFixerConfig)
         }
     } else {
-        hasChanges = true;
+        hasChanges = true
         const phpCSFixerConfig = {
             [classKey]: PHP_CS_FIXER_VALIDATION_INSPECTION,
             option: []
-        };
+        }
 
-        setupDefaultProperties(phpCSFixerConfig);
-        await setupCodingStandardOption(phpCSFixerConfig);
-        await setupCustomRuleSetPathOption(phpCSFixerConfig);
+        setupDefaultProperties(phpCSFixerConfig)
+        await setupCodingStandardOption(phpCSFixerConfig)
+        await setupCustomRuleSetPathOption(phpCSFixerConfig)
 
-        inspectionToolsData.push(phpCSFixerConfig);
+        inspectionToolsData.push(phpCSFixerConfig)
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupPhpCSFixerValidationInspection;
+module.exports = setupPhpCSFixerValidationInspection