@videinfra/static-website-builder 2.0.0-beta.2 → 2.0.0-beta.3

package/lib/get-config.js

@@ -1,17 +1,21 @@
-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');
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'node:url';
 
-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');
+import { getProjectPath } from './get-path.js';
+import runPreprocess from './run-preprocess.js';
+import merge from './merge.js';
+import logError from './log-error.js';
 
+import each from 'lodash/each.js';
+import omit from 'lodash/omit.js';
+import isPlainObject from 'lodash/isPlainObject.js';
+import isArray from 'lodash/isArray.js';
+import reduce from 'lodash/reduce.js';
+import get from 'lodash/get.js';
+import { Module } from 'node:module';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /**
  * Returns builder and project specific task and plugin configurations combined
@@ -22,25 +26,33 @@ const get = require('lodash/get');
 
 let taskConfig = null;
 
-function getConfig (builderConfigFile) {
+/**
+ * Load and process config files
+ *
+ * @param {string} builderConfigFile Builder config file path
+ * @returns {object} Task configurations
+ */
+export async function getConfigAsync(builderConfigFile) {
     if (!taskConfig) {
         // Load all task configs
-        taskConfig = itterateConfig(loadConfig(), mergeConfigMode);
+        taskConfig = itterateConfig(await loadConfig(), mergeConfigMode);
 
         // 1. First load project specific config.js
-        const projectConfigPath = getPath.getProjectPath(builderConfigFile);
-        let   projectTaskConfig = {};
-        let   hasProjectConfigFile = true;
+        const projectConfigPath = 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 }"`});
+            logError({ plugin: 'static-website-builder', message: `Couldn't find configuration file "${projectConfigPath}"` });
             hasProjectConfigFile = false;
         }
 
         if (hasProjectConfigFile) {
-            projectTaskConfig = itterateConfig(require(projectConfigPath), mergeConfigMode);
+            await import(projectConfigPath).then((config) => {
+                projectTaskConfig = itterateConfig(config, mergeConfigMode);
+            });
         }
 
         // 2. Marge plugins into the config, each plugin is just a config
@@ -64,7 +76,20 @@ function getConfig (builderConfigFile) {
     }
 
     return taskConfig;
-};
+}
+
+/**
+ * Returns loaded task config
+ *
+ * @returns {object} Task configurations
+ */
+export function getConfig() {
+    if (!taskConfig) {
+        throw new Error('Task config not loaded yet');
+    }
+
+    return taskConfig;
+}
 
 /**
  * Returns task sub-config by path
@@ -72,7 +97,7 @@ function getConfig (builderConfigFile) {
  * @param  {...string} path Path to the sub-config
  * @returns {any} Task sub-config
  */
-function getTaskConfig (...path) {
+export function getTaskConfig(...path) {
     return get(getConfig(), path, null);
 }
 
@@ -84,21 +109,43 @@ function getTaskConfig (...path) {
  * @param {*} fn
  * @protected
  */
-function itterateConfig (config, fn) {
+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 reduce(
+        config,
+        (object, value, key) => {
+            // Detect ES modules and extract 'default' and other properties
+            if (value && Object.prototype.toString.call(value) === '[object Module]') {
+                const module = value;
+
+                if ('default' in module) {
+                    value = module.default;
+                    value.default = module.default;
+                } else {
+                    value = {};
+                }
+
+                for (let key in module) {
+                    if (key !== 'default') {
+                        value[key] = module[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);
+            return object;
+        },
+        base,
+    );
 }
 
 /**
@@ -109,7 +156,7 @@ function itterateConfig (config, fn) {
  * @returns {object} Config
  * @protected
  */
-function mergeConfigMode (config) {
+function mergeConfigMode(config) {
     if ('production' in config || 'development' in config) {
         const mode = global.production ? 'production' : 'development';
         const value = merge(config, config[mode]);
@@ -130,28 +177,28 @@ function mergeConfigMode (config) {
  * @returns {object} Configuration
  * @protected
  */
-function loadConfig () {
+async 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;
+    await Promise.all(
+        fs.readdirSync(taskFolder).map((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;
+                }
+
+                return import(configFileName).then((config) => {
+                    taskConfig = merge(taskConfig, config);
+                });
             }
-
-            taskConfig = merge(taskConfig, require(configFileName));
-        }
-    });
+        }),
+    );
 
     return taskConfig;
-};
-
-
-exports.getConfig = getConfig;
-exports.getTaskConfig = getTaskConfig;
+}

package/lib/get-file-names.js

@@ -1,5 +1,5 @@
-const fs = require('fs');
-const path = require('path');
+import fs  from 'fs';
+import path  from 'path';
 
 /**
  * Returns list of filenames in folder recursively
@@ -8,7 +8,7 @@ const path = require('path');
  * @param {string} [subFolder=''] Subfolder path
  * @returns {array} List of filenames, relative to folder
  */
-module.exports = function getFileNamesSync (folder, subFolder = '') {
+export default function getFileNamesSync (folder, subFolder = '') {
     let fileNames = []
 
     fs.readdirSync(folder, { withFileTypes: true }).forEach(file => {

package/lib/get-path.js

@@ -1,7 +1,9 @@
-const path = require('path');
-const { nanomemoize } = require('nano-memoize');
-const getConfig = require('./get-config');
+import path from 'path';
+import { fileURLToPath } from 'node:url';
+import nanomemoize from 'nano-memoize';
+import { getConfig } from './get-config.js';
 
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /**
  * Returns builder and project specific path configurations merged
@@ -9,8 +11,8 @@ const getConfig = require('./get-config');
  * @returns {object} Configuration
  */
 
-const getPathConfig = nanomemoize(function () {
-    return getConfig.getConfig().paths;
+export const getPathConfig = nanomemoize.nanomemoize(function () {
+    return getConfig().paths;
 });
 
 /**
@@ -19,9 +21,9 @@ const getPathConfig = nanomemoize(function () {
  * @param  {...any} paths List of paths
  * @returns {string} Path
  */
-function getProjectPath (...paths) {
+export function getProjectPath(...paths) {
     return path.resolve(process.env.INIT_CWD || process.cwd(), ...paths);
-};
+}
 
 /**
  * Returns a path relative to the builder folder
@@ -29,9 +31,9 @@ function getProjectPath (...paths) {
  * @param  {...any} paths List of paths
  * @returns {string} Path
  */
-function getBuilderPath (...paths) {
+export function getBuilderPath(...paths) {
     return path.resolve(__dirname, '../', ...paths);
-};
+}
 
 /**
  * Returns task source path or paths
@@ -40,7 +42,7 @@ function getBuilderPath (...paths) {
  * @param  {...string} paths Additional sub paths
  * @returns {string|array} Task source path or list of paths
  */
-function getSourcePath (name, ...paths) {
+export function getSourcePath(name, ...paths) {
     const pathConfig = getPathConfig();
     const path = pathConfig[name].src;
 
@@ -60,7 +62,7 @@ function getSourcePath (name, ...paths) {
  * @param  {...string} paths Additional sub paths
  * @returns {array} Task source paths
  */
-function getSourcePaths (name, ...paths) {
+export function getSourcePaths(name, ...paths) {
     const path = getSourcePath(name, ...paths);
 
     if (typeof path === 'string') {
@@ -77,7 +79,7 @@ function getSourcePaths (name, ...paths) {
  * @param  {...string} paths Additional sub paths
  * @returns {string} Task destination path
  */
-function getDestPath (name, ...paths) {
+export function getDestPath(name, ...paths) {
     const pathConfig = getPathConfig();
 
     if (name) {
@@ -93,17 +95,8 @@ function getDestPath (name, ...paths) {
  * @param {string} [name] Task name
  * @returns {string} Task public path
  */
-function getPublicPath (name) {
+export 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;

package/lib/globs-helper.js

@@ -1,7 +1,7 @@
-const path = require("path");
-const flatten = require("lodash/flatten");
-const map = require("lodash/map");
-const filter = require("lodash/filter");
+import path from 'path';
+import flatten from 'lodash/flatten.js';
+import map from 'lodash/map.js';
+import filter from 'lodash/filter.js';
 
 const REGEX_DOT_PREFIX = /^\.+/;
 const REGEX_WINDOWS_BACKSLASH = /\\/g;
@@ -18,45 +18,31 @@ class GlobObject {
     }
 
     paths(paths) {
-        const pathsArr = Array.isArray(paths)
-            ? paths
-            : typeof paths === "string"
-              ? [paths]
-              : [];
+        const pathsArr = Array.isArray(paths) ? paths : typeof paths === 'string' ? [paths] : [];
 
         if (pathsArr.length) {
             if (this.pathsArr.length) {
                 this.map((basePath) => {
                     return pathsArr.map((subPath) => {
                         // If subpath starts with specia character "!" then prepend that to the begining of full paths
-                        const negativePath = subPath[0] === "!" ? "!" : "";
-                        const subPathNormalized = negativePath
-                            ? subPath.substr(1)
-                            : subPath;
+                        const negativePath = subPath[0] === '!' ? '!' : '';
+                        const subPathNormalized = negativePath ? subPath.substr(1) : subPath;
 
-                        return (
-                            negativePath +
-                            path.join(basePath, subPathNormalized)
-                        );
+                        return negativePath + path.join(basePath, subPathNormalized);
                     });
                 });
 
                 this.mapRaw((basePath) => {
                     return pathsArr.map((subPath) => {
                         // If subpath starts with specia character "!" then prepend that to the begining of full paths
-                        const negativePath = subPath[0] === "!" ? "!" : "";
-                        const subPathNormalized = negativePath
-                            ? subPath.substr(1)
-                            : subPath;
+                        const negativePath = subPath[0] === '!' ? '!' : '';
+                        const subPathNormalized = negativePath ? subPath.substr(1) : subPath;
 
                         if (negativePath) {
                             this.isIgnore = true;
                         }
 
-                        return (
-                            negativePath +
-                            path.join(basePath, subPathNormalized)
-                        );
+                        return negativePath + path.join(basePath, subPathNormalized);
                     });
                 });
             } else {
@@ -77,19 +63,16 @@ class GlobObject {
      * @returns {object} GlobObject
      */
     filesWithExtensions(extensions) {
-        const extensionsArr =
-            typeof extensions === "string" ? [extensions] : extensions;
+        const extensionsArr = typeof extensions === 'string' ? [extensions] : extensions;
 
         if (extensionsArr && extensionsArr.length) {
-            let extensionString = "";
+            let extensionString = '';
 
             // Remove dot from the extension name
-            let extensionsArrNormalized = map(extensionsArr, (extension) =>
-                extension.replace(REGEX_DOT_PREFIX, ""),
-            );
+            let extensionsArrNormalized = map(extensionsArr, (extension) => extension.replace(REGEX_DOT_PREFIX, ''));
 
             if (extensionsArrNormalized.length > 1) {
-                extensionString = `/**/*.{${extensionsArrNormalized.join(",")}}`;
+                extensionString = `/**/*.{${extensionsArrNormalized.join(',')}}`;
             } else {
                 extensionString = `/**/*.${extensionsArrNormalized}`;
             }
@@ -129,10 +112,7 @@ class GlobObject {
      * @returns {object} GlobObject
      */
     map(fn) {
-        this.pathsArr = filter(
-            flatten(map(this.pathsArr, fn)),
-            (path) => !!path,
-        );
+        this.pathsArr = filter(flatten(map(this.pathsArr, fn)), (path) => !!path);
         return this;
     }
 
@@ -143,10 +123,7 @@ class GlobObject {
      * @returns {object} GlobObject
      */
     mapRaw(fn) {
-        this.pathsArrRaw = filter(
-            flatten(map(this.pathsArrRaw, fn)),
-            (path) => !!path,
-        );
+        this.pathsArrRaw = filter(flatten(map(this.pathsArrRaw, fn)), (path) => !!path);
         return this;
     }
 
@@ -161,7 +138,7 @@ class GlobObject {
             return [];
         } else {
             return map(this.pathsArr, (path) => {
-                return path.replace(REGEX_WINDOWS_BACKSLASH, "/");
+                return path.replace(REGEX_WINDOWS_BACKSLASH, '/');
             });
         }
     }
@@ -177,7 +154,7 @@ class GlobObject {
             return [];
         } else {
             return map(this.pathsArrRaw, (path) => {
-                return path.replace(REGEX_WINDOWS_BACKSLASH, "/");
+                return path.replace(REGEX_WINDOWS_BACKSLASH, '/');
             });
         }
     }
@@ -189,9 +166,7 @@ class GlobObject {
      */
     generate(forChokidar = false) {
         if (forChokidar) {
-            const paths = this.toArrayRaw().map((path) =>
-                this.isAllFiles || this.hasExtensions ? path + "/." : path,
-            );
+            const paths = this.toArrayRaw().map((path) => (this.isAllFiles || this.hasExtensions ? path + '/.' : path));
 
             if (this.hadEmptyPaths && this.isIgnore) {
                 return {
@@ -225,7 +200,7 @@ function paths(paths) {
 }
 
 function generate(...globs) {
-    const isLastArgBoolean = typeof globs[globs.length - 1] === "boolean";
+    const isLastArgBoolean = typeof globs[globs.length - 1] === 'boolean';
     const forChokidar = isLastArgBoolean ? globs.pop() : false;
 
     if (forChokidar) {
@@ -262,7 +237,7 @@ function chokidarFilterIgnorePaths(ignorePaths) {
     };
 }
 
-module.exports = {
+export default {
     generate,
     paths,
 };

package/lib/gulp/dynamic-task.js

@@ -2,7 +2,7 @@
  * Similar to parallel() and serial() but instead of getting tasks immediatelly
  * it's executed after config has been loaded
  */
-module.exports = function dynamicTask (fn) {
+export default function dynamicTask (fn) {
     fn.dynamicTasks = true;
     return fn;
 }

package/lib/gulp/resolve-dynamic-task.js

@@ -2,7 +2,7 @@
  * Similar to parallel() and serial() but instead of getting tasks immediatelly
  * it's executed after config has been loaded
  */
-module.exports = function resolveDynamicTask (fn) {
+export default function resolveDynamicTask (fn) {
     if (fn.dynamicTasks) {
         return fn();
     } else {

package/lib/gulp/task-before-dest.js

@@ -1,8 +1,8 @@
-const plumber = require('gulp-plumber');
+import plumber  from 'gulp-plumber';
 
 /**
  * Gulp task pipe function which handles errors
  */
-module.exports = function taskBeforeDest () {
+export default function taskBeforeDest () {
     return plumber.stop();
 }

package/lib/gulp/task-end.js

@@ -1,10 +1,10 @@
-const gulpif = require('gulp-if');
-const getConfig = require('../get-config');
-const browserSync = require('browser-sync');
+import gulpif  from 'gulp-if';
+import { getTaskConfig } from '../get-config.js';
+import browserSync  from 'browser-sync';
 
 /**
  * Gulp task pipe function which handles browsersync reloading
  */
-module.exports = function taskEnd () {
-    return gulpif(!!getConfig.getTaskConfig('browserSync'), browserSync.stream());
+export default function taskEnd () {
+    return gulpif(!!getTaskConfig('browserSync'), browserSync.stream());
 };

package/lib/gulp/task-start.js

@@ -1,10 +1,10 @@
-const plumber = require('gulp-plumber');
-const logError = require('../log-error');
+import plumber  from 'gulp-plumber';
+import logError  from '../log-error.js';
 
 /**
  * Gulp task pipe function which handles errors
  */
-module.exports = function taskStart () {
+export default function taskStart () {
     return plumber(function (error) {
         // Fail whole gulp process if in production mode
         logError.call(this, error, global.production);

package/lib/gulp/task-watch.js

@@ -1,14 +1,14 @@
-const { parallel } = require("gulp");
-const chokidar = require("chokidar");
-const debounce = require("lodash/debounce");
-const asyncDone = require("async-done");
+import { parallel } from 'gulp';
+import chokidar from 'chokidar';
+import debounce from 'lodash/debounce.js';
+import asyncDone from 'async-done';
 
 /**
  * Gulp task watch function using latest chokidar
  * with better OSX support and file watching functionality
  * than outdated gulp.watch
  */
-module.exports = function taskWatch(globs, callback, isParallel = false) {
+export default function taskWatch(globs, callback, isParallel = false) {
     const parallelCallback = isParallel ? callback : parallel(callback);
     const debouncedCallback = debounce(onChange, 120);
     let running = false;
@@ -41,26 +41,26 @@ module.exports = function taskWatch(globs, callback, isParallel = false) {
     }
 
     if (!globs.paths) {
-        throw new Error("No paths provided for chokidar watch");
+        throw new Error('No paths provided for chokidar watch');
     }
 
     return chokidar
         .watch(globs.paths, {
             ignoreInitial: true,
         })
-        .on("add", (path) => {
+        .on('add', (path) => {
             if (!isIgnoredPath(path)) {
                 debouncedCallback(path);
             }
         })
-        .on("change", (path) => {
+        .on('change', (path) => {
             if (!isIgnoredPath(path)) {
                 debouncedCallback(path);
             }
         })
-        .on("unlink", (path) => {
+        .on('unlink', (path) => {
             if (!isIgnoredPath(path)) {
                 debouncedCallback(path);
             }
         });
-};
+}

package/lib/init/copy-folder.js

@@ -1,6 +1,6 @@
-const path = require('path');
-const fs = require('fs');
-const fsPromise = require('fs').promises;
+import path  from 'path';
+import fs  from 'fs';
+import fsPromise from 'fs/promises';
 
 
 function copyFile(from, to, file) {
@@ -47,4 +47,4 @@ function copyFolder(from, to) {
 }
 
 
-module.exports = copyFolder;
+export default copyFolder;

package/lib/init/folder-exists.js

@@ -1,6 +1,6 @@
-const fs = require('fs');
+import fs  from 'fs';
 
-module.exports = function folderExists (folder) {
+export default function folderExists (folder) {
     try {
         const stat = fs.lstatSync(folder);
         return stat.isDirectory();

package/lib/init/get-folder-list.js

@@ -1,7 +1,7 @@
-const path = require('path');
-const fsPromise = require('fs').promises;
+import path  from 'path';
+import fsPromise from 'fs/promises';
 
-module.exports = function getFolderList (folder) {
+export default function getFolderList (folder) {
     return fsPromise.readdir(folder).then((files) => {
         return Promise.all(files.map((file) => {
             return fsPromise.lstat(path.join(folder, file)).then((stats) => {

package/lib/init/merge-package.js

@@ -1,14 +1,14 @@
-const readPackage = require('./read-package');
-const fsPromise = require('fs').promises;
-const merge = require('../merge');
-const isEqual = require('lodash/isEqual');
+import readPackage  from './read-package.js';
+import merge  from '../merge.js';
+import fsPromise from 'fs/promises';
+import isEqual  from 'lodash/isEqual.js';
 
-module.exports = function mergePackage (fileName, content) {
-    return readPackage(fileName).then((package) => {
-        const newPackage = merge({}, package, content);
+export default function mergePackage (fileName, content) {
+    return readPackage(fileName).then((packageContent) => {
+        const newPackage = merge({}, packageContent, content);
 
         // Write only if file has changed
-        if (!isEqual(package, newPackage)) {
+        if (!isEqual(packageContent, newPackage)) {
             return fsPromise.writeFile(fileName, JSON.stringify(newPackage, null, '  '));
         } else {
             return Promise.resolve();