eleventy-auto-cache-buster 0.1.1 → 0.3.0

package/11tyAutoCacheBuster.js

@@ -2,7 +2,10 @@ const fs = require("fs");
 const crypto = require("crypto");
 const glob = require("glob");
 
-function hash(content, algorithm="md5") {
+let enableLogging = false;
+let algorithm = "md5";
+
+function hash(content) {
     const currentHash = crypto.createHash(algorithm);
     currentHash.setEncoding("hex");
     currentHash.write(content);
@@ -11,11 +14,15 @@ function hash(content, algorithm="md5") {
 }
 
 function logRegular(string) {
-    console.log(string);
+    if (enableLogging) {
+        console.log(string);
+    }
 }
 
 function _logColour(string, colourCode) {
-    console.log(`\x1b[${colourCode}m${string} \x1b[0m`);
+    if (enableLogging) {
+        console.log(`\x1b[${colourCode}m${string} \x1b[0m`);
+    }
 }
 
 function logGreen(string) {
@@ -30,15 +37,31 @@ function logRed(string) {
     _logColour(string, "31");
 }
 
+const defaultOptions = {
+    globstring: "**/*.{css,js,png,jpg,jpeg,gif,mp4,ico}",
+    enableLogging: enableLogging,
+    hashAlgorithm: algorithm,
+    hashFunction: hash,
+}
 
-module.exports = function(eleventyConfig, globstring="**/*.{css,js,png,jpg,jpeg,gif,mp4,ico}") {
+module.exports = function(eleventyConfig, options=defaultOptions) {
     eleventyConfig.on("eleventy.after", async ({ dir, results, runMode, outputMode }) => {
+
+        // Override default options with set options
+        options = Object.assign(defaultOptions, options);
+
+        // Set options to globals
+        enableLogging = options.enableLogging;
+        algorithm = options.hashAlgorithm;
+        const globstring = options.globstring;
+        const hashFunction = options.hashFunction;
+
         const assetPaths = [];
         logYellow(`[ACB] Collecting assets & calculating hashes using ${globstring}...`);
         (await glob.glob(dir.output + "/" + globstring)).forEach((assetPath) => {
             assetPath = assetPath.replace(/\\/g, "/")
             logGreen(`[ACB] ${assetPath} is an asset! Calculating hash...`);
-            const assetHash = hash(fs.readFileSync(assetPath));
+            const assetHash = hashFunction(fs.readFileSync(assetPath));
             logGreen(`[ACB] ${assetPath} hash = ${assetHash}`);
 
             assetPaths.push({

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Denperidge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# Eleventy-Auto-Cache-Buster
+An Eleventy content-hash based cache buster, not requiring any filters or code changes aside from adding the plugin in `.eleventy.js`!
+
+Turn...
+```html
+<link rel="icon" type="image/x-icon" href="/favicon.ico">
+<link rel="stylesheet" href="/stylesheet.css">
+```
+Into...
+```html
+<link rel="icon" type="image/x-icon" href="/favicon.ico?v=542610a0404a5b8a2f5459c0fc5b9691">
+<link rel="stylesheet" href="/stylesheet.css?v=c9ca3e51cf7edc4c86c5fef68361957c">
+```
+
+## How-to
+### Getting started
+1. Install the plugin
+    - Yarn: `yarn add -D eleventy-auto-cache-buster`
+    - Npm: `npm --save-dev eleventy-auto-cache-buster`
+2. Enable the plugin
+    ```js
+    // .eleventy.js
+    const eleventyAutoCacheBuster = require("eleventy-auto-cache-buster");
+
+    module.exports = function (eleventyConfig) {
+        eleventyConfig.addPlugin(eleventyAutoCacheBuster);
+        // ...
+    }
+    ```
+3. That's it! No further changes are required.
+
+### Changing options
+```js
+// .eleventy.js
+const eleventyAutoCacheBuster = require("eleventy-auto-cache-buster");
+
+module.exports = function (eleventyConfig) {
+    eleventyConfig.addPlugin(eleventyAutoCacheBuster, {
+        enableLogging: true,  // Whether to enable eleventy-auto-cache-buster logging.
+        globstring: "**/*.ico",  // What glob string is used to locate 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.
+    });
+    // ...
+}
+
+
+## License
+This project is licensed under the [MIT License](LICENSE).

package/package.json

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