mikser-io 9.14.0 → 9.15.0

package/index.js

@@ -45,9 +45,18 @@ export { yaml }          from './src/plugins/yaml.js'
 // loader stores in `runtime.renderers`; the same module also still
 // exports `load`/`render` at the top level so Piscina worker dispatch
 // can resolve via dynamic import. ADR-0010.
-export { renderAsset }    from './src/plugins/render/asset.js'
-export { renderFile }     from './src/plugins/render/file.js'
-export { renderHbs }      from './src/plugins/render/hbs.js'
-export { renderHref }     from './src/plugins/render/href.js'
-export { renderPreset }   from './src/plugins/render/preset.js'
-export { renderResource } from './src/plugins/render/resource.js'
+// Renderers — these have a render() and turn an entity into a file.
+export { renderHbs }    from './src/plugins/render/hbs.js'
+export { renderPreset } from './src/plugins/render/preset.js'
+
+// Template helpers — these only install functions on `runtime` for templates
+// to call. They render nothing, which is what the old render* names hid: two
+// of the six factories in this folder are renderers and four are not, and
+// naming all six after the object they concern rather than the job they do
+// led someone to add renderPreset() expecting a helper and watch every page
+// render throw. Renamed in 10.0.0; there are no aliases.
+export { assetUrlHelper }    from './src/plugins/render/asset.js'
+export { hrefUrlHelpers }    from './src/plugins/render/href.js'
+export { resourceUrlHelper } from './src/plugins/render/resource.js'
+export { fileHelpers }       from './src/plugins/render/file.js'
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mikser-io",
-  "version": "9.14.0",
+  "version": "9.15.0",
   "description": "<p align=\"center\">   <img src=\"mikser-lockup-stacked.svg\" alt=\"mikser\" width=\"198\" /> </p>",
   "main": "index.js",
   "exports": {

package/src/plugins/render/asset.js

@@ -10,6 +10,6 @@ export function load({ runtime, entity, state, options }) {
     }
 }
 
-export function renderAsset(options = {}) {
+export function assetUrlHelper(options = {}) {
     return { name: options.name ?? 'asset', options, load }
-}
+}

package/src/plugins/render/file.js

@@ -44,6 +44,6 @@ export function load({ runtime }) {
     }
 }
 
-export function renderFile(options = {}) {
+export function fileHelpers(options = {}) {
     return { name: options.name ?? 'file', options, load }
 }

package/src/plugins/render/href.js

@@ -41,6 +41,6 @@ export function load({ entity, runtime, options }) {
     runtime.next = entity.page + 1 < entity.pages ? entity.page + 1 : false
 }
 
-export function renderHref(options = {}) {
+export function hrefUrlHelpers(options = {}) {
     return { name: options.name ?? 'href', options, load }
-}
+}

package/src/plugins/render/preset.js

@@ -2,7 +2,7 @@ import { mkdir } from 'node:fs/promises'
 import path from 'node:path'
 
 // A renderer's `load` runs for EVERY entity in the cycle, not only the ones
-// this renderer will render — that is deliberate and is how renderAsset
+// this renderer will render — that is deliberate and is how assetUrlHelper
 // installs runtime.asset() for all templates. So this has to tolerate an
 // entity that has no preset, rather than assume it is looking at one.
 //
@@ -11,13 +11,12 @@ import path from 'node:path'
 // "you have found something real", which is a much more expensive wrong
 // signal than a no-op. The names invite exactly that mistake:
 //
-//   renderAsset()   provides runtime.asset() to templates  (a URL helper)
+//   assetUrlHelper() provides runtime.asset() to templates  (a URL helper)
 //   assets()        runs presets and produces derivatives   (the work)
 //   renderPreset()  renders a preset-authored layout        (this file)
 //
-// All three are named after the object they concern rather than the job they
-// do, so reasoning "the one that RUNS presets must be renderPreset" is wrong
-// but not unreasonable.
+// The helpers were renamed for their role in 10.0.0 for exactly this reason;
+// renderPreset keeps its name because it really is a renderer.
 export async function load({ entity, runtime }) {
     if (!entity?.preset?.uri) return
     const preset = await import(`${entity.preset.uri}?stamp=${Date.now()}`)

package/src/plugins/render/resource.js

@@ -16,6 +16,6 @@ export function load({ runtime, entity, state, options }) {
     }
 }
 
-export function renderResource(options = {}) {
+export function resourceUrlHelper(options = {}) {
     return { name: options.name ?? 'resource', options, load }
-}
+}