eleventy-auto-cache-buster 0.0.1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,41 @@
+name: Publish npm package
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  github-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+
+      - run: yarn install --immutable
+
+      - uses: ncipollo/release-action@v1.12.0
+        with:
+          artifacts: "11tyAutoCacheBuster.js"
+
+  npm-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - run: yarn install --immutable
+
+      - run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  

package/11tyAutoCacheBuster.js

@@ -0,0 +1,87 @@
+const fs = require("fs");
+const crypto = require("crypto");
+const glob = require("glob");
+
+function hash(content, algorithm="md5") {
+    const currentHash = crypto.createHash(algorithm);
+    currentHash.setEncoding("hex");
+    currentHash.write(content);
+    currentHash.end();
+    return currentHash.read();
+}
+
+function logRegular(string) {
+    console.log(string);
+}
+
+function _logColour(string, colourCode) {
+    console.log(`\x1b[${colourCode}m${string} \x1b[0m`);
+}
+
+function logGreen(string) {
+    _logColour(string, "32");
+}
+
+function logYellow(string) {
+    _logColour(string, "33");
+}
+
+function logRed(string) {
+    _logColour(string, "31");
+}
+
+
+module.exports = function(eleventyConfig, globstring="**/*.{css,js,png,jpg,jpeg,gif,mp4,ico}") {
+    eleventyConfig.on("eleventy.after", async ({ dir, results, runMode, outputMode }) => {
+        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));
+            logGreen(`[ACB] ${assetPath} hash = ${assetHash}`);
+
+            assetPaths.push({
+                assetPath: assetPath.replace(dir.output, ""),
+                assetHash: assetHash
+            });
+        });
+
+        logYellow(`[ACB] Collected all asset hashes!`);
+        logRegular(`[ACB] Replacing in output...`);
+
+        // For every file Eleventy outputs
+        results.forEach(({inputPath, outputPath, url, content}) => {
+            let outputData = "";  // Assigned later
+            let outputChanged = false;  // Check if any hashes have been added
+
+            // Read the output content
+            fs.readFile(outputPath, encoding="UTF-8", (err, data) => { 
+                if (err) {
+                    logRed(err);
+                    throw err;
+                }
+                // Save the output data
+                outputData = data;
+
+                
+                assetPaths.forEach(({assetPath, assetHash}) => {
+                    if (data.includes(assetPath)) {
+                        logGreen(`[ACB] ${outputPath} contains asset ${assetPath}`)
+                        outputData = outputData.replace(assetPath, assetPath + "?v=" + assetHash);
+                        outputChanged = true;
+                        
+                    } else {
+                        logRegular(`[ACB] ${outputPath} does NOT contain asset ${assetPath}. Skipping`)                        
+                    }
+                });
+
+                if (outputChanged) {
+                    fs.writeFile(outputPath, outputData, () => {
+                        logGreen(`[ACB] Added hashes to ${outputPath}`);
+                    });
+                }
+            });
+        });
+    });
+}

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "eleventy-auto-cache-buster",
+  "version": "0.0.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",
+  "dependencies": {
+    "glob": "^10.3.10"
+  }
+}