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

package/eslint.config.js

@@ -0,0 +1,39 @@
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+	{
+        env: {
+            "browser": true,
+            "commonjs": true,
+            "es6": true,
+            "jquery": true
+        },
+        extends: "eslint:recommended",
+        parserOptions: {
+            "sourceType": "module"
+        },
+        rules: {
+            "linebreak-style": [
+                "error",
+                "unix"
+            ],
+            "quotes": [
+                "error",
+                "single"
+            ],
+            "semi": [
+                "error",
+                "always"
+            ],
+            "no-console": [
+                "warn", { "allow": ["warn", "error"] }
+            ],
+            "no-debugger": [
+                "warn"
+            ],
+            "no-unused-vars": [
+                "warn"
+            ]
+        }
+	},
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@videinfra/static-website-builder",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0",
   "description": "Customizable static site project builder",
   "license": "MIT",
   "engines": {

package/plugins/twig/symfony-filters/filters.js

@@ -1,4 +1,5 @@
 import { getTaskConfig }  from '../../../lib/get-config.js';
+import { loadEnvData } from '../../../tasks/env/get-env.js';
 import preposition_nbsp  from './preposition_nbsp.js';
 
 const exports = [];
@@ -32,19 +33,21 @@ exports.push({
 
 /**
  * Version filter
- * Adds a random version string to the url
+ * Adds a version string to the url
  *
  * @example
  *   {{ '/images/px.gif' | version }}
  *   Output: /images/px.gif?dshnv
  */
 
-const version = Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0, 5);
-
 exports.push({
     name: 'version',
     func: function (path) {
         if (!getTaskConfig('html', 'version')) return path;
+        const envData = loadEnvData();
+        const assetVersion = envData['ASSETS_VERSION'];
+
+        if (!assetVersion) return path;
 
         const normalizedPath = (path || path === 0 ? String(path) : '');
         const parts    = normalizedPath.match(/^([^?#]*)(\?[^#]*)?(#.*)?$/i);
@@ -52,7 +55,7 @@ exports.push({
         const params   = parts[2] || '';
         const hash     = parts[3] || '';
 
-        return pathname + params + (params ? '&' : '?') + version + hash;
+        return pathname + params + (params ? '&v=' : '?v=') + assetVersion + hash;
     }
 });
 

package/tasks/env/get-env.js

@@ -1,4 +1,5 @@
 import dotenv from 'dotenv';
+import nanomemoize from 'nano-memoize';
 import { getPathConfig, getProjectPath } from '../../lib/get-path.js';
 import { getTaskConfig } from '../../lib/get-config.js';
 
@@ -23,13 +24,12 @@ 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 = getPathConfig().env.map((path) => getProjectPath(path));
 
     dotenv.config({
@@ -40,6 +40,23 @@ 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 = getTaskConfig('env', 'map');
 
@@ -62,5 +79,3 @@ function getEnvData() {
         env: envOutVariables,
     };
 }
-
-export default getEnvData;

package/tasks/javascripts/preprocess-config.js

@@ -1,6 +1,6 @@
 import { getDestPath, getBuilderPath, getProjectPath, getSourcePath } from '../../lib/get-path.js';
 import merge from '../../lib/merge.js';
-import getEnvData from '../env/get-env.js';
+import getEnvData, { loadEnvData } from '../env/get-env.js';
 import get from 'lodash/get.js';
 import cloneDeep from 'lodash/cloneDeep.js';
 import replace from '@rollup/plugin-replace';
@@ -52,6 +52,20 @@ export default function preprocessJavascriptsConfig(config, fullConfig) {
             'process.env.NODE_ENV': JSON.stringify(global.production ? 'production' : 'development'),
         });
 
+        // Rewrite shared.js and rolldown-runtime.js to include cache busting asset version so that we could
+        // preload those assets using <link rel="preload" as="script" href="{{ asset(...) }}" />
+        const envData = loadEnvData();
+        const assetVersion = envData['ASSETS_VERSION'];
+        const replacements = {};
+
+        if (assetVersion) {
+            replacements['/rolldown-runtime.js'] = `/rolldown-runtime.js?v=${assetVersion}`;
+
+            if (entry.shared) {
+                replacements[`/${entry.shared}.js`] = `/${entry.shared}.js?v=${assetVersion}`;
+            }
+        }
+
         const buildConfig = merge(entryConfig, {
             rolldown: {
                 // Entries, this file is resolved by gulp-rolldown and converted into
@@ -62,8 +76,7 @@ export default function preprocessJavascriptsConfig(config, fullConfig) {
                     replace({
                         preventAssignment: true,
                         ...envVariables,
-                        // './shared.js': './shared.js?rcujz',
-                        // './rolldown-runtime.js': './rolldown-runtime.js?rcujz',
+                        ...replacements,
                     }),
                 ],
 

package/vendor/gulp-rolldown/index.js

@@ -4,6 +4,9 @@ import PluginError from 'plugin-error';
 import { watch, build } from 'rolldown';
 import browserSync from 'browser-sync';
 
+import virtualEntryPlugin from './plugin-virtual-entry.js';
+import rawPlugin from './plugin-raw.js';
+
 const PLUGIN_NAME = 'gulp-starter-rolldown';
 
 /**
@@ -26,37 +29,6 @@ function evalEntry(code) {
     return result;
 }
 
-/**
- * Virtual entry plugin to generate files from each of the entries in the entry file
- *
- * @param {object} entries Entries object from the entry file
- * @returns {object} Virtual entry plugin
- */
-function virtualEntryPlugin(entries) {
-    const keys = Object.keys(entries);
-
-    return {
-        name: 'virtual-entry-plugin', // this name will show up in logs and errors
-
-        resolveId: {
-            order: 'post',
-            handler(source) {
-                if (keys.includes(source)) {
-                    return source;
-                }
-                return null; // other ids should be handled as usual
-            },
-        },
-
-        load(id) {
-            if (keys.includes(id)) {
-                return entries[id].map((entry) => `import '${entry}';`).join('\n');
-            }
-            return null; // other ids should be handled as usual
-        },
-    };
-}
-
 const watcherList = {};
 
 // transformer class
@@ -116,18 +88,13 @@ class GulpRolldown extends Transform {
         }
 
         // Transform options
-        const fullDir = this.outputOptions.fullDir;
         const inputOptions = Object.assign({}, this.inputOptions);
         const outputOptions = Object.assign({}, this.outputOptions);
 
         delete inputOptions.entries;
-        delete outputOptions.fullDir;
 
         // Parse entry file
         const entryContent = evalEntry(file.contents.toString());
-        if (!entryContent) {
-            // @TODO Couldn't read entry file, throw an error???
-        }
 
         // Add code splitting with shared
         if (entries.shared) {
@@ -152,7 +119,7 @@ class GulpRolldown extends Transform {
 
         // Set input files
         inputOptions.input = Object.keys(entryContent);
-        inputOptions.plugins = [virtualEntryPlugin(entryContent)].concat(inputOptions.plugins || []);
+        inputOptions.plugins = [rawPlugin(), virtualEntryPlugin(entryContent)].concat(inputOptions.plugins || []);
 
         // Set full paths when running watch or build
         inputOptions.output = outputOptions;

package/vendor/gulp-rolldown/plugin-raw.js

@@ -0,0 +1,17 @@
+import fs from 'node:fs';
+
+export default function rawPlugin() {
+    return {
+        name: 'raw',
+        load: {
+            filter: {
+                id: /\?raw$/,
+            },
+            handler(id) {
+                const content = fs.readFileSync(id.replace('?raw', '')).toString('utf-8');
+                return `export default \`${content.replace(/`/g, '\\`')}\``;
+
+            }
+        },
+    };
+}

package/vendor/gulp-rolldown/plugin-virtual-entry.js

@@ -0,0 +1,30 @@
+/**
+ * Virtual entry plugin to generate files from each of the entries in the entry file
+ *
+ * @param {object} entries Entries object from the entry file
+ * @returns {object} Virtual entry plugin
+ */
+export default function virtualEntryPlugin(entries) {
+    const keys = Object.keys(entries);
+
+    return {
+        name: 'virtual-entry-plugin', // this name will show up in logs and errors
+
+        resolveId: {
+            order: 'post',
+            handler(source) {
+                if (keys.includes(source)) {
+                    return source;
+                }
+                return null; // other ids should be handled as usual
+            },
+        },
+
+        load(id) {
+            if (keys.includes(id)) {
+                return entries[id].map((entry) => `import '${entry}';`).join('\n');
+            }
+            return null; // other ids should be handled as usual
+        },
+    };
+}

package/.eslintignore

@@ -1,2 +0,0 @@
-src/javascripts/_entries.json
-src/static/sw.js

package/.eslintrc.js

@@ -1,35 +0,0 @@
-export default {
-    "env": {
-        "browser": true,
-        "commonjs": true,
-        "es6": true,
-        "jquery": true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "sourceType": "module"
-    },
-    "rules": {
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ],
-        "no-console": [
-            "warn", { "allow": ["warn", "error"] }
-        ],
-        "no-debugger": [
-            "warn"
-        ],
-        "no-unused-vars": [
-            "warn"
-        ]
-    }
-};