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

package/tasks/browser-sync/config.js

@@ -1,7 +1,10 @@
+import * as preprocessBrowserSyncConfig from './preprocess-config.js';
+import * as taskBrowserSync from './task.js';
+
 /**
  * Browsersync DEV server settings
  */
-exports.browserSync = {
+export const browserSync = {
     // Production only settings, overwrites default settings
     production: false,
 
@@ -11,15 +14,15 @@ exports.browserSync = {
     },
 };
 
-exports.preprocess = {
+export const preprocess = {
     browserSync: [
-        require('./preprocess-config'),
+        preprocessBrowserSyncConfig,
     ]
 };
 
-exports.tasks = {
+export const tasks = {
     browserSync: [
-        require('./task'),
+        taskBrowserSync,
     ]
 };
 
@@ -27,7 +30,7 @@ exports.tasks = {
 /**
  * Paths relative to the global src and dest folders
  */
-exports.paths = {
+export const paths = {
     browserSync: {
         // Server root directory, relative to the project
         // If not set then global dest folder

package/tasks/browser-sync/preprocess-config.js

@@ -1,7 +1,5 @@
-const map = require('lodash/map');
-const getPaths = require('./../../lib/get-path');
-const globs = require('./../../lib/globs-helper');
-const isPlainObject = require('lodash/isPlainObject');
+import { getProjectPath, getDestPath }  from './../../lib/get-path.js';
+import isPlainObject  from 'lodash/isPlainObject.js';
 
 /**
  * Modify configuration
@@ -10,7 +8,7 @@ const isPlainObject = require('lodash/isPlainObject');
  * @param {object} fullConfig Full configuration
  * @returns {object} Transformed browserSync configuration
  */
-module.exports = function preprocessBrowserSyncConfig (config = {}, fullConfig) {
+export default function preprocessBrowserSyncConfig (config = {}, fullConfig) {
     // If server is disabled then disable whole browserSync
     // If HTML is not being rendered, then browserSync has no use
     if (config.server === false || fullConfig.html === false) return false;
@@ -23,10 +21,10 @@ module.exports = function preprocessBrowserSyncConfig (config = {}, fullConfig)
     if (config.server) {
         if (config.server.baseDir) {
             // Relative to the project
-            config.server.baseDir = getPaths.getProjectPath(config.server.baseDir);
+            config.server.baseDir = getProjectPath(config.server.baseDir);
         } else {
             // Set to output folder from path-config.js
-            config.server.baseDir = getPaths.getDestPath('browserSync')
+            config.server.baseDir = getDestPath('browserSync')
         }
     }
 

package/tasks/browser-sync/task.js

@@ -1,9 +1,9 @@
-const bs = require('browser-sync');
-const getConfig = require('./../../lib/get-config');
+import bs from 'browser-sync';
+import { getTaskConfig } from './../../lib/get-config.js';
 
-exports.watch = function browserSync (callback) {
-    bs.init(getConfig.getTaskConfig('browserSync'));
+export const watch = function browserSync(callback) {
+    bs.init(getTaskConfig('browserSync'));
 };
 
 // Execute as first task
-exports.watch.order = -2;
+watch.order = -2;

package/tasks/clean/config.js

@@ -1,17 +1,20 @@
-exports.clean = {
+import * as preprocessCleanConfig from './preprocess-config.js';
+import * as taskClean from './task.js';
+
+export const clean = {
     // Patterns, relative to the destination folder, see https://gulpjs.com/docs/en/getting-started/explaining-globs/
     // patterns: ['assets/**', 'temp-folder']
     patterns: [],
 };
 
-exports.preprocess = {
+export const preprocess = {
     clean: [
-        require('./preprocess-config'),
+        preprocessCleanConfig,
     ]
 };
 
-exports.tasks = {
+export const tasks = {
     clean: [
-        require('./task'),
+        taskClean,
     ]
 };

package/tasks/clean/preprocess-config.js

@@ -1,5 +1,5 @@
-const getPaths = require('./../../lib/get-path');
-const globs = require('./../../lib/globs-helper');
+import { getDestPath } from './../../lib/get-path.js';
+import globs from './../../lib/globs-helper.js';
 
 /**
  * Modify configuration
@@ -8,11 +8,11 @@ const globs = require('./../../lib/globs-helper');
  * @param {object} fullConfig Full configuration
  * @returns {object} Transformed clean configuration
  */
-module.exports = function preprocessCleanConfig (config = {}, fullConfig) {
+export default function preprocessCleanConfig(config = {}, fullConfig) {
     if (!config.patterns || !config.patterns.length) {
-        config.patterns = globs.paths(getPaths.getDestPath()).generate();
+        config.patterns = globs.paths(getDestPath()).generate();
     } else {
-        config.patterns = globs.paths(getPaths.getDestPath()).paths(config.patterns).generate();
+        config.patterns = globs.paths(getDestPath()).paths(config.patterns).generate();
     }
 
     return config;

package/tasks/clean/task.js

@@ -1,7 +1,7 @@
-const del = require('del')
-const getConfig = require('./../../lib/get-config');
+import del from 'del';
+import { getTaskConfig } from '../../lib/get-config.js';
 
-exports.beforeBuild = function clean (callback) {
-    const patterns = getConfig.getTaskConfig('clean', 'patterns');
+export function beforeBuild(callback) {
+    const patterns = getTaskConfig('clean', 'patterns');
     return del(patterns, { force: true });
-};
+}

package/tasks/data/config.js

@@ -1,36 +1,34 @@
+import dataLoaderJs from './data-loader-js.js';
+import dataLoaderJson from './data-loader-json.js';
+
 /**
  * Data loading for HTML task
  * This task doesn't have actual task, instead it's used by 'html' task
  */
 
-exports.data = {
-    extensions: [
-        'js',
-        'json'
-    ],
+export const data = {
+    extensions: ['js', 'json'],
 
     // Data loaders for extensions, allows to add custom loaders
     loaders: {
-        js: require('./data-loader-js'),
-        json: require('./data-loader-json'),
+        js: dataLoaderJs,
+        json: dataLoaderJson,
     },
 
     // Glob list of files, which to ignore, relative to the data source folder
     // see https://gulpjs.com/docs/en/getting-started/explaining-globs/
-    ignore: [
-    ],
+    ignore: [],
 
     // Group data by filename (without extension + cammelCase)
     // eg, person-names.js -> {'personNames': ...}
     groupByFileName: false,
 };
 
-
 /**
  * Paths relative to the global src and dest folders
  */
-exports.paths = {
+export const paths = {
     data: {
-        'src': 'html/data',
-    }
+        src: 'html/data',
+    },
 };

package/tasks/data/data-loader-js.js

@@ -1,5 +1,14 @@
-module.exports = function dataLoaderJS (fileName) {
+import { createRequire } from 'node:module';
+const require = createRequire(import.meta.url);
+
+export default function dataLoaderJS (fileName) {
     // Re-load script each time this function is called
     delete require.cache[require.resolve(fileName)];
-    return require(fileName);
+    const data = require(fileName);
+
+    if (data && Object.prototype.toString.call(data) === '[object Module]') {
+        return data.default;
+    } else {
+        return data;
+    }
 };

package/tasks/data/data-loader-json.js

@@ -1,5 +1,5 @@
-const fs = require('fs');
+import fs from 'fs';
 
-module.exports = function dataLoaderJSON (fileName) {
+export default function dataLoaderJSON(fileName) {
     return JSON.parse(fs.readFileSync(fileName, 'utf8'));
-};
+}

package/tasks/data/get-data.js

@@ -1,79 +1,82 @@
-const path = require('path');
-const reduce = require('lodash/reduce');
-const micromatch = require('micromatch'); // gulp dependency
+import path from 'path';
+import reduce from 'lodash/reduce.js';
+import micromatch from 'micromatch'; // gulp dependency
 
-const merge = require('../../lib/merge');
-const getPaths = require('../../lib/get-path');
-const getConfig = require('../../lib/get-config');
-const logError = require('../../lib/log-error');
-const getFileNamesSync = require('../../lib/get-file-names');
-const camelizeFileName = require('../../lib/camelize-file-name');
-const getEnvData = require('../env/get-env');
+import merge from '../../lib/merge.js';
+import { getSourcePaths, getPathConfig } from '../../lib/get-path.js';
+import { getTaskConfig } from '../../lib/get-config.js';
+import logError from '../../lib/log-error.js';
+import getFileNamesSync from '../../lib/get-file-names.js';
+import camelizeFileName from '../../lib/camelize-file-name.js';
+import getEnvData from '../env/get-env.js';
 
-function getData () {
-    const folders = getPaths.getSourcePaths('data');
-    const extensions = getConfig.getTaskConfig('data', 'extensions');
-    const loaders = getConfig.getTaskConfig('data', 'loaders');
-    const ignore = getConfig.getTaskConfig('data', 'ignore');
-    const group = getConfig.getTaskConfig('data', 'groupByFileName');
+function getData() {
+    const folders = getSourcePaths('data');
+    const extensions = getTaskConfig('data', 'extensions');
+    const loaders = getTaskConfig('data', 'loaders');
+    const ignore = getTaskConfig('data', 'ignore');
+    const group = getTaskConfig('data', 'groupByFileName');
     const envData = getEnvData();
 
     // Merge into process.env before loading data because these may be used
     // in data
     merge(process.env, envData.env);
 
-    const data = reduce(folders, (data, folder) => {
-        getFileNamesSync(folder).forEach(fileName => {
-            // Ignore files matching 'ignore' list
-            if (ignore.length && micromatch.isMatch(fileName, ignore)) {
-                return;
-            }
+    const data = reduce(
+        folders,
+        (data, folder) => {
+            getFileNamesSync(folder).forEach((fileName) => {
+                // Ignore files matching 'ignore' list
+                if (ignore.length && micromatch.isMatch(fileName, ignore)) {
+                    return;
+                }
 
-            // Ignore files starting with underscore
-            if (fileName[0] !== '_') {
-                const extension = fileName.split('.').pop();
+                // Ignore files starting with underscore
+                if (fileName[0] !== '_') {
+                    const extension = fileName.split('.').pop();
 
-                if (extension && extensions.indexOf(extension) !== -1) {
-                    if (extension in loaders) {
-                        try {
-                            const fullFilePath = path.resolve(folder, fileName);
-                            const fileData = loaders[extension](fullFilePath);
+                    if (extension && extensions.indexOf(extension) !== -1) {
+                        if (extension in loaders) {
+                            try {
+                                const fullFilePath = path.resolve(folder, fileName);
+                                const fileData = loaders[extension](fullFilePath);
 
-                            if (group) {
-                                // Group data
-                                const name = camelizeFileName(fileName);
-                                data = merge(data, {[name]: fileData});
-                            } else {
-                                // Merge together
-                                data = merge(data, fileData);
+                                if (group) {
+                                    // Group data
+                                    const name = camelizeFileName(fileName);
+                                    data = merge(data, { [name]: fileData });
+                                } else {
+                                    // Merge together
+                                    data = merge(data, fileData);
+                                }
+                            } catch (err) {
+                                logError({
+                                    message: `Failed to parse "${path.join(getPathConfig().src, getPathConfig().data.src, fileName)}"`,
+                                    plugin: 'data',
+                                });
                             }
-                        } catch (err) {
+                        } else {
                             logError({
-                                'message': `Failed to parse "${ path.join(getPaths.getPathConfig().src, getPaths.getPathConfig().data.src, fileName) }"`,
-                                'plugin': 'data'
+                                message: `Data loader for files with "${extension}" extension is not defined in configuration data.loaders property`,
+                                plugin: 'data',
                             });
                         }
-                    } else {
-                        logError({
-                            'message': `Data loader for files with "${ extension }" extension is not defined in configuration data.loaders property`,
-                            'plugin': 'data'
-                        });
                     }
                 }
-            }
-        });
+            });
 
-        return data;
-    }, {});
+            return data;
+        },
+        {},
+    );
 
     // Merge with env variables
     return merge(data, envData.twig);
 }
 
-
 let cache = null;
 
-module.exports = function (options) {
+export default function (options) {
     const build = options && !!options.build;
 
     return function () {
@@ -89,5 +92,5 @@ module.exports = function (options) {
             cache = null;
             return getData();
         }
-    }
+    };
 }

package/tasks/env/config.js

@@ -7,14 +7,14 @@
  *     in JS `host` is accessible as `process.env.host`
  */
 
-exports.env = {
+export const env = {
     // How env variable names should be remapped
     // Example:
     //     map: { 'HOST': 'host', 'RECAPTCHA3_PUBLIC_KEY': 'recaptcha3_site_key' }
     map: {}
 };
 
-exports.paths = {
+export const paths = {
     // Env files which to load relative to project folder
     env: [
         '../.env',

package/tasks/env/get-env.js

@@ -1,17 +1,18 @@
-const paths = require('../../lib/get-path');
-const dotenv = require('dotenv');
-const getConfig = require('../../lib/get-config');
+import dotenv from 'dotenv';
+import nanomemoize from 'nano-memoize';
+import { getPathConfig, getProjectPath } from '../../lib/get-path.js';
+import { getTaskConfig } from '../../lib/get-config.js';
 
-function escapeJSVariable (value) {
+function escapeJSVariable(value) {
     if (value === 'true' || value === 'false' || value === true || value === false || !isNaN(value)) {
         return value;
     } else {
         // Convert to string
-        return "'" + value.replace(/\\/g, '\\\\').replace(/'/g, '\\\'').replace(/\n/g, '\\n') + "'";
+        return "'" + value.replace(/\\/g, '\\\\').replace(/'/g, "\\'").replace(/\n/g, '\\n') + "'";
     }
 }
 
-function normalizeTwigVariable (value) {
+function normalizeTwigVariable(value) {
     if (value === 'true') {
         return true;
     } else if (value === 'false') {
@@ -23,14 +24,13 @@ function normalizeTwigVariable (value) {
     }
 }
 
-function getEnvData () {
+/**
+ * Load data from the .env files
+ * @returns {object} List of environment variables
+ */
+export const loadEnvData = nanomemoize.nanomemoize(function () {
     const envVariables = {};
-    const twigVariables = {};
-    const scssVariables = { env: { _tmp: 1 } }; // _tmp is used to avoid SCSS error if object is empty
-    const jsVariables = {};
-    const envOutVariables = {};
-
-    const envFiles = paths.getPathConfig().env.map((path) => paths.getProjectPath(path));
+    const envFiles = getPathConfig().env.map((path) => getProjectPath(path));
 
     dotenv.config({
         // dotenv file order is reversed, values in first file overwrite all other
@@ -40,17 +40,34 @@ function getEnvData () {
         quiet: true,
     });
 
+    // Set assets version if it doesn't exist
+    envVariables['ASSETS_VERSION'] = envVariables['ASSETS_VERSION'] || String(Math.floor(Date.now() / 1000));
+
+    return envVariables;
+});
+
+/**
+ * Returns environment variables mapped to the specified names
+ * @returns {object} Mapped environment variables
+ */
+export default function getEnvData() {
+    const envVariables = loadEnvData();
+    const twigVariables = {};
+    const scssVariables = { env: { _tmp: 1 } }; // _tmp is used to avoid SCSS error if object is empty
+    const jsVariables = {};
+    const envOutVariables = {};
+
     // Remap property names
-    const map = getConfig.getTaskConfig('env', 'map');
+    const map = getTaskConfig('env', 'map');
 
-    Object.keys(map).forEach(key => {
+    Object.keys(map).forEach((key) => {
         if (key in envVariables) {
             const value = envVariables[key];
             const camelCase = map[key];
             const kebabCase = map[key];
             twigVariables[camelCase] = normalizeTwigVariable(value);
             envOutVariables[camelCase] = value;
-            jsVariables[`process.env.${ camelCase }`] = escapeJSVariable(value);
+            jsVariables[`process.env.${camelCase}`] = escapeJSVariable(value);
             scssVariables.env[kebabCase] = value;
         }
     });
@@ -60,7 +77,5 @@ function getEnvData () {
         sass: scssVariables,
         js: jsVariables,
         env: envOutVariables,
-    }
+    };
 }
-
-module.exports = getEnvData;

package/tasks/fonts/config.js

@@ -1,4 +1,6 @@
-exports.fonts = {
+import * as fontTask from './task.js';
+
+export const fonts = {
     // Glob list of files, which to ignore, relative to the font source folder
     // see https://gulpjs.com/docs/en/getting-started/explaining-globs/
     ignore: [],
@@ -7,19 +9,16 @@ exports.fonts = {
     extensions: ['woff2', 'woff', 'eot', 'ttf', 'svg', 'otf'],
 };
 
-exports.tasks = {
-    fonts: [
-        require('./task'),
-    ]
+export const tasks = {
+    fonts: [fontTask],
 };
 
-
 /**
  * Paths relative to the global src and dest folders
  */
-exports.paths = {
+export const paths = {
     fonts: {
-        'src': 'fonts',
-        'dest': 'assets/fonts',
-    }
+        src: 'fonts',
+        dest: 'assets/fonts',
+    },
 };

package/tasks/fonts/task.js

@@ -1,47 +1,47 @@
-const gulp = require('gulp');
-const { nanomemoize } = require('nano-memoize');
+import gulp from 'gulp';
+import nanomemoize from 'nano-memoize';
 
-const globs = require('./../../lib/globs-helper');
-const getPaths = require('./../../lib/get-path');
-const getConfig = require('./../../lib/get-config');
+import globs from './../../lib/globs-helper.js';
+import { getSourcePaths, getDestPath } from './../../lib/get-path.js';
+import { getTaskConfig } from './../../lib/get-config.js';
 
-const taskStart = require('../../lib/gulp/task-start');
-const taskEnd = require('../../lib/gulp/task-end');
-const taskBeforeDest = require('../../lib/gulp/task-before-dest');
-const taskWatch = require('../../lib/gulp/task-watch');
+import taskStart from '../../lib/gulp/task-start.js';
+import taskEnd from '../../lib/gulp/task-end.js';
+import taskBeforeDest from '../../lib/gulp/task-before-dest.js';
+import taskWatch from '../../lib/gulp/task-watch.js';
 
 const getWatchGlobPaths = function (forChokidar = false) {
-    const sourcePaths = getPaths.getSourcePaths('fonts');
-    const extensions = getConfig.getTaskConfig('fonts', 'extensions');
-    const ignore = getConfig.getTaskConfig('fonts', 'ignore');
+    const sourcePaths = getSourcePaths('fonts');
+    const extensions = getTaskConfig('fonts', 'extensions');
+    const ignore = getTaskConfig('fonts', 'ignore');
 
     return globs.generate(
         globs.paths(sourcePaths).filesWithExtensions(extensions), // Files to watch
-        globs.paths(sourcePaths).paths(ignore).ignore(),          // List of files which to ignore
+        globs.paths(sourcePaths).paths(ignore).ignore(), // List of files which to ignore
         forChokidar,
     );
 };
-const getGlobPaths = nanomemoize(function () {
+const getGlobPaths = nanomemoize.nanomemoize(function () {
     return getWatchGlobPaths(false);
 });
 
+function fonts() {
+    return (
+        gulp
+            .src(getGlobPaths(), { since: gulp.lastRun(fonts) })
+            .pipe(taskStart())
 
-function fonts () {
-    return gulp
-        .src(getGlobPaths(), { since: gulp.lastRun(fonts) })
-        .pipe(taskStart())
+            .pipe(taskBeforeDest())
+            .pipe(gulp.dest(getDestPath('fonts')))
 
-        .pipe(taskBeforeDest())
-        .pipe(gulp.dest(getPaths.getDestPath('fonts')))
-
-        // Reload on change
-        .pipe(taskEnd());
+            // Reload on change
+            .pipe(taskEnd())
+    );
 }
 
-function fontsWatch () {
+function fontsWatch() {
     return taskWatch(getWatchGlobPaths(true), fonts);
 }
 
-
-exports.build = fonts;
-exports.watch = fontsWatch;
+export const build = fonts;
+export const watch = fontsWatch;

package/tasks/global/config.js

@@ -1,7 +1,7 @@
 /**
  * Paths relative to the project path from where `npm run ...` command is run
  */
-exports.paths = {
+export const paths = {
     src: './src',
     dest: './public',
 };

package/tasks/html/config.js

@@ -1,4 +1,6 @@
-exports.html = {
+import * as htmlTask from './task.js';
+
+export const html = {
     // Engine is a function which returns a gulp pipe function, eg. sass()
     // Intended to be used by plugins, not manually
     engine: null,
@@ -8,37 +10,33 @@ exports.html = {
 
     // Glob list of files, which to ignore, relative to the html source folder
     // see https://gulpjs.com/docs/en/getting-started/explaining-globs/
-    ignore: [
-    ],
+    ignore: [],
 
     // Production only settings, overwrites default settings
     production: {
         // Enable HTML minification
         htmlmin: {
-            collapseWhitespace: true
-        }
+            collapseWhitespace: true,
+        },
     },
 
     // Development only settings, overwrites default settings
     development: {
         // Disable HTML minification
-        htmlmin: false
+        htmlmin: false,
     },
 };
 
-exports.tasks = {
-    html: [
-        require('./task'),
-    ]
+export const tasks = {
+    html: [htmlTask],
 };
 
-
 /**
  * Paths relative to the global src and dest folders
  */
-exports.paths = {
+export const paths = {
     html: {
-        'src': 'html',
-        'dest': '',
-    }
+        src: 'html',
+        dest: '',
+    },
 };