eleventy-auto-cache-buster 0.7.0 → 0.8.1

package/11tyAutoCacheBuster.js

@@ -1,11 +1,11 @@
-const fs = require("fs");
-const path = require("path");
+const fs     = require("fs");
+const path   = require("path");
 const crypto = require("crypto");
-const glob = require("glob");
+const glob   = require("glob");
 
 let enableLogging = false;
-let algorithm = "md5";
-let hashTruncate = 12;
+let algorithm     = "md5";
+let hashTruncate  = 12;
 let hashFunction;
 
 function hash(content) {
@@ -41,13 +41,14 @@ function logRed(string) {
 }
 
 const defaultOptions = {
-    globstring: "**/*",
-    extensions: ["css", "js", "png", "jpg", "jpeg", "gif", "mp4", "ico"],
-    hashTruncate: 12,
-    runAsync: true,
+    globstring:    "**/*",
+    globOptions:   {nodir: true},
+    extensions:    ["css", "js", "png", "jpg", "jpeg", "gif", "mp4", "ico"],
+    hashTruncate:  12,
+    runAsync:      true,
     enableLogging: enableLogging,
     hashAlgorithm: algorithm,
-    hashFunction: hash,
+    hashFunction:  hash,
 }
 
 function collectLocalAssets(globResults=[], outputDir, extensions=defaultOptions.extensions) {
@@ -88,7 +89,7 @@ function writeAsync(outputPath, outputData) {
 }
 
 function replaceAssetsInFile(fileData, filePath, assetPathsAndHashes, writeFunc) {
-    let outputString = fileData;
+    let outputString  = fileData;
     let outputChanged = false;  // Check if any hashes have been added
 
     // Check for every asset
@@ -113,20 +114,20 @@ function replaceAssetsInFile(fileData, filePath, assetPathsAndHashes, writeFunc)
     if (outputChanged) {
         writeFunc(filePath, outputString);
     }
-
 }
 
 module.exports = function(eleventyConfig, options=defaultOptions) {
     // Override default options with set options
-    options = Object.assign(defaultOptions, options);
-    const globstring = options.globstring;
-    const extensions = options.extensions;
-    const runAsync = options.runAsync;
+    options = Object.assign(defaultOptions, options, {
+        // Object.assign seems to overwrite nested objects. @emiliorcueto added the clever handling below
+        globOptions: Object.assign(defaultOptions.globOptions, options.globOptions) // -- ensure `nodir` is always set
+    });
+    const { globstring, globOptions, extensions, runAsync }  = options;
     // Set options to globals
-    enableLogging = options.enableLogging;
-    hashTruncate = options.hashTruncate;
-    hashFunction = options.hashFunction;
-    algorithm = options.hashAlgorithm;
+    enableLogging     = options.enableLogging;
+    hashTruncate      = options.hashTruncate;
+    hashFunction      = options.hashFunction;
+    algorithm         = options.hashAlgorithm;
     
 
     // Setup
@@ -139,32 +140,35 @@ 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, {nodir: true}), dir.output, extensions);
+            const assetPathsAndHashes = collectLocalAssets(await glob.glob(dir.output + "/" + globstring, globOptions), dir.output, extensions);
 
             logRegular(`[ACB] Replacing in output...`);
             results.forEach(({inputPath, outputPath, url, content}) => {
-                fs.readFile(outputPath, encoding="UTF-8", (err, pageData) => { 
-                    if (err) {
-                        logRed(err);
-                        throw err;
-                    }
-                    // Save the output data
-                    replaceAssetsInFile(pageData, outputPath, assetPathsAndHashes, writeAsync);
-                });
+                if (!globOptions.ignore?.includes(outputPath)) { // -- Do not attempt to read explicitly ignored files as they may no longer exist!
+                    fs.readFile(outputPath, encoding="UTF-8", (err, pageData) => { 
+                        if (err) {
+                            logRed(err);
+                            throw err;
+                        }
+                        // Save the output data
+                        replaceAssetsInFile(pageData, outputPath, assetPathsAndHashes, writeAsync);
+                    });
+                }
             });
         });
     } else {
         eleventyConfig.on("eleventy.after", ({ dir, results, runMode, outputMode }) => {
             logYellow(`[ACB] Collecting assets & calculating hashes using ${globstring}...`);
-            const assetPathsAndHashes = collectLocalAssets(glob.globSync(dir.output + "/" + globstring, {nodir: true}), dir.output, extensions);
+            const assetPathsAndHashes = collectLocalAssets(glob.globSync(dir.output + "/" + globstring, globOptions), dir.output, extensions);
 
             logRegular(`[ACB] Replacing in output...`);
             results.forEach(({inputPath, outputPath, url, content}) => {
-                const pageData = fs.readFileSync(outputPath, encoding="UTF-8"); 
-                // Save the output data
-                replaceAssetsInFile(pageData, outputPath, assetPathsAndHashes, writeSync);
+                if (!globOptions.ignore?.includes(outputPath)) { // -- Do not attempt to read explicitly ignored files as they may no longer exist!
+                    const pageData = fs.readFileSync(outputPath, encoding="UTF-8"); 
+                    // Save the output data
+                    replaceAssetsInFile(pageData, outputPath, assetPathsAndHashes, writeSync);
+                }
             });
         });
     }
-
 }

package/README.md

@@ -45,6 +45,7 @@ module.exports = function (eleventyConfig) {
         hashTruncate: 0,  // Desired substring length of the hash. Set to 0 or lower to disable truncating
         runAsync: false,  // Whether to run asynchronously. Default is true
         globstring: "subdir/**/*",  // What glob string is used to locate assets.
+        globOptions: {nodir: true, ignore: ['node_modules/**', 'tmp/**']} // exclude multiple files or directories. (NOTE: `nodir` will automatically be set to true).  Reference: https://github.com/isaacs/node-glob#readme
         extensions: ["css"],  // What file extensions are accepted when locating assets.
         hashAlgorithm: "sha1",  // What hash method to pass to the hash function. See Node.js' crypto.createHash documentation.
         hashFunction: function (content) { return "example" }  // What function to run to calculate hashes. Overrides hashAlgorithm.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eleventy-auto-cache-buster",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "Busts cache using ?v= with minimal configuration!",
   "main": "11tyAutoCacheBuster.js",
   "repository": "https://github.com/Denperidge/eleventy-auto-cache-buster.git",