@videinfra/static-website-builder 1.12.1 → 1.13.0

package/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.13.0] - 2024-08-23
+### Added
+- Added 'outpuSubFolder' property to entries configuration
+
 ## [1.12.1] - 2024-08-19
 ### Added
 - Version string to the dynamically loaded JS files

package/init/test/config/config.js

@@ -9,7 +9,19 @@ exports.data = {};
 exports.fonts = {};
 exports.icons = {};
 exports.images = {};
-exports.javascripts = {};
+exports.javascripts = {
+    entryList: [
+        {
+            name: '_entries.js',
+            shared: 'shared',
+        },
+        {
+            name: '_entries-alt.js',
+            shared: 'shared',
+            outpuSubFolder: 'alt'
+        },
+    ],
+};
 exports.stylesheets = {};
 exports.sizereport = false;
 

package/init/test/src/javascripts/_entries-alt.js

@@ -0,0 +1,13 @@
+/*
+* All files listed in here are created / compiled and additionally
+* shared.js is automatically created, which contains all common JS (chunks / modules imported from more than 1 entry files).
+*/
+module.exports = {
+    'shared': [
+        './common'
+    ],
+    'main': [
+        './common',
+        './main'
+    ]
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videinfra/static-website-builder",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "Customizable static site project builder",
   "license": "MIT",
   "engines": {

package/tasks/javascripts/config.js

@@ -62,7 +62,7 @@ exports.javascripts = {
         },
 
         output: {
-            filename: './[name].js',
+            filename: './[folder]/[name].js',
         },
 
         // Webpack plugins, either an array or a function which return an array of plugins

package/tasks/javascripts/preprocess-config.js

@@ -24,10 +24,10 @@ function requireUncached(module) {
  * @returns {object} List of entry files
  */
 function getEntry (config) {
-    const entryFile = paths.getSourcePath('javascripts', config.entryList.name);
+    const entryFileName = paths.getSourcePath('javascripts', config.entryList.name);
 
     return function getEntries () {
-        return requireUncached(entryFile);
+        return requireUncached(entryFileName);
     }
 }
 
@@ -62,15 +62,26 @@ module.exports = function preprocessJavascriptsConfig (config, fullConfig) {
         return {
             name: typeof entry === 'string' ? entry : entry.name,
             shared: typeof entry !== 'string' && entry && entry.shared ? entry.shared : (index === 0 ? 'shared' : ''),
+            outpuSubFolder: typeof entry !== 'string' && entry && entry.outpuSubFolder ? entry.outpuSubFolder : '',
         };
     });
 
-    return config.entryList.map((entryList) => {
-        const entryConfig = Object.assign({}, config);
+    return config.entryList.map((entry) => {
+        const entryConfig = cloneDeep(config);
         entryConfig.webpack = Object.assign({}, entryConfig.webpack);
 
         // One entry file per config
-        entryConfig.entryList = entryList;
+        entryConfig.entryList = entry;
+
+        // Output paths
+        const output = merge({
+            path: paths.getDestPath('javascripts'),
+            publicPath: paths.getPublicPath('javascripts'),
+        }, get(entryConfig, ['webpack', 'output'], null));
+
+        output.filename = output.filename
+            .replace('[folder]/', entry.outpuSubFolder ? entry.outpuSubFolder + '/' : '')
+            .replace('[folder]', entry.outpuSubFolder ? entry.outpuSubFolder : '');
 
         const buildConfig = merge(entryConfig, {
             webpack: {
@@ -81,10 +92,7 @@ module.exports = function preprocessJavascriptsConfig (config, fullConfig) {
                 entry: getEntry(entryConfig),
 
                 // Output folder
-                output: merge({
-                    path: paths.getDestPath('javascripts'),
-                    publicPath: paths.getPublicPath('javascripts'),
-                }, get(entryConfig, ['webpack', 'output'], null)),
+                output: output,
 
                 // Plugins, add ENV variables
                 plugins: [
@@ -94,7 +102,7 @@ module.exports = function preprocessJavascriptsConfig (config, fullConfig) {
                     new WatchExternalFilesPlugin.default({
                         verbose: false,
                         files: [
-                            paths.getSourcePath('javascripts', entryList.name),
+                            paths.getSourcePath('javascripts', entry.name),
                         ],
                     }),
                     new WebpackURLVersioningPlugin(),
@@ -128,16 +136,16 @@ module.exports = function preprocessJavascriptsConfig (config, fullConfig) {
 
         // Add webpack.optimization.runtimeChunk and webpack.optimization.splitChunks,
         // if entryConfig.shared doesn't exist, then remove them
-        if (entryList.shared && entryList.shared !== 'shared') {
+        if (entry.shared && entry.shared !== 'shared') {
             const optimization = buildConfig.webpack.optimization = cloneDeep(buildConfig.webpack.optimization || {});
 
             if (get(optimization, ['runtimeChunk', 'name'], null) === 'shared') {
                 // Change shared runtimeChunk name
-                optimization.runtimeChunk.name = entryList.shared;
+                optimization.runtimeChunk.name = entry.shared;
             } else if (!optimization.runtimeChunk) {
                 // Add shared runtimeChunk
                 optimization.runtimeChunk = {
-                    name: entryList.shared,
+                    name: entry.shared,
                 };
             }
 
@@ -145,20 +153,20 @@ module.exports = function preprocessJavascriptsConfig (config, fullConfig) {
                 // Rename split chunks "shared" chunk
                 const cacheGroups = optimization.splitChunks.cacheGroups.shared;
                 delete(optimization.splitChunks.cacheGroups.shared);
-                optimization.splitChunks.cacheGroups[entryList.shared] = cacheGroups;
-                cacheGroups.name = entryList.shared;
+                optimization.splitChunks.cacheGroups[entry.shared] = cacheGroups;
+                cacheGroups.name = entry.shared;
             } else if (!optimization.splitChunks) {
                 // Add splitChunks
                 optimization.splitChunks = optimization.splitChunks || {};
                 optimization.splitChunks.cacheGroups = optimization.splitChunks.cacheGroups || {};
-                optimization.splitChunks.cacheGroups[entryList.shared] = {
-                    name: entryList.shared,
+                optimization.splitChunks.cacheGroups[entry.shared] = {
+                    name: entry.shared,
                     chunks: 'all',
                     minChunks: 3,
                     enforce: true,
                 };
             }
-        } else if (!entryList.shared) {
+        } else if (!entry.shared) {
             // Remove optimization
             delete(buildConfig.webpack.optimization);
         }

package/tests/build/build.test.js

@@ -35,7 +35,7 @@ test('SASS sub-folder import test', () => {
 
 test('SASS autoprefixer test', () => {
     return fsPromises.readFile(path.resolve(publicPath, 'assets/stylesheets/autoprefixer-test.css'), {'encoding': 'utf8'}).then((css) => {
-        expect(css).toBe('main{-webkit-clip-path:polygon(0 0,100% 0,100% 100%,0 100%);clip-path:polygon(0 0,100% 0,100% 100%,0 100%)}');
+        expect(css).toBe('main{clip-path:polygon(0 0,100% 0,100% 100%,0 100%)}');
     });
 });
 
@@ -62,9 +62,25 @@ test('Font file fake not copied', () => {
 });
 
 test('shared.js file exists', () => {
-    return fsPromises.readFile(path.resolve(publicPath, 'assets/javascripts/shared.js'), {'encoding': 'utf8'}).then((js) => {
-        expect(js.indexOf('console.log("Shared file loaded")')).not.toBe(-1);
-    });
+    return Promise.all([
+        fsPromises.readFile(path.resolve(publicPath, 'assets/javascripts/shared.js'), {'encoding': 'utf8'}).then((js) => {
+            expect(js.indexOf('console.log("Shared file loaded")')).not.toBe(-1);
+        }),
+        fsPromises.readFile(path.resolve(publicPath, 'assets/javascripts/alt/shared.js'), {'encoding': 'utf8'}).then((js) => {
+            expect(js.indexOf('console.log("Shared file loaded")')).not.toBe(-1);
+        }),
+    ]);
+});
+
+test('main.js file exists', () => {
+    return Promise.all([
+        fsPromises.readFile(path.resolve(publicPath, 'assets/javascripts/main.js'), {'encoding': 'utf8'}).then((js) => {
+            expect(js.indexOf('console.log("Hello from main page!")')).not.toBe(-1);
+        }),
+        fsPromises.readFile(path.resolve(publicPath, 'assets/javascripts/alt/main.js'), {'encoding': 'utf8'}).then((js) => {
+            expect(js.indexOf('console.log("Hello from main page!")')).not.toBe(-1);
+        }),
+    ]);
 });
 
 test('other.js file exists', () => {
@@ -73,10 +89,8 @@ test('other.js file exists', () => {
     });
 });
 
-test('main.js file exists', () => {
-    return fsPromises.readFile(path.resolve(publicPath, 'assets/javascripts/main.js'), {'encoding': 'utf8'}).then((js) => {
-        expect(js.indexOf('console.log("Hello from main page!")')).not.toBe(-1);
-    });
+test('alt/other.js file doesn\'t exist', async () => {
+    expect(fsPromises.stat(path.resolve(publicPath, 'assets/javascripts/alt/other.js'))).rejects.toThrow();
 });
 
 test('icons generated', () => {

package/vendor/webpack-stream/index.js

@@ -27,18 +27,10 @@ var defaultStatsOptions = {
   errorDetails: false
 };
 
-var cache = {};
-
 module.exports = function (options, wp, done) {
-  if (cache.wp !== wp || cache.options !== options) {
-    cache = {};
-  }
-
-  cache.options = options;
-  cache.wp = wp;
-
   options = clone(options) || {};
   var config = options.config || options;
+  var cache = {};
 
   // Webpack 4 doesn't support the `quiet` attribute, however supports
   // setting `stats` to a string within an array of configurations