vowel 0.6.4 → 0.7.0-beta.0

package/README.md

@@ -3,7 +3,7 @@
 *Markdown websites in milliseconds*
 
 - Bundled with [Votive](https://github.com/samlfair/votive)
-- Served with [Voot](https://github.com/samlfair/voot)
+- Served with [Votive](https://github.com/samlfair/votive)'s dev server
 
 See the docs: [vowel.cc](https://vowel.cc).
 

package/bin.js

@@ -6,7 +6,12 @@ import { parse } from "@bomb.sh/args"
 import t from "@bomb.sh/tab"
 import votive from "votive"
 import { styleText } from "node:util"
-import { config } from "./config.js"
+import { createConfig } from "./config.js"
+
+// The CLI's own boundary: cwd is the project folder by convention (you
+// `cd` into your blog and run `vowel`), so "." is the right default here
+// specifically - see createConfig's own doc comment.
+const config = createConfig(".")
 
 /** @param {number} ms */
 function wait(ms) {
@@ -14,27 +19,37 @@ function wait(ms) {
 }
 
 import init from "./index.js"
+import { shouldClear } from "./cli.js"
 
-/** @param {boolean} verbose */
-async function removeCache(verbose) {
+/**
+ * Discards the build database. Only under --clear (alias --reset): an
+ * ordinary launch is a warm start, reusing the database and the output,
+ * so a second launch on an unchanged site has nothing to do. The wipe on
+ * every launch was a development convenience, and it hid the on-disk
+ * database path from the CLI entirely.
+ * @param {boolean} verbose
+ */
+async function removeDatabase(verbose) {
   try {
     await fs.rm(config.databasePath)
-    if (verbose) console.info(`${styleText("dim", "loading:")} ${styleText("green", "cache cleared")}`)
+    if (verbose) console.info(`${styleText("dim", "loading:")} ${styleText("green", "database cleared")}`)
   } catch (e) {
-    if (verbose) console.info(`${styleText("dim", "loading:")} ${styleText("green", "no database cache found")}`)
+    if (verbose) console.info(`${styleText("dim", "loading:")} ${styleText("green", "no database found")}`)
   }
 }
 
 /** @param {boolean} verbose */
-async function removeDB(verbose) {
+async function removeOutput(verbose) {
   try {
     await fs.rm(config.targetFolder, { recursive: true, force: true })
     if (verbose) console.info(`${styleText("dim", "loading:")} ${styleText("green", "output cleared")}`)
   } catch (e) {
-    if (verbose) console.info(`${styleText("dim", "loading:")} ${styleText("green", "no output cache found")}`)
+    if (verbose) console.info(`${styleText("dim", "loading:")} ${styleText("green", "no output found")}`)
   }
 }
 
+
+
 async function exists(filePath) {
   try {
     await fs.stat(filePath)
@@ -74,21 +89,12 @@ The few configurations that Vowel uses live in a 'settings.md' file at the root
 
       box(`Change these configurations by editing 'settings.md'.`)
 
-      const websiteTitle = await text({
-        message: "Website title",
+      const websiteName = await text({
+        message: "Website name",
         placeholder: "My Cool Website"
       })
 
-      frontmatter.push(`title: ${websiteTitle}`)
-
-      const tagline = await text({
-        message: "Website tagline (leave empty to skip)",
-        placeholder: "All the news that's fit to blog"
-      })
-
-      if (tagline) {
-        frontmatter.push(`tagline: ${tagline}`)
-      }
+      frontmatter.push(`name: ${websiteName}`)
 
       box(`Vowel comes loaded with themes. You can override these themes by writing styles in a 'styles.css' file at the root of your project.`)
 
@@ -150,6 +156,12 @@ The few configurations that Vowel uses live in a 'settings.md' file at the root
         message: "Generate homepage"
       })
 
+      // A tagline is a page's; the homepage's is the site's hero.
+      const tagline = await text({
+        message: "Homepage tagline (leave empty to skip)",
+        placeholder: "All the news that's fit to blog"
+      })
+
       const spin = spinner()
 
       spin.start('Setting up')
@@ -167,7 +179,8 @@ The few configurations that Vowel uses live in a 'settings.md' file at the root
       const homeExists = await exists("home.md")
 
       if (!homeExists) {
-        await fs.writeFile("home.md", `# Home\n\nWelcome home!`, "utf-8")
+        const homeFrontmatter = tagline ? `---\ntagline: ${tagline}\n---\n` : ""
+        await fs.writeFile("home.md", `${homeFrontmatter}# Home\n\nWelcome home!`, "utf-8")
       }
 
       spin.clear()
@@ -193,14 +206,14 @@ The few configurations that Vowel uses live in a 'settings.md' file at the root
 /**
  * Runs one registered command directly and exits - no dev server, no
  * wizard, no cache-wiping. Reuses the exact handler a live "Publish"
- * button would trigger over WS (see voot's runCommand/handleCommand) -
+ * button would trigger over WS (see votive's runCommand/handleCommand) -
  * this is just the other invocation path for the same registered
  * function, meant for CI/automated use (e.g. `vowel --command deploy`).
  * @param {string} name
  * @param {string} [payloadJSON]
  */
 async function runCLICommand(name, payloadJSON) {
-  const { runCommand } = await import("voot")
+  const { runCommand } = await import("votive")
 
   let payload
   try {
@@ -232,18 +245,25 @@ async function main() {
 
   const dbExists = await exists(config.databasePath)
 
-  await removeCache(args.logging === "verbose")
-  await removeDB(args.logging === "verbose")
+  if (shouldClear(args)) {
+    await removeDatabase(args.logging === "verbose")
+    await removeOutput(args.logging === "verbose")
+  }
   await fs.mkdir(config.targetFolder, { recursive: true })
 
+  // The wizard runs on a first launch only: no database yet is the one
+  // signal that legitimately means "new project", and --clear does not
+  // change that - a cleared project is still one that was set up.
   if (!args.skip && !dbExists) {
-    const loading = votive({ ...config, verbose: false })
+    // const loading = votive({ ...config, verbose: false })
     await wizard()
-    await (loading)
+    // await (loading)
   }
 
 
-  init(args)
+  // `--editor` is deliberately undocumented: the in-page editor is not
+  // part of 1.0. It reaches the html plugin as config.editor.
+  init({ ...args, editor: Boolean(args.editor) })
 }
 
 

package/cli.js

@@ -0,0 +1,15 @@
+/**
+ * Decisions the CLI makes from its arguments, kept out of bin.js so they
+ * can be tested without launching a server.
+ */
+
+/**
+ * Whether this launch starts cold. `--clear` and `--reset` are the same
+ * flag; anything else is a warm start that reuses the database and the
+ * output, so a second launch on an unchanged site has nothing to do.
+ * The wipe on every launch was a development convenience.
+ * @param {Record<string, unknown>} args - as @bomb.sh/args parses them
+ */
+export function shouldClear(args) {
+  return Boolean(args?.clear || args?.reset)
+}

package/config.js

@@ -1,5 +1,7 @@
 import path from "node:path"
-import { systemDirectoryFor } from "votive/internals"
+import { resolveProjectFolder } from "votive"
+import { systemDirectoryFor } from "./systemPaths.js"
+import { secretRouter } from "./secretPaths.js"
 import vowelImagesPlugin from "./plugins/images/index.js"
 import vowelStylesPlugin from "./plugins/styles/index.js"
 import vowelReadMarkdownPlugin from "./plugins/markdown/index.js"
@@ -7,35 +9,100 @@ import vowelWriteRobotsPlugin from "./plugins/robots/index.js"
 import vowelWriteXMLPlugin from "./plugins/xml/index.js"
 import vowelVectorPlugin from "./plugins/vectors/index.js"
 import vowelFontsPlugin from "./plugins/fonts/index.js"
+import vowelAssetsPlugin from "./plugins/assets/index.js"
+import vowelDeployCloudflarePlugin from "./plugins/deploy-cloudflare/index.js"
 import vowelWriteHTMLPlugin from "./plugins/html/index.js"
+import vowelAtprotoPlugin from "./plugins/atproto/index.js"
+import vowelPublishPlugin from "./plugins/publish/index.js"
 import vowelURLsPlugin from "./plugins/urls/index.js"
 
 /** @import {VotiveConfig} from "votive" */
 
-const sourceFolder = "."
+/**
+ * Vowel's routing cascade: secret segments hashed, then the whole path
+ * lowercased. Votive stores a routed path verbatim, and only the
+ * markdown router lowercases its own output - images, fonts, styles and
+ * vectors pass their names through - so this is the one place that
+ * makes every vowel url lowercase. After the hash, not before: the
+ * hash input is the path as the author typed it (secretPaths.js pins
+ * the values), and a hex digest is lowercase already.
+ * @param {string} sourcePath
+ */
+function vowelRouter(sourcePath) {
+  return secretRouter(sourcePath).toLowerCase()
+}
 
-// Vowel targets non-developer end users (via whatever app embeds it),
-// who could be confused by an `output`/.votive.db/.cache showing up in
-// their project folder - keep all three in an OS-appropriate system
-// directory instead, keyed per-project so multiple Vowel sites never
-// collide. Override any of the three below if you want them back in
-// the project directory (or somewhere else entirely).
-const systemDirectory = systemDirectoryFor(sourceFolder)
+const defaultPlugins = [
+  vowelReadMarkdownPlugin,
+  vowelImagesPlugin,
+  vowelStylesPlugin,
+  vowelWriteRobotsPlugin,
+  vowelWriteXMLPlugin,
+  vowelVectorPlugin,
+  vowelFontsPlugin,
+  vowelAssetsPlugin,
+  vowelDeployCloudflarePlugin,
+  vowelURLsPlugin,
+  vowelAtprotoPlugin,
+  vowelPublishPlugin,
+  vowelWriteHTMLPlugin
+]
 
-export const config = {
-  sourceFolder,
-  targetFolder: path.join(systemDirectory, "output"),
-  databasePath: path.join(systemDirectory, ".votive.db"),
-  cacheDirectory: path.join(systemDirectory, ".cache"),
-  plugins: [
-    vowelReadMarkdownPlugin,
-    vowelImagesPlugin,
-    vowelStylesPlugin,
-    vowelWriteRobotsPlugin,
-    vowelWriteXMLPlugin,
-    vowelVectorPlugin,
-    vowelFontsPlugin,
-    vowelURLsPlugin,
-    vowelWriteHTMLPlugin
-  ]
-}
+/**
+ * Builds a real config for a given project folder - a function, not a
+ * module-level constant, because the folder isn't known until a caller
+ * supplies one. The old shape (a static `export const config` built from
+ * a hardcoded `sourceFolder = "."`) only worked for the CLI, where cwd
+ * genuinely is the project folder; an embedder (vowel-desktop, a future
+ * host) has its own folder that has nothing to do with cwd, and needs
+ * its own targetFolder/databasePath/cacheDirectory to follow it - not a
+ * value baked in at `import vowel from "vowel"` time. See
+ * tasks/desktop-app-architecture.md.
+ *
+ * Vowel targets non-developer end users (via whatever app embeds it),
+ * who could be confused by an `output`/.votive.db/.cache showing up in
+ * their project folder - keep all three in an OS-appropriate system
+ * directory instead, keyed per-project so multiple Vowel sites never
+ * collide.
+ *
+ * `overrides.plugins`, if given, is *added* to vowel's default plugin
+ * list rather than replacing it - an embedder registering its own
+ * native-only commands (a folder picker, "reveal in Finder") shouldn't
+ * have to reimplement markdown/html/images/etc. support just to add one
+ * plugin. Override any of targetFolder/databasePath/cacheDirectory via
+ * `overrides` directly if you want them back in the project directory
+ * (or somewhere else entirely).
+ * @param {string} [sourceFolder] - defaults to the current working
+ *   directory, correct for the CLI. An embedder should always pass an
+ *   explicit, real folder (e.g. from a native folder-picker) - cwd has
+ *   no meaningful relationship to "the user's project" there.
+ * @param {Partial<VotiveConfig> & { plugins?: VotiveConfig["plugins"] }} [overrides]
+ * @returns {VotiveConfig}
+ */
+function createConfig(sourceFolder = ".", overrides = {}) {
+  const resolvedSourceFolder = resolveProjectFolder(sourceFolder)
+  const systemDirectory = systemDirectoryFor(resolvedSourceFolder)
+  const { plugins: extraPlugins, ...rest } = overrides
+
+  return {
+    sourceFolder: resolvedSourceFolder,
+    // Applied before every processor's own router, so a secret folder
+    // hides its images and fonts too - not just its pages. See
+    // secretPaths.js for why this cannot live in a processor.
+    router: vowelRouter,
+    // Fetched link previews live in the project, one YAML file per host,
+    // so they survive a cache wipe, travel with the project, and reach
+    // coworkers through the repo. Visible rather than votive's hidden
+    // default, because the author is meant to find and edit them: the
+    // file is what the site shows. `$` keeps it out of routing, and
+    // votive keeps it out of the source scan.
+    urlStore: path.join(resolvedSourceFolder, "$links"),
+    targetFolder: path.join(systemDirectory, "output"),
+    databasePath: path.join(systemDirectory, ".votive.db"),
+    cacheDirectory: path.join(systemDirectory, ".cache"),
+    plugins: [...defaultPlugins, ...(extraPlugins ?? [])],
+    ...rest
+  }
+}
+
+export { createConfig }

package/extractDate.js

@@ -1,10 +1,36 @@
+const MONTH_INDEXES = {
+  jan: 0, feb: 1, mar: 2, apr: 3, may: 4, jun: 5,
+  jul: 6, aug: 7, sep: 8, oct: 9, nov: 10, dec: 11
+}
+
+/**
+ * Months arrive either as a name ("January", "Sept") or as a number.
+ * @param {string} month
+ */
+function monthIndex(month) {
+  const named = MONTH_INDEXES[String(month).slice(0, 3).toLowerCase()]
+  if (named !== undefined) return named
+  return Number(month) - 1
+}
+
+// Deliberately unanchored: a caller may want the date out of a longer
+// string. Use dateSpan() to tell "this text *is* a date" from "this text
+// mentions one".
+const DATE_PATTERN = /(?:\b(?<first_segment>(?<first_MMM_or_MMMM>January|February|March|April|May|June|July|August|September|October|November|December|Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sept|Sep|Oct|Nov|Dec)|(?<first_YYYY>\d\d\d\d)|(?<first_do>(?:\d|[0-3]\d)(?:st|nd|rd|th))|(?<first_dd_or_MM_or_yy>[0-3]\d)|(?<first_d_or_M>\d))(?<first_delimiter>\.| |, |\/|-)?)(?:\b(?<second_segment>(?<second_MMM_or_MMMM>January|February|March|April|May|June|July|August|September|October|November|December|Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sept|Sep|Oct|Nov|Dec)|(?<second_YYYY>\d\d\d\d)|(?<second_do>(\d\d)(:?st|nd|rd|th))|(?<second_dd_or_MM_or_yy>[0-3]\d)|(?<second_d_or_M>\d))(?<second_delimiter>\.| |, |\/|-)?)(?:\b(?<third_segment>(?<third_MMM_or_MMMM>January|February|March|April|May|June|July|August|September|October|November|December|Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sept|Sep|Oct|Nov|Dec)|(?<third_YYYY>\d\d\d\d)|(?<third_do>(\d\d)(?:st|nd|rd|th))|(?<third_dd_or_MM_or_yy>[0-3]\d)|(?<third_d_or_M>\d)))(?<time>(?<time_delimiter>T|\ | at )(?<H_or_HH>[0-2]?\d):(?<MM>[0-6]\d)(?::(?<SS>00))?(?:\.(?<SSS>\d\d\d))?(?<Z>Z|(?:\+(\d\d):(\d\d)))?(?<meridiam_indicator>am|pm)?)?/i
+
 /**
+ * The part of `text` that looks like a date, or undefined.
  * @param {string} text
  */
-function extractDate(text) {
-  const dateRegex = /(?:\b(?<first_segment>(?<first_MMM_or_MMMM>January|February|March|April|May|June|July|August|September|October|November|December|Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sept|Sep|Oct|Nov|Dec)|(?<first_YYYY>\d\d\d\d)|(?<first_do>(?:\d|[0-3]\d)(?:st|nd|rd|th))|(?<first_dd_or_MM_or_yy>[0-3]\d)|(?<first_d_or_M>\d))(?<first_delimiter>\.| |, |\/|-)?)(?:\b(?<second_segment>(?<second_MMM_or_MMMM>January|February|March|April|May|June|July|August|September|October|November|December|Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sept|Sep|Oct|Nov|Dec)|(?<second_YYYY>\d\d\d\d)|(?<second_do>(\d\d)(:?st|nd|rd|th))|(?<second_dd_or_MM_or_yy>[0-3]\d)|(?<second_d_or_M>\d))(?<second_delimiter>\.| |, |\/|-)?)(?:\b(?<third_segment>(?<third_MMM_or_MMMM>January|February|March|April|May|June|July|August|September|October|November|December|Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sept|Sep|Oct|Nov|Dec)|(?<third_YYYY>\d\d\d\d)|(?<third_do>(\d\d)(?:st|nd|rd|th))|(?<third_dd_or_MM_or_yy>[0-3]\d)|(?<third_d_or_M>\d)))(?<time>(?<time_delimiter>T|\ | at )(?<H_or_HH>[0-2]?\d):(?<MM>[0-6]\d)(?::(?<SS>00))?(?:\.(?<SSS>\d\d\d))?(?<Z>Z|(?:\+(\d\d):(\d\d)))?(?<meridiam_indicator>am|pm)?)?/i
+function dateSpan(text) {
+  return DATE_PATTERN.exec(text)?.[0]
+}
 
-  const dateMatch = dateRegex.exec(text)
+/**
+ * @param {string} text
+ */
+function extractDate(text) {
+  const dateMatch = DATE_PATTERN.exec(text)
   if(!dateMatch) return
 
   const data = {
@@ -73,11 +99,49 @@ function extractDate(text) {
     data.timezone = groups.Z
   }
 
-  const time = groups.time ? `${data.hours}:${data.minutes}:${data.seconds}${data.timezone || ""}` : null
-  const dateString = `${data.year} ${data.month} ${data.day}${time ? " " + time : ""}`
+  // A bare "YYYY M D" string is parsed as local time, which shifts the
+  // date by a day in any timezone east of UTC and by an odd LMT offset
+  // before standardization (Amsterdam in the year 1000 is +00:17:30). The
+  // date an author writes has no timezone, so build it as UTC and only
+  // honour an offset when one was written explicitly.
+  const year = Number(data.year)
+  const month = monthIndex(data.month)
+  const day = parseInt(data.day, 10)
+
+  const hours = data.hours ? Number(data.hours) : 0
+  const minutes = data.minutes ? Number(data.minutes) : 0
+  const seconds = data.seconds ? Number(data.seconds) : 0
+
+  // Date.UTC rolls out-of-range parts over into neighbouring months and
+  // years, so an ISBN's segments would silently become a real date. The
+  // string parse this replaced rejected them, and callers still rely on
+  // that: the frontmatter renderer only treats a value as a date when the
+  // result is valid.
+  const partsAreSane =
+    Number.isInteger(year) &&
+    Number.isInteger(month) && month >= 0 && month <= 11 &&
+    Number.isInteger(day) && day >= 1 && day <= 31
+
+  if (!partsAreSane) return new Date(NaN)
+
+  if (data.timezone) {
+    const pad = (value, width = 2) => String(value).padStart(width, "0")
+    const stamp = `${pad(year, 4)}-${pad(month + 1)}-${pad(day)}` +
+      `T${pad(hours)}:${pad(minutes)}:${pad(seconds)}${data.timezone}`
+    return new Date(stamp)
+  }
+
+  const result = new Date(Date.UTC(year, month, day, hours, minutes, seconds))
+
+  // Catches the rollover that survives the range check - 31 February.
+  const rolled =
+    result.getUTCFullYear() !== year ||
+    result.getUTCMonth() !== month ||
+    result.getUTCDate() !== day
 
-  return new Date(dateString)
+  return rolled ? new Date(NaN) : result
 }
 
 export default extractDate
+export { extractDate, dateSpan }
 

package/index.js

@@ -1,14 +1,23 @@
-import voot from "voot"
-import { config } from "./config.js"
+import { startServer } from "votive"
+import { createConfig } from "./config.js"
 
 /**
  * @param {object} options
  * @property {"verbose" | "essential" | "silent"} logging
+ * @property {string} [sourceFolder] - defaults to the current working
+ *   directory (see createConfig) - a caller with its own project folder
+ *   (vowel-desktop, a future host) should always pass this explicitly.
+ * @returns {Promise<{port: number, server: import("node:http").Server, close: () => Promise<void>}>}
+ *   startServer's own return, passed through. `port` is the bound port, which can
+ *   differ from the one requested; `close()` releases the watchers and the
+ *   listener, which a host serving more than one project over a session
+ *   needs before opening the next one.
  */
-async function init(options) {
-  const cache = await voot({ ...config, ...options })
+async function init(options = {}) {
+  const { sourceFolder, ...overrides } = options
+  const config = createConfig(sourceFolder, overrides)
+  return startServer(config)
 }
 
 
 export default init
-

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "vowel",
   "type": "module",
-  "version": "0.6.4",
+  "version": "0.7.0-beta.0",
+  "engines": {
+    "node": ">=26"
+  },
   "bin": "bin.js",
   "main": "index.js",
   "scripts": {
-    "test": "node --test tests/*.js"
+    "test": "node --test tests/*.js",
+    "build:editor": "cd plugins/html/editor && rollup -c"
   },
   "keywords": [
     "markdown",
@@ -15,22 +19,35 @@
   "author": "Sam Littlefair",
   "license": "MIT",
   "description": "Markdown websites",
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "linkedom": "^0.18.13",
+    "rollup": "^4.0.0",
+    "rollup-plugin-cleanup": "^3.2.1",
+    "rollup-plugin-svelte": "^7.2.3",
+    "svelte": "^5.56.9"
+  },
   "dependencies": {
     "@bomb.sh/args": "^0.3.1",
     "@bomb.sh/tab": "^0.0.15",
     "@clack/prompts": "^1.4.0",
     "@jsdevtools/rehype-toc": "^3.0.2",
     "autoprefixer": "^10.4.27",
+    "colorhorse": "^0.3.1",
     "cssnano": "^7.1.4",
+    "emojilib": "^4.0.3",
     "encoding-sniffer": "^1.0.2",
     "fast-xml-parser": "^5.3.6",
     "faye-websocket": "^0.11.4",
+    "github-slugger": "^2.0.0",
     "hast-util-from-html": "^2.0.3",
     "hast-util-to-string": "^3.0.1",
+    "hast-util-to-text": "^4.0.2",
     "hastscript": "^9.0.1",
     "highlight.js": "^11.12.0",
     "js-yaml": "^4.1.0",
-    "lightningcss": "^1.32.0",
+    "lightningcss": "^1.33.0",
+    "lowlight": "^3.3.0",
     "mdast": "^2.3.2",
     "mdast-normalize-headings": "^4.0.0",
     "mdast-util-from-markdown": "^2.0.2",
@@ -51,7 +68,6 @@
     "rehype": "^13.0.2",
     "rehype-document": "^7.0.3",
     "rehype-github-alert": "^1.0.0",
-    "rehype-highlight": "^7.0.2",
     "rehype-parse": "^9.0.1",
     "rehype-preset-minify": "^7.0.1",
     "rehype-slug": "^6.0.0",
@@ -62,7 +78,9 @@
     "remark-html": "^16.0.1",
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.2",
+    "rollup-plugin-import-css": "^4.2.1",
     "sharp": "^0.35.3",
+    "svedit": "^0.14.0",
     "unified": "^11.0.5",
     "unist-util-find": "^3.0.0",
     "unist-util-is": "^6.0.0",
@@ -73,12 +91,25 @@
     "unist-util-visit-parents": "^6.0.0",
     "unpic": "^4.2.2",
     "url-metadata": "^5.4.1",
-    "voot": "^0.1.0",
-    "votive": "^0.4.0",
+    "votive": "0.5.0-beta.0",
     "xast-util-sitemap": "^2.0.0",
     "xast-util-to-xml": "^4.0.0",
     "xml": "^1.0.1",
     "yaml": "^2.8.2",
     "yamljs": "^0.3.0"
-  }
-}
+  },
+  "files": [
+    "bin.js",
+    "cli.js",
+    "config.js",
+    "extractDate.js",
+    "index.js",
+    "secretPaths.js",
+    "systemPaths.js",
+    "utils.js",
+    "plugins",
+    "stylesheets",
+    "!plugins/html/bundle.js",
+    "!plugins/html/editorClient.js"
+  ]
+}

package/plugins/assets/index.js

@@ -0,0 +1,65 @@
+import { statSync } from "node:fs"
+import path from "node:path"
+
+/** @import * as Votive from "votive" */
+
+/**
+ * Files the site publishes as they are: video, data and documents an
+ * author links to from a page. Copied through byte for byte - like a
+ * font - with one rule: **a file over the size limit is not published.**
+ * Cloudflare Pages refuses any single file over 25 MiB, and a deploy
+ * that fails on one video is worse than a build that says so up front.
+ * The read (deferred, like every buffer read) stats the source rather
+ * than reading it, logs one error naming the file and its size, and
+ * makes the target virtual, so nothing lands on disk and nothing links
+ * to it as though it were there. The limit is `config.assetSizeLimit`
+ * in bytes for a host that allows more.
+ *
+ * Per Sam (Sept 19): copy through mp4 and csv, with a reasonable file
+ * size limit. The list is what people link to from a page and expect
+ * to be there; adding an extension is adding it here.
+ */
+
+const EXTENSIONS = [".mp4", ".webm", ".csv", ".json", ".pdf"]
+
+/** 25 MiB: Cloudflare Pages' per-file limit. */
+const DEFAULT_SIZE_LIMIT = 25 * 1024 * 1024
+
+/** @param {number} bytes */
+const megabytes = (bytes) => `${(bytes / (1024 * 1024)).toFixed(1)} MB`
+
+/**
+ * @type {Votive.ProcessorRead}
+ */
+function readAsset(source, { config }) {
+  const limit = Number(config.assetSizeLimit) || DEFAULT_SIZE_LIMIT
+  const { size } = statSync(path.join(config.sourceFolder, source.path))
+  if (size <= limit) return { metadata: { size } }
+
+  config.log?.("error", `${source.path} is ${megabytes(size)}; files over ${megabytes(limit)} are not published (Cloudflare Pages refuses them). Host it elsewhere and link to it.`)
+  return { metadata: { size, oversized: true }, write: false }
+}
+
+/** @type {Votive.ProcessorWrite} */
+function writeAsset(target) {
+  if (target.metadata?.oversized) return undefined
+  return { data: target.buffer() }
+}
+
+/** @type {Votive.VotiveProcessor} */
+const assetsProcessor = {
+  format: "buffer",
+  extensions: EXTENSIONS,
+  router: ({ name, dir, ext }) => ({ name, dir, ext }),
+  readFile: readAsset,
+  writeFile: writeAsset
+}
+
+/** @type {Votive.VotivePlugin} */
+const vowelAssetsPlugin = {
+  name: "vowel-assets",
+  processors: [assetsProcessor]
+}
+
+export default vowelAssetsPlugin
+export { EXTENSIONS, DEFAULT_SIZE_LIMIT }