@videinfra/static-website-builder 2.0.2 → 2.0.4

package/tasks/data/config.js

@@ -1,34 +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
- */
-
-export const data = {
-    extensions: ['js', 'json'],
-
-    // Data loaders for extensions, allows to add custom loaders
-    loaders: {
-        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: [],
-
-    // Group data by filename (without extension + cammelCase)
-    // eg, person-names.js -> {'personNames': ...}
-    groupByFileName: false,
-};
-
-/**
- * Paths relative to the global src and dest folders
- */
-export const paths = {
-    data: {
-        src: 'html/data',
-    },
-};
+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
+ */
+
+export const data = {
+    extensions: ['js', 'json'],
+
+    // Data loaders for extensions, allows to add custom loaders
+    loaders: {
+        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: [],
+
+    // Group data by filename (without extension + cammelCase)
+    // eg, person-names.js -> {'personNames': ...}
+    groupByFileName: false,
+};
+
+/**
+ * Paths relative to the global src and dest folders
+ */
+export const paths = {
+    data: {
+        src: 'html/data',
+    },
+};

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

@@ -1,14 +1,14 @@
-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)];
-    const data = require(fileName);
-
-    if (data && Object.prototype.toString.call(data) === '[object Module]') {
-        return data.default;
-    } else {
-        return data;
-    }
-};
+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)];
+    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 @@
-import fs from 'fs';
-
-export default function dataLoaderJSON(fileName) {
-    return JSON.parse(fs.readFileSync(fileName, 'utf8'));
-}
+import fs from 'fs';
+
+export default function dataLoaderJSON(fileName) {
+    return JSON.parse(fs.readFileSync(fileName, 'utf8'));
+}

package/tasks/data/get-data.js

@@ -1,96 +1,96 @@
-import path from 'path';
-import reduce from 'lodash/reduce.js';
-import micromatch from 'micromatch'; // gulp dependency
-
-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 = 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;
-                }
-
-                // 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 (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',
-                                });
-                            }
-                        } else {
-                            logError({
-                                message: `Data loader for files with "${extension}" extension is not defined in configuration data.loaders property`,
-                                plugin: 'data',
-                            });
-                        }
-                    }
-                }
-            });
-
-            return data;
-        },
-        {},
-    );
-
-    // Merge with env variables
-    return merge(data, envData.twig);
-}
-
-let cache = null;
-
-export default function (options) {
-    const build = options && !!options.build;
-
-    return function () {
-        if (build) {
-            // Cache during full build
-            if (!cache) {
-                cache = getData();
-            }
-
-            return cache;
-        } else {
-            // Don't cache during watch build
-            cache = null;
-            return getData();
-        }
-    };
-}
+import path from 'path';
+import reduce from 'lodash/reduce.js';
+import micromatch from 'micromatch'; // gulp dependency
+
+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 = 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;
+                }
+
+                // 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 (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',
+                                });
+                            }
+                        } else {
+                            logError({
+                                message: `Data loader for files with "${extension}" extension is not defined in configuration data.loaders property`,
+                                plugin: 'data',
+                            });
+                        }
+                    }
+                }
+            });
+
+            return data;
+        },
+        {},
+    );
+
+    // Merge with env variables
+    return merge(data, envData.twig);
+}
+
+let cache = null;
+
+export default function (options) {
+    const build = options && !!options.build;
+
+    return function () {
+        if (build) {
+            // Cache during full build
+            if (!cache) {
+                cache = getData();
+            }
+
+            return cache;
+        } else {
+            // Don't cache during watch build
+            cache = null;
+            return getData();
+        }
+    };
+}

package/tasks/env/config.js

@@ -1,23 +1,26 @@
-/**
- * Enviromental variable loading configuration
- * Environment variables are loaded from .env files and remapped so that they can
- * be used in TWIG, SASS and JavaScript:
- *     in TWIG `host` is accessible as `host`
- *     in SCSS `host` is accessible as `map-get($env, host)`
- *     in JS `host` is accessible as `process.env.host`
- */
-
-export const env = {
-    // How env variable names should be remapped
-    // Example:
-    //     map: { 'HOST': 'host', 'RECAPTCHA3_PUBLIC_KEY': 'recaptcha3_site_key' }
-    map: {}
-};
-
-export const paths = {
-    // Env files which to load relative to project folder
-    env: [
-        '../.env',
-        '../.env.local',
-    ],
-};
+/**
+ * Enviromental variable loading configuration
+ * Environment variables are loaded from .env files and remapped so that they can
+ * be used in TWIG, SASS and JavaScript:
+ *     in TWIG `host` is accessible as `host`
+ *     in SCSS `host` is accessible as `map-get($env, host)`
+ *     in JS `host` is accessible as `process.env.host`
+ */
+
+export const env = {
+    // Write ASSET_VERSION to .env file to enable cache busting
+    writeAssetVersion: false,
+
+    // How env variable names should be remapped
+    // Example:
+    //     map: { 'HOST': 'host', 'RECAPTCHA3_PUBLIC_KEY': 'recaptcha3_site_key' }
+    map: {}
+};
+
+export const paths = {
+    // Env files which to load relative to project folder
+    env: [
+        '../.env',
+        '../.env.local',
+    ],
+};

package/tasks/env/get-env.js

@@ -1,81 +1,113 @@
-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) {
-    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') + "'";
-    }
-}
-
-function normalizeTwigVariable(value) {
-    if (value === 'true') {
-        return true;
-    } else if (value === 'false') {
-        return false;
-    } else if (value !== '' && !isNaN(value)) {
-        return parseFloat(value);
-    } else {
-        return value;
-    }
-}
-
-/**
- * Load data from the .env files
- * @returns {object} List of environment variables
- */
-export const loadEnvData = nanomemoize.nanomemoize(function () {
-    const envVariables = {};
-    const envFiles = getPathConfig().env.map((path) => getProjectPath(path));
-
-    dotenv.config({
-        // dotenv file order is reversed, values in first file overwrite all other
-        // file values
-        path: envFiles.reverse(),
-        processEnv: envVariables,
-        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 = getTaskConfig('env', 'map');
-
-    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);
-            scssVariables.env[kebabCase] = value;
-        }
-    });
-
-    return {
-        twig: twigVariables,
-        sass: scssVariables,
-        js: jsVariables,
-        env: envOutVariables,
-    };
-}
+import fs from 'node:fs';
+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) {
+    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') + "'";
+    }
+}
+
+function normalizeTwigVariable(value) {
+    if (value === 'true') {
+        return true;
+    } else if (value === 'false') {
+        return false;
+    } else if (value !== '' && !isNaN(value)) {
+        return parseFloat(value);
+    } else {
+        return value;
+    }
+}
+
+/**
+ * Write asset version to the env file
+ * @param {string} assetVersion Asset version string
+ */
+function writeEnvFileAssetVersion(assetVersion) {
+    const envFilePath = getTaskConfig('env', 'writeAssetVersion');
+    if (envFilePath) {
+        const envFile = getProjectPath(envFilePath);
+
+        try {
+            let envContent = fs.readFileSync(envFile, 'utf8');
+
+            // Replace ASSETS_VERSION if it exists
+            if (envContent.includes('ASSETS_VERSION=')) {
+                envContent = envContent.replace(/ASSETS_VERSION=.*/, `ASSETS_VERSION=${assetVersion}`);
+            } else {
+                envContent += `\nASSETS_VERSION=${assetVersion}`;
+            }
+
+            fs.writeFileSync(envFile, envContent);
+        } catch (error) {
+            console.error(`Error writing env file "${envFile}"`, error);
+        }
+    }
+}
+
+/**
+ * Load data from the .env files
+ * @returns {object} List of environment variables
+ */
+export const loadEnvData = nanomemoize.nanomemoize(function () {
+    const envVariables = {};
+    const envFiles = getPathConfig().env.map((path) => getProjectPath(path));
+
+    dotenv.config({
+        // dotenv file order is reversed, values in first file overwrite all other
+        // file values
+        path: envFiles.reverse(),
+        processEnv: envVariables,
+        quiet: true,
+    });
+
+    // Set assets version if it doesn't exist
+    if (!envVariables['ASSETS_VERSION'] || getTaskConfig('env', 'writeAssetVersion')) {
+        envVariables['ASSETS_VERSION'] = String(Math.floor(Date.now() / 1000));
+        writeEnvFileAssetVersion(envVariables['ASSETS_VERSION']);
+    }
+
+    return envVariables;
+});
+
+/**
+ * Returns environment variables mapped to the specified names
+ * @returns {object} Mapped environment variables
+ */
+const getEnvData = nanomemoize.nanomemoize(function () {
+    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 = getTaskConfig('env', 'map');
+
+    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);
+            scssVariables.env[kebabCase] = value;
+        }
+    });
+
+    return {
+        twig: twigVariables,
+        sass: scssVariables,
+        js: jsVariables,
+        env: envOutVariables,
+    };
+});
+
+export default getEnvData;

package/tasks/fonts/config.js

@@ -1,24 +1,24 @@
-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: [],
-
-    // Font file extensions
-    extensions: ['woff2', 'woff', 'eot', 'ttf', 'svg', 'otf'],
-};
-
-export const tasks = {
-    fonts: [fontTask],
-};
-
-/**
- * Paths relative to the global src and dest folders
- */
-export const paths = {
-    fonts: {
-        src: 'fonts',
-        dest: 'assets/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: [],
+
+    // Font file extensions
+    extensions: ['woff2', 'woff', 'eot', 'ttf', 'svg', 'otf'],
+};
+
+export const tasks = {
+    fonts: [fontTask],
+};
+
+/**
+ * Paths relative to the global src and dest folders
+ */
+export const paths = {
+    fonts: {
+        src: 'fonts',
+        dest: 'assets/fonts',
+    },
+};