@videinfra/static-website-builder 1.12.0 → 1.13.0

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.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
+
 ## [1.12.0] - 2024-02-25
 ### Added
 - Support for multiple entry lists which each has its own "shared" chunk file

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,48 @@
-/*
- * 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 = {
+    entryList: [
+        {
+            name: '_entries.js',
+            shared: 'shared',
+        },
+        {
+            name: '_entries-alt.js',
+            shared: 'shared',
+            outpuSubFolder: 'alt'
+        },
+    ],
+};
+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/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/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/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;
+}

package/lib/get-path.js

@@ -1,109 +1,109 @@
-const path = require('path');
-const memoize = require('nano-memoize');
-const getConfig = require('./get-config');
-
-
-/**
- * Returns builder and project specific path configurations merged
- *
- * @returns {object} Configuration
- */
-
-const getPathConfig = memoize(function () {
-    return getConfig.getConfig().paths;
-});
-
-/**
- * Returns a path relative to the project folder
- *
- * @param  {...any} paths List of paths
- * @returns {string} Path
- */
-function getProjectPath (...paths) {
-    return path.resolve(process.env.INIT_CWD || process.cwd(), ...paths);
-};
-
-/**
- * Returns a path relative to the builder folder
- *
- * @param  {...any} paths List of paths
- * @returns {string} Path
- */
-function getBuilderPath (...paths) {
-    return path.resolve(__dirname, '../', ...paths);
-};
-
-/**
- * Returns task source path or paths
- *
- * @param {string} name Task name
- * @param  {...string} paths Additional sub paths
- * @returns {string|array} Task source path or list of paths
- */
-function getSourcePath (name, ...paths) {
-    const pathConfig = getPathConfig();
-    const path = pathConfig[name].src;
-
-    if (typeof path === 'string') {
-        return getProjectPath(pathConfig.src, path, ...paths);
-    } else if (Array.isArray(path)) {
-        return path.map((path) => getProjectPath(pathConfig.src, path, ...paths));
-    } else {
-        return null;
-    }
-}
-
-/**
- * Returns task source paths
- *
- * @param {string} name Task name
- * @param  {...string} paths Additional sub paths
- * @returns {array} Task source paths
- */
-function getSourcePaths (name, ...paths) {
-    const path = getSourcePath(name, ...paths);
-
-    if (typeof path === 'string') {
-        return [path];
-    } else {
-        return path;
-    }
-}
-
-/**
- * Returns task destination path
- *
- * @param {string} [name] Task name
- * @param  {...string} paths Additional sub paths
- * @returns {string} Task destination path
- */
-function getDestPath (name, ...paths) {
-    const pathConfig = getPathConfig();
-
-    if (name) {
-        return getProjectPath(pathConfig.dest, pathConfig[name].dest || '', ...paths);
-    } else {
-        return getProjectPath(pathConfig.dest);
-    }
-}
-
-/**
- * Returns public path
- *
- * @param {string} [name] Task name
- * @returns {string} Task public path
- */
-function getPublicPath (name) {
-    const destFullPath = getDestPath(name);
-    const destPath = getDestPath();
-    return destFullPath.replace(destPath, '') + '/';
-}
-
-
-exports.getPathConfig = getPathConfig;
-exports.getSourcePath = getSourcePath;
-exports.getSourcePaths = getSourcePaths;
-exports.getDestPath = getDestPath;
-exports.getProjectPath = getProjectPath;
-exports.getBuilderPath = getBuilderPath;
-exports.getPublicPath = getPublicPath;
+const path = require('path');
+const memoize = require('nano-memoize');
+const getConfig = require('./get-config');
+
+
+/**
+ * Returns builder and project specific path configurations merged
+ *
+ * @returns {object} Configuration
+ */
+
+const getPathConfig = memoize(function () {
+    return getConfig.getConfig().paths;
+});
+
+/**
+ * Returns a path relative to the project folder
+ *
+ * @param  {...any} paths List of paths
+ * @returns {string} Path
+ */
+function getProjectPath (...paths) {
+    return path.resolve(process.env.INIT_CWD || process.cwd(), ...paths);
+};
+
+/**
+ * Returns a path relative to the builder folder
+ *
+ * @param  {...any} paths List of paths
+ * @returns {string} Path
+ */
+function getBuilderPath (...paths) {
+    return path.resolve(__dirname, '../', ...paths);
+};
+
+/**
+ * Returns task source path or paths
+ *
+ * @param {string} name Task name
+ * @param  {...string} paths Additional sub paths
+ * @returns {string|array} Task source path or list of paths
+ */
+function getSourcePath (name, ...paths) {
+    const pathConfig = getPathConfig();
+    const path = pathConfig[name].src;
+
+    if (typeof path === 'string') {
+        return getProjectPath(pathConfig.src, path, ...paths);
+    } else if (Array.isArray(path)) {
+        return path.map((path) => getProjectPath(pathConfig.src, path, ...paths));
+    } else {
+        return null;
+    }
+}
+
+/**
+ * Returns task source paths
+ *
+ * @param {string} name Task name
+ * @param  {...string} paths Additional sub paths
+ * @returns {array} Task source paths
+ */
+function getSourcePaths (name, ...paths) {
+    const path = getSourcePath(name, ...paths);
+
+    if (typeof path === 'string') {
+        return [path];
+    } else {
+        return path;
+    }
+}
+
+/**
+ * Returns task destination path
+ *
+ * @param {string} [name] Task name
+ * @param  {...string} paths Additional sub paths
+ * @returns {string} Task destination path
+ */
+function getDestPath (name, ...paths) {
+    const pathConfig = getPathConfig();
+
+    if (name) {
+        return getProjectPath(pathConfig.dest, pathConfig[name].dest || '', ...paths);
+    } else {
+        return getProjectPath(pathConfig.dest);
+    }
+}
+
+/**
+ * Returns public path
+ *
+ * @param {string} [name] Task name
+ * @returns {string} Task public path
+ */
+function getPublicPath (name) {
+    const destFullPath = getDestPath(name);
+    const destPath = getDestPath();
+    return destFullPath.replace(destPath, '') + '/';
+}
+
+
+exports.getPathConfig = getPathConfig;
+exports.getSourcePath = getSourcePath;
+exports.getSourcePaths = getSourcePaths;
+exports.getDestPath = getDestPath;
+exports.getProjectPath = getProjectPath;
+exports.getBuilderPath = getBuilderPath;
+exports.getPublicPath = getPublicPath;