@scandipwa/magento-scripts 2.0.3 → 2.0.4

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

@@ -1,12 +1,10 @@
-const path = require('path');
-const { loadXmlFile, buildXmlFile } = require('../../../config/xml-parser');
-const pathExists = require('../../../util/path-exists');
-const {
-    urlKey, typeKey, versionKey, nameKey
-} = require('./keys');
-const { formatPathForPHPStormConfig } = require('./xml-utils');
-
-const pathToModulesConfig = path.join(process.cwd(), '.idea', 'modules.xml');
+const path = require('path')
+const { loadXmlFile, buildXmlFile } = require('../../../config/xml-parser')
+const pathExists = require('../../../util/path-exists')
+const { urlKey, typeKey, versionKey, nameKey } = require('./keys')
+const { formatPathForPHPStormConfig } = require('./xml-utils')
+
+const pathToModulesConfig = path.join(process.cwd(), '.idea', 'modules.xml')
 const excludeFoldersPaths = [
     'bin',
     'dev',
@@ -16,12 +14,11 @@ const excludeFoldersPaths = [
     'var/log',
     'var/composer_home',
     'var/view_preprocessed'
-].map((p) => `file://$MODULE_DIR$/${p}`);
+].map((p) => `file://$MODULE_DIR$/${p}`)
 
-const mustBeIncludedPaths = [
-    'pub',
-    'setup'
-].map((p) => `file://$MODULE_DIR$/${p}`);
+const mustBeIncludedPaths = ['pub', 'setup'].map(
+    (p) => `file://$MODULE_DIR$/${p}`
+)
 
 /**
  * Will retrieve project config file path from module.xml
@@ -29,26 +26,19 @@ const mustBeIncludedPaths = [
  * @returns {Promise<String | null>}
  */
 const getProjectConfigFilePath = async () => {
-    const modulesConfigData = await loadXmlFile(pathToModulesConfig);
-    const {
-        project: {
-            component: {
-                modules: {
-                    module
-                } = {}
-            } = {}
-        } = {}
-    } = modulesConfigData || {};
-    const filePath = module && module['@_filepath'];
-    return filePath ? filePath.replace('$PROJECT_DIR$', process.cwd()) : null;
-};
+    const modulesConfigData = await loadXmlFile(pathToModulesConfig)
+    const { project: { component: { modules: { module } = {} } = {} } = {} } =
+        modulesConfigData || {}
+    const filePath = module && module['@_filepath']
+    return filePath ? filePath.replace('$PROJECT_DIR$', process.cwd()) : null
+}
 
 const setupDefaultsForExcludedFoldersConfig = (projectConfigData) => {
     if (!projectConfigData.module) {
         projectConfigData.module = {
             [typeKey]: 'WEB_MODULE',
             [versionKey]: '4'
-        };
+        }
     }
 
     if (!projectConfigData.module.component) {
@@ -63,55 +53,64 @@ const setupDefaultsForExcludedFoldersConfig = (projectConfigData) => {
                     '@_forTest': 'false'
                 }
             ]
-        };
+        }
     }
 
     if (!projectConfigData.module.component.content) {
         projectConfigData.module.component.content = {
             [urlKey]: 'file://$MODULE_DIR$'
-        };
+        }
     }
 
     if (!projectConfigData.module.component.content.excludeFolder) {
-        projectConfigData.module.component.content.excludeFolder = [];
+        projectConfigData.module.component.content.excludeFolder = []
     }
-};
+}
 
 const setupExcludedFolders = (projectConfigData) => {
-    const { excludeFolder } = projectConfigData.module.component.content;
-    let hasChanges = false;
+    const { excludeFolder } = projectConfigData.module.component.content
+    let hasChanges = false
     // filter excluded folders to get ones that needs to be added to excluded folders list
-    const missingExcludedFolders = excludeFoldersPaths
-        .filter(
-            (excludeFoldersPath) => !excludeFolder.some(
+    const missingExcludedFolders = excludeFoldersPaths.filter(
+        (excludeFoldersPath) =>
+            !excludeFolder.some(
                 (config) => config[urlKey] === excludeFoldersPath
             )
-        );
+    )
 
     if (missingExcludedFolders.length > 0) {
-        hasChanges = true;
+        hasChanges = true
         missingExcludedFolders.forEach((missingExcludedFolder) => {
             projectConfigData.module.component.content.excludeFolder.unshift({
                 [urlKey]: missingExcludedFolder
-            });
-        });
+            })
+        })
     }
 
-    const hasSomePathsThatMustBeFiltered = excludeFolder.some((config) => mustBeIncludedPaths.includes(config[urlKey]));
+    const hasSomePathsThatMustBeFiltered = excludeFolder.some((config) =>
+        mustBeIncludedPaths.includes(config[urlKey])
+    )
 
     if (hasSomePathsThatMustBeFiltered) {
-        projectConfigData.module.component.content.excludeFolder = excludeFolder.filter((config) => !mustBeIncludedPaths.includes(config[urlKey]));
-        hasChanges = true;
+        projectConfigData.module.component.content.excludeFolder =
+            excludeFolder.filter(
+                (config) => !mustBeIncludedPaths.includes(config[urlKey])
+            )
+        hasChanges = true
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
 const getIMLFilePath = async () => {
-    const filePath = path.join(process.cwd(), '.idea', `${path.parse(process.cwd()).base}.iml`);
-    if (!await pathExists(pathToModulesConfig)) {
-        const fileFormattedPath = formatPathForPHPStormConfig(filePath);
-        const fileFormattedUrl = `file://${fileFormattedPath}`;
+    const filePath = path.join(
+        process.cwd(),
+        '.idea',
+        `${path.parse(process.cwd()).base}.iml`
+    )
+    if (!(await pathExists(pathToModulesConfig))) {
+        const fileFormattedPath = formatPathForPHPStormConfig(filePath)
+        const fileFormattedUrl = `file://${fileFormattedPath}`
 
         const modulesConfig = {
             '?xml': {
@@ -132,49 +131,49 @@ const getIMLFilePath = async () => {
                     ]
                 }
             }
-        };
+        }
 
-        await buildXmlFile(pathToModulesConfig, modulesConfig);
+        await buildXmlFile(pathToModulesConfig, modulesConfig)
     }
 
-    return filePath;
-};
+    return filePath
+}
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const setupExcludedFoldersConfig = () => ({
     title: 'Set up excluded folders configuration',
     task: async (ctx, task) => {
         if (await pathExists(pathToModulesConfig)) {
-            const projectFilePath = await getProjectConfigFilePath();
-            if (projectFilePath && await pathExists(projectFilePath)) {
-                const projectConfigData = await loadXmlFile(projectFilePath);
-                setupDefaultsForExcludedFoldersConfig(projectConfigData);
-                const hasChanges = setupExcludedFolders(projectConfigData);
+            const projectFilePath = await getProjectConfigFilePath()
+            if (projectFilePath && (await pathExists(projectFilePath))) {
+                const projectConfigData = await loadXmlFile(projectFilePath)
+                setupDefaultsForExcludedFoldersConfig(projectConfigData)
+                const hasChanges = setupExcludedFolders(projectConfigData)
                 if (hasChanges) {
-                    await buildXmlFile(projectFilePath, projectConfigData);
+                    await buildXmlFile(projectFilePath, projectConfigData)
                 } else {
-                    task.skip();
+                    task.skip()
                 }
 
-                return;
+                return
             }
         }
 
-        const projectFilePath = await getIMLFilePath();
+        const projectFilePath = await getIMLFilePath()
         const projectConfigData = {
             '?xml': {
                 [versionKey]: '1.0',
                 '@_encoding': 'UTF-8'
             }
-        };
+        }
 
-        setupDefaultsForExcludedFoldersConfig(projectConfigData);
-        setupExcludedFolders(projectConfigData);
+        setupDefaultsForExcludedFoldersConfig(projectConfigData)
+        setupExcludedFolders(projectConfigData)
 
-        await buildXmlFile(projectFilePath, projectConfigData);
+        await buildXmlFile(projectFilePath, projectConfigData)
     }
-});
+})
 
-module.exports = setupExcludedFoldersConfig;
+module.exports = setupExcludedFoldersConfig

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

@@ -1,30 +1,34 @@
-const setupWorkspaceConfig = require('./workspace-config');
-const setupPhpConfig = require('./php-config');
-const setupDatabaseConfig = require('./database-config');
-const setupInspectionToolsConfig = require('./inspection-tools-config');
-const setupExcludedFoldersConfig = require('./exclude-folder-config');
-const setupStylelintConfig = require('./stylelint-config');
-const setupESLintConfig = require('./eslint-config');
-const setupPhpDockerSettingsConfig = require('./php-docker-settings-config');
+const setupWorkspaceConfig = require('./workspace-config')
+const setupPhpConfig = require('./php-config')
+const setupDatabaseConfig = require('./database-config')
+const setupInspectionToolsConfig = require('./inspection-tools-config')
+const setupExcludedFoldersConfig = require('./exclude-folder-config')
+const setupStylelintConfig = require('./stylelint-config')
+const setupESLintConfig = require('./eslint-config')
+const setupPhpDockerSettingsConfig = require('./php-docker-settings-config')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const createPhpStormConfig = () => ({
     title: 'Setting PHPStorm config',
-    task: (ctx, task) => task.newListr([
-        setupWorkspaceConfig(),
-        setupPhpConfig(),
-        setupPhpDockerSettingsConfig(),
-        setupDatabaseConfig(),
-        setupInspectionToolsConfig(),
-        setupExcludedFoldersConfig(),
-        setupStylelintConfig(),
-        setupESLintConfig()
-    ], {
-        concurrent: true,
-        exitOnError: false
-    })
-});
+    task: (ctx, task) =>
+        task.newListr(
+            [
+                setupWorkspaceConfig(),
+                setupPhpConfig(),
+                setupPhpDockerSettingsConfig(),
+                setupDatabaseConfig(),
+                setupInspectionToolsConfig(),
+                setupExcludedFoldersConfig(),
+                setupStylelintConfig(),
+                setupESLintConfig()
+            ],
+            {
+                concurrent: true,
+                exitOnError: false
+            }
+        )
+})
 
-module.exports = createPhpStormConfig;
+module.exports = createPhpStormConfig

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

@@ -1,26 +1,26 @@
-const { nameKey, valueKey } = require('../keys');
+const { nameKey, valueKey } = require('../keys')
 const {
     options: {
         CODING_STANDARD_OPTION_NAME,
         CUSTOM_CODING_STANDARD_OPTION_VALUE
     }
-} = require('./config');
+} = require('./config')
 
 const setupCodingStandardOption = 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]: CUSTOM_CODING_STANDARD_OPTION_VALUE
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupCodingStandardOption;
+module.exports = setupCodingStandardOption

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

@@ -1,28 +1,28 @@
 // inspection tool classes
-const PHP_CS_FIXER_VALIDATION_INSPECTION = 'PhpCSFixerValidationInspection';
-const PHP_CS_VALIDATION_INSPECTION = 'PhpCSValidationInspection';
-const STYLELINT_INSPECTION = 'Stylelint';
-const ESLINT_INSPECTION = 'Eslint';
-const MESS_DETECTOR_VALIDATION_INSPECTION = 'MessDetectorValidationInspection';
+const PHP_CS_FIXER_VALIDATION_INSPECTION = 'PhpCSFixerValidationInspection'
+const PHP_CS_VALIDATION_INSPECTION = 'PhpCSValidationInspection'
+const STYLELINT_INSPECTION = 'Stylelint'
+const ESLINT_INSPECTION = 'Eslint'
+const MESS_DETECTOR_VALIDATION_INSPECTION = 'MessDetectorValidationInspection'
 
 // options
-const CODING_STANDARD_OPTION_NAME = 'CODING_STANDARD';
-const CUSTOM_CODING_STANDARD_OPTION_VALUE = 'Custom';
-const CUSTOM_RULE_SET_PATH_OPTION_NAME = 'CUSTOM_RULESET_PATH';
-const MAGENTO2_CODING_STANDARD_OPTION_VALUE = 'Magento2';
-const EXTENSIONS_OPTION_NAME = 'EXTENSIONS';
-const WARNING_HIGHLIGHT_LEVEL_NAME_OPTION_NAME = 'WARNING_HIGHLIGHT_LEVEL_NAME';
-const WARNING_HIGHLIGHT_LEVEL_NAME_OPTION_VALUE = 'ERROR';
-const SHOW_SNIFF_NAMES_OPTION_NAME = 'SHOW_SNIFF_NAMES';
-const USE_INSTALLED_PATHS_OPTION_NAME = 'USE_INSTALLED_PATHS';
-const INSTALLED_PATHS_OPTION_NAME = 'INSTALLED_PATHS';
-const CODESIZE_OPTION_NAME = 'CODESIZE';
-const CONTROVERSIAL_OPTION_NAME = 'CONTROVERSIAL';
-const DESIGN_OPTION_NAME = 'DESIGN';
-const UNUSED_CODE_OPTION_NAME = 'UNUSEDCODE';
-const NAMING_OPTION_NAME = 'NAMING';
-const CUSTOM_RULESETS_OPTION_NAME = 'customRulesets';
-const PHP_MD_RULESET_OPTION_VALUE = 'Magento PHPMD rule set';
+const CODING_STANDARD_OPTION_NAME = 'CODING_STANDARD'
+const CUSTOM_CODING_STANDARD_OPTION_VALUE = 'Custom'
+const CUSTOM_RULE_SET_PATH_OPTION_NAME = 'CUSTOM_RULESET_PATH'
+const MAGENTO2_CODING_STANDARD_OPTION_VALUE = 'Magento2'
+const EXTENSIONS_OPTION_NAME = 'EXTENSIONS'
+const WARNING_HIGHLIGHT_LEVEL_NAME_OPTION_NAME = 'WARNING_HIGHLIGHT_LEVEL_NAME'
+const WARNING_HIGHLIGHT_LEVEL_NAME_OPTION_VALUE = 'ERROR'
+const SHOW_SNIFF_NAMES_OPTION_NAME = 'SHOW_SNIFF_NAMES'
+const USE_INSTALLED_PATHS_OPTION_NAME = 'USE_INSTALLED_PATHS'
+const INSTALLED_PATHS_OPTION_NAME = 'INSTALLED_PATHS'
+const CODESIZE_OPTION_NAME = 'CODESIZE'
+const CONTROVERSIAL_OPTION_NAME = 'CONTROVERSIAL'
+const DESIGN_OPTION_NAME = 'DESIGN'
+const UNUSED_CODE_OPTION_NAME = 'UNUSEDCODE'
+const NAMING_OPTION_NAME = 'NAMING'
+const CUSTOM_RULESETS_OPTION_NAME = 'customRulesets'
+const PHP_MD_RULESET_OPTION_VALUE = 'Magento PHPMD rule set'
 
 module.exports = {
     options: {
@@ -51,4 +51,4 @@ module.exports = {
         ESLINT_INSPECTION,
         MESS_DETECTOR_VALIDATION_INSPECTION
     }
-};
+}

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

@@ -1,39 +1,42 @@
-const pathExists = require('../../../../util/path-exists');
+const pathExists = require('../../../../util/path-exists')
 const {
-    phpCSConfigurationPath, phpCSConfigFormattedPath, phpCSFixerConfigurationPath, phpCSFixerConfigurationFormattedPath
-} = require('./paths');
-const { nameKey, valueKey } = require('../keys');
+    phpCSConfigurationPath,
+    phpCSConfigFormattedPath,
+    phpCSFixerConfigurationPath,
+    phpCSFixerConfigurationFormattedPath
+} = require('./paths')
+const { nameKey, valueKey } = require('../keys')
 const {
-    options: {
-        CUSTOM_RULE_SET_PATH_OPTION_NAME
-    }
-} = require('./config');
+    options: { CUSTOM_RULE_SET_PATH_OPTION_NAME }
+} = require('./config')
 
 const setupCustomRuleSetPathOption = async (config) => {
-    let hasChanges = false;
+    let hasChanges = false
     const customRuleSetPathOption = config.option.find(
         (option) => option[nameKey] === CUSTOM_RULE_SET_PATH_OPTION_NAME
-    );
-    const phpCSConfigExists = await pathExists(phpCSConfigurationPath);
-    const phpCSFixerConfigPathExists = await pathExists(phpCSFixerConfigurationPath);
+    )
+    const phpCSConfigExists = await pathExists(phpCSConfigurationPath)
+    const phpCSFixerConfigPathExists = await pathExists(
+        phpCSFixerConfigurationPath
+    )
 
     if (!customRuleSetPathOption) {
         if (phpCSConfigExists) {
-            hasChanges = true;
+            hasChanges = true
             config.option.push({
                 [nameKey]: CUSTOM_RULE_SET_PATH_OPTION_NAME,
                 [valueKey]: phpCSConfigFormattedPath
-            });
+            })
         } else if (phpCSFixerConfigPathExists) {
-            hasChanges = true;
+            hasChanges = true
             config.option.push({
                 [nameKey]: CUSTOM_RULE_SET_PATH_OPTION_NAME,
                 [valueKey]: phpCSFixerConfigurationFormattedPath
-            });
+            })
         }
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupCustomRuleSetPathOption;
+module.exports = setupCustomRuleSetPathOption

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

@@ -1,12 +1,18 @@
-/* eslint-disable no-param-reassign */
+/**
+ * @type {{
+ *  enabled: 'true' | 'false',
+ *  enabled_by_default: 'true' | 'false',
+ *  level: 'ERROR' | 'WEAK WARNING'
+ * }}
+ */
 const properties = {
     enabled: 'true',
     enabled_by_default: 'true',
     level: 'ERROR'
-};
+}
 
 /**
- * @param {Object} inspectionTool
+ * @param {Record<string, unknown>} inspectionTool
  * @param {{
  *  enabled: 'true' | 'false',
  *  enabled_by_default: 'true' | 'false',
@@ -14,29 +20,33 @@ const properties = {
  * }} defaultProperties
  * @returns {Boolean}
  */
-const setupDefaultProperties = (inspectionTool, defaultProperties = properties) => {
-    let hasChanges = false;
+const setupDefaultProperties = (
+    inspectionTool,
+    defaultProperties = properties
+) => {
+    let hasChanges = false
     if (inspectionTool['@_enabled'] === undefined) {
-        hasChanges = true;
-        inspectionTool['@_enabled'] = defaultProperties.enabled;
+        hasChanges = true
+        inspectionTool['@_enabled'] = defaultProperties.enabled
     }
 
     if (inspectionTool['@_enabled_by_default'] === undefined) {
-        hasChanges = true;
-        inspectionTool['@_enabled_by_default'] = defaultProperties.enabled_by_default;
+        hasChanges = true
+        inspectionTool['@_enabled_by_default'] =
+            defaultProperties.enabled_by_default
     }
 
     if (inspectionTool['@_level'] === undefined) {
-        hasChanges = true;
-        inspectionTool['@_level'] = defaultProperties.level;
+        hasChanges = true
+        inspectionTool['@_level'] = defaultProperties.level
     }
 
     if (inspectionTool.option && !Array.isArray(inspectionTool.option)) {
-        hasChanges = true;
-        inspectionTool.option = [inspectionTool.option];
+        hasChanges = true
+        inspectionTool.option = [inspectionTool.option]
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupDefaultProperties;
+module.exports = setupDefaultProperties

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

@@ -1,10 +1,8 @@
 const {
-    classes: {
-        ESLINT_INSPECTION
-    }
-} = require('./config');
-const { classKey } = require('../keys');
-const setupDefaultProperties = require('./default-properties-config');
+    classes: { ESLINT_INSPECTION }
+} = require('./config')
+const { classKey } = require('../keys')
+const setupDefaultProperties = require('./default-properties-config')
 
 /**
  * Set up Styelint configuration
@@ -14,24 +12,25 @@ const setupDefaultProperties = require('./default-properties-config');
  * @returns {Promise<Boolean>}
  */
 const setupESLintInspection = async (inspectionToolsData) => {
-    let hasChanges = false;
+    let hasChanges = false
     const eslintConfig = inspectionToolsData.find(
-        (inspectionToolData) => inspectionToolData[classKey] === ESLINT_INSPECTION
-    );
+        (inspectionToolData) =>
+            inspectionToolData[classKey] === ESLINT_INSPECTION
+    )
 
     if (eslintConfig) {
-        hasChanges = setupDefaultProperties(eslintConfig);
+        hasChanges = setupDefaultProperties(eslintConfig)
     } else {
-        hasChanges = true;
+        hasChanges = true
         inspectionToolsData.push({
             [classKey]: ESLINT_INSPECTION,
             '@_enabled': 'true',
             '@_level': 'ERROR',
             '@_enabled_by_default': 'true'
-        });
+        })
     }
 
-    return hasChanges;
-};
+    return hasChanges
+}
 
-module.exports = setupESLintInspection;
+module.exports = setupESLintInspection