@oroinc/oro-webpack-config-builder 5.1.0-alpha3 → 5.1.0-alpha30

package/README.md

@@ -2,4 +2,4 @@
 
 An integration of OroPlatform based applications with the Webpack.
 
-For more details see [the documentation](https://doc.oroinc.com/backend/bundles/platform/AssetBundle/).
+For more details see [the documentation](https://doc.oroinc.com/bundles/platform/AssetBundle/).

package/messages.js

@@ -0,0 +1,29 @@
+const doc = "Please, find more information in the documentation ";
+const CSSError = "Failed assembly styles.\n";
+const CSSDoc = "https://doc.oroinc.com/backend/bundles/platform/AssetBundle/#load-scss-or-css-files-from-the-bundle";
+const JSError = `Failed assembly JS.\n`;
+const JSDoc = "https://doc.oroinc.com/backend/bundles/platform/AssetBundle/#create-jsmodules-yml-configuration";
+const JSExtraBuildDoc = "https://doc.oroinc.com/master/frontend/storefront/how-to/how-to-create-extra-js-build-for-landing-page";
+
+module.exports = {
+    assetsMissedOutput(group, theme) {
+        const error = `The "output" for "${group}" entry point in "${theme}" theme is not defined.\n`;
+
+        return `${CSSError}${error}${doc}${CSSDoc}`;
+    },
+    assetsMissedInput(group, theme) {
+        const error = `The "output" for "${group}" entry point in "${theme}" theme is not defined.\n`;
+
+        return `${CSSError}${error}${doc}${CSSDoc}`
+    },
+    jsModulesError(theme) {
+        const error = `Failed assembly JS for the "${theme}" theme.\n`;
+
+        return `${error}${doc}${JSDoc}`
+    },
+    jsExtraModulesError(parts) {
+        const error = `Sections ["${parts.join('", "')}"] are not allowed in extra js build definition\n`;
+
+        return `${JSError}${error}${doc}${JSExtraBuildDoc}`;
+    }
+};

package/modules-config/layout-modules-config-loader.js

@@ -4,10 +4,10 @@ const ModulesConfigLoader = require('./modules-config-loader');
 
 class LayoutModulesConfigLoader extends ModulesConfigLoader {
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     loadConfig(theme, filePath) {
-        let themeConfig = super.loadConfig(theme, path.join('/Resources/views/layouts/', theme, filePath));
+        let themeConfig = super.loadConfig(theme, path.join('Resources/views/layouts/', theme, filePath));
         // recursive process parent theme
         const {parent: parentTheme} = this.themes[theme];
         if (typeof parentTheme === 'string') {
@@ -17,6 +17,66 @@ class LayoutModulesConfigLoader extends ModulesConfigLoader {
 
         return themeConfig;
     }
+
+    /**
+     * All build names:
+     *  - based on theme names
+     *  - and theme's extra js builds
+     *
+     * @return {string[]}
+     */
+    get buildNames() {
+        const buildNames = super.buildNames;
+        this.themeNames.forEach(theme => {
+            buildNames.push(...this.extraJSBuildNames(theme));
+        });
+        return buildNames;
+    }
+
+    /**
+     * Collect extra js-build names for a theme
+     *
+     * @param {string} theme name on the theme
+     * @return {string[]}
+     */
+    extraJSBuildNames(theme) {
+        const {extra_js_builds:  extraJSBuilds = []} = this._themes[theme] || {}
+        return [...extraJSBuilds.map(suffix => `${theme}-${suffix}`)];
+    }
+
+    /**
+     * Check if buildName is an extra js build of layout theme
+     *
+     * @param {string} buildName name of the build
+     * @return {boolean}
+     */
+    isExtraJSBuild(buildName) {
+        const [, suffix] = this.splitBuildName(buildName);
+        return suffix !== void 0;
+    }
+
+    /**
+     * Splits build name on parts theme name and suffix (name of extra js build)
+     * @param {string} buildName
+     * @return {[string]|[string, string]}
+     */
+    splitBuildName(buildName) {
+        // suffix can not contain '-'
+        const marches = buildName.match(/(.+)-([^\-]+)?/);
+        const result = [];
+        if (marches) {
+            const [, theme, suffix] = marches;
+            const {extra_js_builds:  extraJSBuilds = []} = this._themes[theme] || {}
+            if (extraJSBuilds.includes(suffix)) {
+                result.push(marches[1], marches[2]);
+            } else {
+                result.push(buildName);
+            }
+        } else {
+            result.push(buildName);
+        }
+        return result;
+    }
 }
 
 module.exports = LayoutModulesConfigLoader;

package/modules-config/modules-config-loader.js

@@ -3,6 +3,9 @@ const fs = require('fs');
 const merge = require('deepmerge');
 const yaml = require('js-yaml');
 
+// merge only unique items
+const arrayMerge = (target, source) => target.concat(source.filter(item => !target.includes(item)));
+
 class ModulesConfigLoader {
     /**
      * @returns {Array}
@@ -18,10 +21,17 @@ class ModulesConfigLoader {
         return Object.keys(this._themes);
     }
 
+    /**
+     * @returns {Array}
+     */
+    get buildNames() {
+        return this.themeNames;
+    }
+
     /**
      * @param {Array} bundles Array of ordered symfony bundle paths
      * @param {string} themesLocation Path inside the bundle, where to find the theme
-     * @param {string} themeInfoFileName Yml File name with theme info
+     * @param {string} themeInfoFileName Yaml File name with theme info
      */
     constructor(bundles, themesLocation, themeInfoFileName) {
         this._bundles = bundles;
@@ -43,17 +53,15 @@ class ModulesConfigLoader {
             if (!fs.existsSync(source)) return;
 
             fs.readdirSync(source).forEach(name => {
-                const theme = path.resolve(source, name);
-                if (!fs.lstatSync(theme).isDirectory()) {
+                const themePath = path.resolve(source, name);
+                if (!fs.lstatSync(themePath).isDirectory()) {
                     return;
                 }
-                const themeFile = path.resolve(theme, themeInfoFileName);
+                const themeFile = path.resolve(themePath, themeInfoFileName);
                 if (!fs.existsSync(themeFile)) return;
 
-                if (!(name in themes)) {
-                    themes[name] = null;
-                }
-                themes[name] = yaml.load(fs.readFileSync(themeFile, 'utf8'));
+                const theme = yaml.load(fs.readFileSync(themeFile, 'utf8'));
+                themes[name] = merge(themes[name] || {}, theme, {arrayMerge});
             });
         });
 
@@ -62,17 +70,27 @@ class ModulesConfigLoader {
 
     /**
      * @param {string} theme Theme name
-     * @param {string} filePath Path to the file inside bundle directory where to find the configs
-     * @return {Object} Merged Configs loaded from all the bundles Yml files matched by filePath
+     * @param {string|string[]} filePath Path (or paths with fallback) to the file inside bundle directory where to find the configs
+     * @return {Object} Merged Configs loaded from all the bundles Yaml files matched by filePath
      */
     loadConfig(theme, filePath) {
         let configs = {};
+        const filePaths = [].concat(filePath);
         this._bundles.forEach(bundle => {
-            const absolutePath = bundle + filePath;
-            if (!fs.existsSync(absolutePath)) return;
+            let absolutePath;
+
+            for (const file of filePaths) {
+                absolutePath = path.resolve(bundle, file);
+                if (fs.existsSync(absolutePath)) {
+                    break;
+                }
+                absolutePath = void 0;
+            }
 
-            const doc = yaml.load(fs.readFileSync(absolutePath, 'utf8'));
-            configs = merge(configs, doc);
+            if (absolutePath) {
+                const doc = yaml.load(fs.readFileSync(absolutePath, 'utf8'));
+                configs = merge(configs, doc);
+            }
         });
         return configs;
     }