eleventy-auto-cache-buster 0.8.4 → 0.9.1

package/11tyAutoCacheBuster.js

@@ -2,6 +2,7 @@ const fs     = require("fs");
 const path   = require("path");
 const crypto = require("crypto");
 const glob   = require("glob");
+const escape = require("regexp.escape");
 
 let enableLogging = false;
 let algorithm     = "md5";
@@ -53,14 +54,16 @@ const defaultOptions = {
 
 function collectLocalAssets(globResults=[], outputDir, extensions=defaultOptions.extensions) {
     const assetPaths = [];
-    globResults.forEach((assetPath) => {
-        assetPath = assetPath.replace(/\\/g, "/")
+    globResults.forEach((assetFullPath) => {
+        assetFullPath = assetFullPath.replace(/\\/g, "/");
+        const assetPath = assetFullPath.replace(outputDir, "") 
+        
         if (!extensions.includes(path.extname(assetPath).substring(1))) {
             return;
         }
 
         logGreen(`[ACB] ${assetPath} is an asset! Calculating hash...`);
-        const assetHash = hashFunction(fs.readFileSync(assetPath));
+        const assetHash = hashFunction(fs.readFileSync(assetFullPath));
         logGreen(`[ACB] ${assetPath} hash = ${assetHash}`);
 
         assetPaths.push({
@@ -91,47 +94,37 @@ function writeAsync(outputPath, outputData) {
 function replaceAssetsInFile(fileData, filePath, assetPathsAndHashes, writeFunc) {
     let outputString  = fileData;
     let outputChanged = false;  // Check if any hashes have been added
-
-    // Check for every asset
     assetPathsAndHashes.forEach(({assetPath, assetHash}) => {
-        let found = false;
-        let indexPush = 0;  // With values being replaced, the index values will need to be adjusted
-        const regex = new RegExp(assetPath.replaceAll("/", "\\/").replaceAll("?", "\\?") + '.*?(?=")', "g")
-        const matches = outputString.matchAll(regex);
-
-        while ((match = matches.next()).done != true) {
-            found = true;
-            const value = match.value
-            const path = value[0]
-            logGreen(`[ACB] ${filePath} contains asset ${assetPath} (matched on: ${path})`)
-
-            // Optionally truncate
-            if (hashTruncate > 0) {
-                assetHash = assetHash.substring(0, hashTruncate);
-            }
-
-            const seperator = path.includes("?") ? "&" : "?";
-            const newPath = `${path}${seperator}v=${assetHash}`;
-            // Replace asset path with asset path with hash
-            outputString = outputString.substring(0, value.index + indexPush)
-                + newPath
-                + outputString.substring(value.index + indexPush + path.length)
-
-            indexPush += newPath.length - path.length;
-
-            // Write changes to file
-            outputChanged = true;
+        // Optionally truncate
+        if (hashTruncate > 0) {
+            assetHash = assetHash.substring(0, hashTruncate);
         }
-        if (!found) {
-            logRegular(`[ACB] ${filePath} does NOT contain asset ${assetPath}. Skipping`)                        
+        // find and replace all instances of the asset URL
+        const assetPathRegexString = escape(assetPath);
+        const regexWithQueryString = new RegExp(`${assetPathRegexString}\\?`, 'g')
+        const regexWithoutQueryString = new RegExp(`${assetPathRegexString}(?!\\?)`, 'g')
+        const newOutputString = outputString
+            .replaceAll(regexWithQueryString, `${assetPath}?v=${assetHash}&`)
+            .replaceAll(regexWithoutQueryString, `${assetPath}?v=${assetHash}`);
+        // If anything was replaced, track that to write the file after all asset checks
+        if (newOutputString != outputString) {
+            logGreen(`[ACB] ${filePath} contains asset ${assetPath}`)
+            outputChanged = true;
+            outputString = newOutputString;
+        } else {
+            logRegular(`[ACB] ${filePath} does NOT contain asset ${assetPath}. Skipping`)   
         }
-    });
-
+    })
     if (outputChanged) {
         writeFunc(filePath, outputString);
     }
 }
 
+// Meant to normalise eleventt.after directories.output to dir.output style
+function stripPath(path) {
+    return path.replace(/^\.\//m, "");
+}
+
 module.exports = function(eleventyConfig, options=defaultOptions) {
     // Override default options with set options
     options = Object.assign(defaultOptions, options, {
@@ -154,9 +147,10 @@ module.exports = function(eleventyConfig, options=defaultOptions) {
     }
 
     if (runAsync) {
-        eleventyConfig.on("eleventy.after", async ({ dir, results, runMode, outputMode }) => {
-            logYellow(`[ACB] Collecting assets & calculating hashes using ${globstring}...`);
-            const assetPathsAndHashes = collectLocalAssets(await glob.glob(dir.output + "/" + globstring, globOptions), dir.output, extensions);
+        eleventyConfig.on("eleventy.after", async ({ directories, results, runMode, outputMode }) => {
+            const outputDir = stripPath(directories.output);
+            logYellow(`[ACB] Collecting assets & calculating hashes using ${globstring} in ${outputDir}...`);
+            const assetPathsAndHashes = collectLocalAssets(await glob.glob(outputDir + "/" + globstring, globOptions), outputDir, extensions);
 
             logRegular(`[ACB] Replacing in output...`);
             results.forEach(({inputPath, outputPath, url, content}) => {
@@ -173,9 +167,10 @@ module.exports = function(eleventyConfig, options=defaultOptions) {
             });
         });
     } else {
-        eleventyConfig.on("eleventy.after", ({ dir, results, runMode, outputMode }) => {
+        eleventyConfig.on("eleventy.after", ({ directories, results, runMode, outputMode }) => {
+            const outputDir = stripPath(directories.output);
             logYellow(`[ACB] Collecting assets & calculating hashes using ${globstring}...`);
-            const assetPathsAndHashes = collectLocalAssets(glob.globSync(dir.output + "/" + globstring, globOptions), dir.output, extensions);
+            const assetPathsAndHashes = collectLocalAssets(glob.globSync(outputDir + "/" + globstring, globOptions), outputDir, extensions);
 
             logRegular(`[ACB] Replacing in output...`);
             results.forEach(({inputPath, outputPath, url, content}) => {

package/package.json

@@ -1,21 +1,26 @@
 {
   "name": "eleventy-auto-cache-buster",
-  "version": "0.8.4",
+  "version": "0.9.1",
   "description": "Busts cache using ?v= with minimal configuration!",
   "main": "11tyAutoCacheBuster.js",
   "repository": "https://github.com/Denperidge/eleventy-auto-cache-buster.git",
   "author": "Denperidge",
   "license": "MIT",
   "scripts": {
-    "start": "pushd tests && RUNASYNC=0 USESERVE=1 HASHTRUNCATE=16 eleventy && popd",
+    "start": "pushd tests/scenarios/8-sync@3 && eleventy && popd",
     "test": "ava tests/test.mjs --timeout=30s"
   },
   "dependencies": {
-    "glob": "^13.0.6"
+    "glob": "^13.0.6",
+    "regexp.escape": "^2.0.1"
   },
   "devDependencies": {
     "@11ty/eleventy": "^3.1.2",
+    "@codestitchofficial/eleventy-plugin-minify": "^1.1.3",
     "ava": "^7.0.0",
-    "jsdom": "^28.1.0"
+    "eleventy-test": "^2.0.0",
+    "html-minifier-terser": "^7.2.0",
+    "jsdom": "^28.1.0",
+    "rss-parser": "^3.13.0"
   }
 }