Support hooks for transforming build script output

[Beorn] / build.js

diff --git a/build.js b/build.js
index 024698acde71ebcb1fc22b8dd789320ec8cf0425..4c26518b85d4a2597126c582d50d305fd4ccd38c 100755 (executable)
--- a/build.js
+++ b/build.js
@@ -2,7 +2,7 @@
 // 🧸📔 Bjørn ∷ build.js
 // ====================================================================
 //
 // 🧸📔 Bjørn ∷ build.js
 // ====================================================================
 //

-// Copyright © 2022 Lady [@ Lady’s Computer].
+// Copyright © 2022‐2023 Lady [@ Lady’s Computer].

 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 //
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this


@@ -344,6 +344,7 @@ const applyMetadata = (node, metadata) => {
         // There is no content placeholder.
         /* do nothing */
       }
         // There is no content placeholder.
         /* do nothing */
       }

+      globalThis.bjørnTransformEntryHTML?.(document, metadata);

     } else {
       // This is not an XHTML template.
       /* do nothing */
     } else {
       // This is not an XHTML template.
       /* do nothing */


@@ -639,6 +640,7 @@ const fillOutHead = (document, metadata, type) => {
         .href("./feed.atom")``,
     );
   }
         .href("./feed.atom")``,
     );
   }

+  globalThis.bjørnTransformHead?.(head, metadata, type);

 };
 
 /**
 };
 
 /**


@@ -866,6 +868,7 @@ const metadataFromDocument = (
       /* do nothing */
     }
   }
       /* do nothing */
     }
   }

+  globalThis.bjørnTransformMetadata?.(result, documentType);

   return validateMetadata(result, documentType);
 };
 
   return validateMetadata(result, documentType);
 };
 


@@ -906,6 +909,31 @@ const validateMetadata = (metadata, type) => {
   }
 };
 
   }
 };
 

+{ // Set up global variables for use in hooks.
+  //
+  // Bjørn is principally built to be run from the command line (as a
+  // shell script) rather than conforming to typical Ecmascript module
+  // patterns. However, it recognizes hooks through various
+  // specially‐named properties on `globalThis`. After defining these
+  // hooks, a script can use a *dynamic* `import("./path/to/build.js")`
+  // to run the Bjørn build steps.
+  //
+  // To make writing scripts which make use of these hooks easier,
+  // infrastructural dependencies and useful functions are provided on
+  // `globalThis` so that wrapping scripts don’t have to attempt to
+  // manage the dependencies themselves.
+  //
+  // Note that the `Lemon/window` polyfill will already have
+  // established some D·O·M‐related global properties by the time this
+  // runs, so they don’t need to be redeclared here.
+  globalThis.Lemon = Lemon;
+  globalThis.Bjørn = {
+    addContent,
+    getLanguage,
+    setLanguage,
+  };
+}
+

 await (async () => { // this is the run script
   const writes = [];
 
 await (async () => { // this is the run script
   const writes = [];
 


@@ -1114,6 +1142,7 @@ await (async () => { // this is the run script
       /* do nothing */
     }
   }
       /* do nothing */
     }
   }

+  globalThis.bjørnTransformFeedHTML?.(feedTemplate, feedMetadata);

   writes.push(
     Deno.writeTextFile(
       "index.xhtml",
   writes.push(
     Deno.writeTextFile(
       "index.xhtml",


@@ -1122,6 +1151,7 @@ await (async () => { // this is the run script
   );
 
   // Save the feed Atom file.
   );
 
   // Save the feed Atom file.

+  globalThis.bjørnTransformFeedAtom?.(document, feedMetadata);

   writes.push(
     Deno.writeTextFile(
       "feed.atom",
   writes.push(
     Deno.writeTextFile(
       "feed.atom",