@videinfra/static-website-builder 1.11.1 → 1.12.1

package/CHANGELOG.md

@@ -4,6 +4,14 @@ 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.12.1] - 2024-08-19
+### Added
+- Version string to the dynamically loaded JS files
+
+## [1.12.0] - 2024-02-25
+### Added
+- Support for multiple entry lists which each has its own "shared" chunk file
+
 ## [1.11.1] - 2024-02-24
 ### Fixed
 - Fixed dependencies

package/init/index.js

@@ -1,56 +1,56 @@
-const path = require('../lib/get-path');
-const copyFolder = require('../lib/init/copy-folder');
-const readPackage = require('../lib/init/read-package');
-const mergePackage = require('../lib/init/merge-package');
-const folderExists = require('../lib/init/folder-exists');
-const getFolderList = require('../lib/init/get-folder-list');
-const chalk = require('chalk');
-
-module.exports = function init (template = 'default') {
-    let   templateName = template || 'default';
-    let   copyFrom = path.getBuilderPath('init', templateName);
-    const copyTo = path.getProjectPath();
-
-    if (template === 'test' || !folderExists(copyFrom)) {
-        console.log(chalk.red(`Template "${ templateName }" doesn't exist`));
-
-        getFolderList(path.getBuilderPath('init')).then((templates) => {
-            console.log('Available templates:');
-            console.log(chalk.cyan(`    ${ templates.join('\n    ') }`));
-        });
-        return;
-    }
-
-    console.log(chalk.magenta(`Generating project files using template "${ templateName }"`));
-
-    // Copy files
-    const filesCopied = copyFolder(copyFrom, copyTo);
-
-    // Merge template package.json into projects package.json
-    const packageMerged = readPackage(path.getBuilderPath('init', templateName, 'package.json'), {}).then((package) => {
-        return mergePackage(path.getProjectPath('package.json'), package).then(() => {
-            if (package.dependencies || package.devDependencies) {
-                console.log(chalk.magenta('Installing npm dependencies'));
-
-                return new Promise((resolve, reject) => {
-                    require('child_process').exec('npm install', function (error, stdout, stderr) {
-                        resolve();
-                    });
-                });
-            }
-        }).catch((err) => {
-            // Skip errors
-            return Promise.resolve();
-        });
-    });
-
-    Promise.all([filesCopied, packageMerged]).then(() => {
-        console.log(chalk.green('All done\n'));
-
-        console.log('To start the dev server:\n' + chalk.cyan('    npm run start'));
-
-        console.log('To build the project:\n' + chalk.cyan('    npm run build'));
-    }, (err) => {
-        throw err;
-    });
-}
+const path = require('../lib/get-path');
+const copyFolder = require('../lib/init/copy-folder');
+const readPackage = require('../lib/init/read-package');
+const mergePackage = require('../lib/init/merge-package');
+const folderExists = require('../lib/init/folder-exists');
+const getFolderList = require('../lib/init/get-folder-list');
+const chalk = require('chalk');
+
+module.exports = function init (template = 'default') {
+    let   templateName = template || 'default';
+    let   copyFrom = path.getBuilderPath('init', templateName);
+    const copyTo = path.getProjectPath();
+
+    if (template === 'test' || !folderExists(copyFrom)) {
+        console.log(chalk.red(`Template "${ templateName }" doesn't exist`));
+
+        getFolderList(path.getBuilderPath('init')).then((templates) => {
+            console.log('Available templates:');
+            console.log(chalk.cyan(`    ${ templates.join('\n    ') }`));
+        });
+        return;
+    }
+
+    console.log(chalk.magenta(`Generating project files using template "${ templateName }"`));
+
+    // Copy files
+    const filesCopied = copyFolder(copyFrom, copyTo);
+
+    // Merge template package.json into projects package.json
+    const packageMerged = readPackage(path.getBuilderPath('init', templateName, 'package.json'), {}).then((package) => {
+        return mergePackage(path.getProjectPath('package.json'), package).then(() => {
+            if (package.dependencies || package.devDependencies) {
+                console.log(chalk.magenta('Installing npm dependencies'));
+
+                return new Promise((resolve, reject) => {
+                    require('child_process').exec('npm install', function (error, stdout, stderr) {
+                        resolve();
+                    });
+                });
+            }
+        }).catch((err) => {
+            // Skip errors
+            return Promise.resolve();
+        });
+    });
+
+    Promise.all([filesCopied, packageMerged]).then(() => {
+        console.log(chalk.green('All done\n'));
+
+        console.log('To start the dev server:\n' + chalk.cyan('    npm run start'));
+
+        console.log('To build the project:\n' + chalk.cyan('    npm run build'));
+    }, (err) => {
+        throw err;
+    });
+}

package/init/test/config/config.js

@@ -1,36 +1,36 @@
-/*
- * Build a project for testing
- */
-
-exports.clean = {};
-exports.static = {};
-exports.html = {};
-exports.data = {};
-exports.fonts = {};
-exports.icons = {};
-exports.images = {};
-exports.javascripts = {};
-exports.stylesheets = {};
-exports.sizereport = false;
-
-exports.plugins = [
-    // Enables SASS engine and .sass and .scss file compilation
-    require('../../../plugins/sass'),
-
-    // Enables TwigJS engine .twig file compilation
-    require('../../../plugins/twig'),
-];
-
-
-/*
- * Path configuration
- * All options will be merged with defaults, but not replaces whole configuration object
- *
- * Default configuration can be seen here https://github.com/videinfra/static-website-builder/tree/master/tasks
- * in each tasks config.js file
- */
-
-exports.paths = {
-    src: './init/test/src',
-    dest: './tests/build/public',
-};
+/*
+ * Build a project for testing
+ */
+
+exports.clean = {};
+exports.static = {};
+exports.html = {};
+exports.data = {};
+exports.fonts = {};
+exports.icons = {};
+exports.images = {};
+exports.javascripts = {};
+exports.stylesheets = {};
+exports.sizereport = false;
+
+exports.plugins = [
+    // Enables SASS engine and .sass and .scss file compilation
+    require('../../../plugins/sass'),
+
+    // Enables TwigJS engine .twig file compilation
+    require('../../../plugins/twig'),
+];
+
+
+/*
+ * Path configuration
+ * All options will be merged with defaults, but not replaces whole configuration object
+ *
+ * Default configuration can be seen here https://github.com/videinfra/static-website-builder/tree/master/tasks
+ * in each tasks config.js file
+ */
+
+exports.paths = {
+    src: './init/test/src',
+    dest: './tests/build/public',
+};

package/init/test/src/stylesheets/autoprefixer-test.scss

@@ -1,3 +1,3 @@
-main {
-    clip-path: polygon(0% 0%, 100% 0%, 100% 100%, 0% 100%);
-}
+main {
+    clip-path: polygon(0% 0%, 100% 0%, 100% 100%, 0% 100%);
+}

package/init/test/src/stylesheets/ignore-test.scss

@@ -1,4 +1,4 @@
-:root {
-    --yes: ;
-    --no: initial;
-}
+:root {
+    --yes: ;
+    --no: initial;
+}

package/init/test/src/stylesheets/nested-calc-test.scss

@@ -1,3 +1,3 @@
-body {
-    padding-top: calc(10vw + calc(10vh * 1.5));
-}
+body {
+    padding-top: calc(10vw + calc(10vh * 1.5));
+}

package/init/test/src/stylesheets/sub-folder/import-test.scss

@@ -1,2 +1,2 @@
-@import "settings/colors";
-@import "components/button";
+@import "settings/colors";
+@import "components/button";

package/lib/camelize-file-name.js

@@ -1,21 +1,21 @@
-/**
- * Camelize filename
- *
- * @param {string} str File name
- * @returns {string} Camelized name
- */
-module.exports = function camelizeFileName (str) {
-    return str
-         // Remove extension
-        .replace(/(.+?)\..*$/ig, '$1')
-        // Remove dot
-        .replace(/\./g, '')
-        // Replace non alpha-numeric characters
-        .replace(/[^a-z0-9]/ig, ' ')
-        // Uppercase words
-        .replace(/(?:^\w|[A-Z]|\b\w)/g, function(word, index) {
-             return index === 0 ? word.toLowerCase() : word.toUpperCase();
-        })
-        // Remove empty spaces
-        .replace(/\s+/g, '');
-}
+/**
+ * Camelize filename
+ *
+ * @param {string} str File name
+ * @returns {string} Camelized name
+ */
+module.exports = function camelizeFileName (str) {
+    return str
+         // Remove extension
+        .replace(/(.+?)\..*$/ig, '$1')
+        // Remove dot
+        .replace(/\./g, '')
+        // Replace non alpha-numeric characters
+        .replace(/[^a-z0-9]/ig, ' ')
+        // Uppercase words
+        .replace(/(?:^\w|[A-Z]|\b\w)/g, function(word, index) {
+             return index === 0 ? word.toLowerCase() : word.toUpperCase();
+        })
+        // Remove empty spaces
+        .replace(/\s+/g, '');
+}

package/lib/generate-gulp-tasks.js

@@ -3,6 +3,7 @@ const assign = require('lodash/assign');
 const filter = require('lodash/filter');
 const { series, parallel } = require('gulp');
 const { DEFAULT_TASKS, BUILD_TASKS } = require('./task-order');
+const resolveDynamicTask = require('./gulp/resolve-dynamic-task');
 
 
 /**
@@ -28,16 +29,16 @@ function generateTaskList (taskConfig) {
 
                 // Create individual tasks, which can be run separatelly
                 for (let gulpTaskName in gulpTaskList) {
-                    taskList.separate[`${ taskName }-${ gulpTaskName }`] = gulpTaskList[gulpTaskName];
+                    taskList.separate[`${ taskName }-${ gulpTaskName }`] = resolveDynamicTask(gulpTaskList[gulpTaskName]);
                 }
 
                 for (let t = 0; t < DEFAULT_TASKS.length; t++) {
                     if (DEFAULT_TASKS[t] in gulpTaskList) {
-                        const gulpTask = gulpTaskList[DEFAULT_TASKS[t]];
+                        const gulpTask = resolveDynamicTask(gulpTaskList[DEFAULT_TASKS[t]]);
                         taskList.default[t].push(gulpTask);
                     }
                     if (BUILD_TASKS[t] in gulpTaskList) {
-                        const gulpTask = gulpTaskList[BUILD_TASKS[t]];
+                        const gulpTask = resolveDynamicTask(gulpTaskList[BUILD_TASKS[t]]);
                         taskList.build[t].push(gulpTask);
                     }
                 }

package/lib/get-config.js

@@ -1,157 +1,157 @@
-const fs = require('fs');
-const path = require('path');
-const getPath = require('./get-path');
-const runPreprocess = require('./run-preprocess');
-const merge = require('./merge');
-const logError = require('./log-error');
-
-const each = require('lodash/each');
-const omit = require('lodash/omit');
-const isPlainObject = require('lodash/isPlainObject');
-const isArray = require('lodash/isArray');
-const reduce = require('lodash/reduce');
-const get = require('lodash/get');
-
-
-/**
- * Returns builder and project specific task and plugin configurations combined
- * Configuration is preprocessed
- *
- * @returns {object} Task configurations
- */
-
-let taskConfig = null;
-
-function getConfig (builderConfigFile) {
-    if (!taskConfig) {
-        // Load all task configs
-        taskConfig = itterateConfig(loadConfig(), mergeConfigMode);
-
-        // 1. First load project specific config.js
-        const projectConfigPath = getPath.getProjectPath(builderConfigFile);
-        let   projectTaskConfig = {};
-        let   hasProjectConfigFile = true;
-
-        try {
-            fs.accessSync(projectConfigPath);
-        } catch (err) {
-            logError({'plugin': 'static-website-builder', 'message': `Couldn't find configuration file "${ projectConfigPath }"`});
-            hasProjectConfigFile = false;
-        }
-
-        if (hasProjectConfigFile) {
-            projectTaskConfig = itterateConfig(require(projectConfigPath), mergeConfigMode);
-        }
-
-        // 2. Marge plugins into the config, each plugin is just a config
-        const plugins = (taskConfig.plugins || []).concat(projectTaskConfig.plugins || []);
-        if (plugins) {
-            taskConfig.plugins = null;
-            projectTaskConfig.plugins = null;
-
-            each(plugins, (plugin) => {
-                taskConfig = merge(taskConfig, itterateConfig(plugin, mergeConfigMode));
-            });
-        }
-
-        // 3. Only after plugins has been executed, merge project specific config.js into main config
-        if (projectTaskConfig) {
-            taskConfig = merge(taskConfig, projectTaskConfig);
-        }
-
-        // 4. Preprocess
-        taskConfig = runPreprocess(taskConfig);
-    }
-
-    return taskConfig;
-};
-
-/**
- * Returns task sub-config by path
- *
- * @param  {...string} path Path to the sub-config
- * @returns {any} Task sub-config
- */
-function getTaskConfig (...path) {
-    return get(getConfig(), path, null);
-}
-
-/**
- * Itterate over each config property and call function on
- * each object or array
- *
- * @param {*} object
- * @param {*} fn
- * @protected
- */
-function itterateConfig (config, fn) {
-    if (config === false) return false;
-    const base = isPlainObject(config) ? {} : [];
-
-    return reduce(config, (object, value, key) => {
-        if (isPlainObject(value)) {
-            object[key]= itterateConfig(fn(value), fn);
-        } else if (isArray(value)) {
-            object[key]= itterateConfig(value, fn);
-        } else {
-            object[key] = value;
-        }
-
-        return object;
-    }, base);
-}
-
-/**
- * Merge 'production' or 'development' mode sub-ojbects into an object and remove
- * mode sub-objects
- *
- * @param {object} config Config
- * @returns {object} Config
- * @protected
- */
-function mergeConfigMode (config) {
-    if ('production' in config || 'development' in config) {
-        const mode = global.production ? 'production' : 'development';
-        const value = merge(config, config[mode]);
-
-        if (value !== false) {
-            return omit(value, ['production', 'development']);
-        } else {
-            return value;
-        }
-    } else {
-        return config;
-    }
-}
-
-/**
- * Load config files
- *
- * @returns {object} Configuration
- * @protected
- */
-function loadConfig () {
-    const taskFolder = path.resolve(__dirname, '../tasks');
-    let taskConfig = {};
-
-    fs.readdirSync(taskFolder).forEach(folderName => {
-        // Ignore task folders which start with underscore
-        if (folderName[0] !== '_') {
-            const configFileName = path.resolve(taskFolder, folderName, 'config.js');
-
-            try {
-                fs.accessSync(configFileName);
-            } catch (err) {
-                return;
-            }
-
-            taskConfig = merge(taskConfig, require(configFileName));
-        }
-    });
-
-    return taskConfig;
-};
-
-
-exports.getConfig = getConfig;
-exports.getTaskConfig = getTaskConfig;
+const fs = require('fs');
+const path = require('path');
+const getPath = require('./get-path');
+const runPreprocess = require('./run-preprocess');
+const merge = require('./merge');
+const logError = require('./log-error');
+
+const each = require('lodash/each');
+const omit = require('lodash/omit');
+const isPlainObject = require('lodash/isPlainObject');
+const isArray = require('lodash/isArray');
+const reduce = require('lodash/reduce');
+const get = require('lodash/get');
+
+
+/**
+ * Returns builder and project specific task and plugin configurations combined
+ * Configuration is preprocessed
+ *
+ * @returns {object} Task configurations
+ */
+
+let taskConfig = null;
+
+function getConfig (builderConfigFile) {
+    if (!taskConfig) {
+        // Load all task configs
+        taskConfig = itterateConfig(loadConfig(), mergeConfigMode);
+
+        // 1. First load project specific config.js
+        const projectConfigPath = getPath.getProjectPath(builderConfigFile);
+        let   projectTaskConfig = {};
+        let   hasProjectConfigFile = true;
+
+        try {
+            fs.accessSync(projectConfigPath);
+        } catch (err) {
+            logError({'plugin': 'static-website-builder', 'message': `Couldn't find configuration file "${ projectConfigPath }"`});
+            hasProjectConfigFile = false;
+        }
+
+        if (hasProjectConfigFile) {
+            projectTaskConfig = itterateConfig(require(projectConfigPath), mergeConfigMode);
+        }
+
+        // 2. Marge plugins into the config, each plugin is just a config
+        const plugins = (taskConfig.plugins || []).concat(projectTaskConfig.plugins || []);
+        if (plugins) {
+            taskConfig.plugins = null;
+            projectTaskConfig.plugins = null;
+
+            each(plugins, (plugin) => {
+                taskConfig = merge(taskConfig, itterateConfig(plugin, mergeConfigMode));
+            });
+        }
+
+        // 3. Only after plugins has been executed, merge project specific config.js into main config
+        if (projectTaskConfig) {
+            taskConfig = merge(taskConfig, projectTaskConfig);
+        }
+
+        // 4. Preprocess
+        taskConfig = runPreprocess(taskConfig);
+    }
+
+    return taskConfig;
+};
+
+/**
+ * Returns task sub-config by path
+ *
+ * @param  {...string} path Path to the sub-config
+ * @returns {any} Task sub-config
+ */
+function getTaskConfig (...path) {
+    return get(getConfig(), path, null);
+}
+
+/**
+ * Itterate over each config property and call function on
+ * each object or array
+ *
+ * @param {*} object
+ * @param {*} fn
+ * @protected
+ */
+function itterateConfig (config, fn) {
+    if (config === false) return false;
+    const base = isPlainObject(config) ? {} : [];
+
+    return reduce(config, (object, value, key) => {
+        if (isPlainObject(value)) {
+            object[key]= itterateConfig(fn(value), fn);
+        } else if (isArray(value)) {
+            object[key]= itterateConfig(value, fn);
+        } else {
+            object[key] = value;
+        }
+
+        return object;
+    }, base);
+}
+
+/**
+ * Merge 'production' or 'development' mode sub-ojbects into an object and remove
+ * mode sub-objects
+ *
+ * @param {object} config Config
+ * @returns {object} Config
+ * @protected
+ */
+function mergeConfigMode (config) {
+    if ('production' in config || 'development' in config) {
+        const mode = global.production ? 'production' : 'development';
+        const value = merge(config, config[mode]);
+
+        if (value !== false) {
+            return omit(value, ['production', 'development']);
+        } else {
+            return value;
+        }
+    } else {
+        return config;
+    }
+}
+
+/**
+ * Load config files
+ *
+ * @returns {object} Configuration
+ * @protected
+ */
+function loadConfig () {
+    const taskFolder = path.resolve(__dirname, '../tasks');
+    let taskConfig = {};
+
+    fs.readdirSync(taskFolder).forEach(folderName => {
+        // Ignore task folders which start with underscore
+        if (folderName[0] !== '_') {
+            const configFileName = path.resolve(taskFolder, folderName, 'config.js');
+
+            try {
+                fs.accessSync(configFileName);
+            } catch (err) {
+                return;
+            }
+
+            taskConfig = merge(taskConfig, require(configFileName));
+        }
+    });
+
+    return taskConfig;
+};
+
+
+exports.getConfig = getConfig;
+exports.getTaskConfig = getTaskConfig;

package/lib/get-file-names.js

@@ -1,23 +1,23 @@
-const fs = require('fs');
-const path = require('path');
-
-/**
- * Returns list of filenames in folder recursively
- *
- * @param {string} folder Folder path
- * @param {string} [subFolder=''] Subfolder path
- * @returns {array} List of filenames, relative to folder
- */
-module.exports = function getFileNamesSync (folder, subFolder = '') {
-    let fileNames = []
-
-    fs.readdirSync(folder, { withFileTypes: true }).forEach(file => {
-        if (file.isDirectory()) {
-            fileNames = fileNames.concat(getFileNamesSync(path.join(folder, file.name), path.join(subFolder, file.name)));
-        } else {
-            fileNames.push(path.join(subFolder, file.name))
-        }
-    });
-
-    return fileNames;
-}
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Returns list of filenames in folder recursively
+ *
+ * @param {string} folder Folder path
+ * @param {string} [subFolder=''] Subfolder path
+ * @returns {array} List of filenames, relative to folder
+ */
+module.exports = function getFileNamesSync (folder, subFolder = '') {
+    let fileNames = []
+
+    fs.readdirSync(folder, { withFileTypes: true }).forEach(file => {
+        if (file.isDirectory()) {
+            fileNames = fileNames.concat(getFileNamesSync(path.join(folder, file.name), path.join(subFolder, file.name)));
+        } else {
+            fileNames.push(path.join(subFolder, file.name))
+        }
+    });
+
+    return fileNames;
+}