vowel 0.6.3 → 0.7.0-beta.0

package/plugins/deploy-cloudflare/index.js

@@ -0,0 +1,92 @@
+import votive from "votive"
+import { spawn } from "node:child_process"
+import path from "node:path"
+
+/**
+ * Publishes a full build to Cloudflare Pages via `wrangler pages deploy`.
+ *
+ * Always runs a complete build first, regardless of whether a dev server
+ * happens to already be running against this config - a command's
+ * context (config, notify) has no reference to a live server's own build
+ * queue, and this needs to behave identically whether triggered from the
+ * CLI (no server at all, see votive's runCommand) or a live "Publish"
+ * button over WS. Modest redundant cost when a dev server IS already
+ * running (bundle() is cheap when nothing's stale), traded for one
+ * deploy command that works the same everywhere.
+ *
+ * Shells out to `wrangler` rather than calling Cloudflare's REST API
+ * directly - Pages deploys require content-hashing every asset and
+ * building a manifest in Cloudflare's specific format, which wrangler
+ * already implements and maintains. `wrangler` reads
+ * CLOUDFLARE_API_TOKEN/CLOUDFLARE_ACCOUNT_ID from the environment
+ * natively; this never touches credentials itself, and none should ever
+ * be added to `config` (it isn't a place secrets should live).
+ *
+ * @param {any} payload
+ * @param {{ config: import("votive").VotiveConfig & { cloudflareProjectName?: string }, notify: (message: object) => void }} context
+ */
+async function deployToCloudflarePages(payload, { config, notify }) {
+  notify({ status: "progress", message: "Building..." })
+
+  // Unlike a dev server's own rebuilds, a deploy needs everything done -
+  // there's no "next edit" to stay responsive for - so the deferred
+  // work (image derivatives, link previews) is awaited, and the site is
+  // closed: the database is a cache on disk, and this process is done
+  // with it.
+  const site = await votive({ ...config, verbose: false })
+  await (await site.build()).deferred
+  const setting = site.database.setting.getByFolder("").lastNonNull("fm_cloudflare_project")
+  await site.close()
+
+  // The Pages project, from the command's payload (`vowel --command
+  // deploy --payload '{"projectName":"my-site"}'`, or a Publish button's
+  // body), the root settings.md's `cloudflare_project:`, or the config an
+  // embedder built.
+  const projectName = payload?.projectName ?? setting ?? config.cloudflareProjectName
+  if (!projectName) throw new Error("a Cloudflare Pages project name is required to deploy: set cloudflare_project in the root settings.md, or pass {\"projectName\": \"…\"} as the payload")
+
+  // `{"dryRun": true}` builds and stops short of wrangler.
+  if (payload?.dryRun) {
+    notify({ status: "done", message: `Would deploy ${config.targetFolder} to Cloudflare Pages project ${projectName}` })
+    return { deployed: false, projectName, dryRun: true }
+  }
+
+  notify({ status: "progress", message: `Publishing ${config.targetFolder} to Cloudflare Pages...` })
+
+  return new Promise((resolve, reject) => {
+    const proc = spawn(
+      "wrangler",
+      ["pages", "deploy", config.targetFolder, "--project-name", projectName],
+      { stdio: ["ignore", "pipe", "pipe"] }
+    )
+
+    // Piped, not "inherit" - this can run with no terminal attached at
+    // all (triggered over WS from a browser), so wrangler's own output
+    // has to go through notify() to reach whoever's actually watching.
+    proc.stdout.on("data", chunk => notify({ status: "progress", message: chunk.toString() }))
+    proc.stderr.on("data", chunk => notify({ status: "progress", message: chunk.toString() }))
+
+    proc.on("error", reject) // e.g. wrangler isn't installed
+    proc.on("exit", code => {
+      if (code === 0) resolve({ deployed: true, projectName })
+      else reject(new Error(`wrangler exited with code ${code}`))
+    })
+  })
+}
+
+/**
+ * In vowel's default plugin list (config.js), so `vowel --command
+ * deploy` reaches it from any project. Registering a command costs
+ * nothing until it is invoked, and invoking it needs a project name,
+ * so a site that deploys elsewhere never meets it.
+ * @type {import("votive").VotivePlugin}
+ */
+const vowelDeployCloudflarePlugin = {
+  name: "vowel-deploy-cloudflare",
+  commands: {
+    deploy: deployToCloudflarePages
+  }
+}
+
+export default vowelDeployCloudflarePlugin
+export { deployToCloudflarePages }

package/plugins/fonts/index.js

@@ -1,38 +1,35 @@
-import { readFile } from "node:fs/promises"
 /** @import * as Votive from "votive" */
 
-/** @type {Votive.ProcessorWrite} */
-async function writeFile(destination, database, config) {
-  const buffer = await readFile(destination.abstract.filePath)
-  return {
-    data: buffer,
-  }
-}
-
-function readFont(filePath) {
-  return {
-    abstract: { filePath },
-    metadata: {}
-  }
+/**
+ * A font the project ships is copied straight through: target.buffer()
+ * resolves the source against sourceFolder at the moment of reading, so
+ * nothing about this machine is ever stored. The @font-face that uses
+ * it is the author's, in their own stylesheet.
+ *
+ * Vowel bundles no fonts of its own any more - the families and their
+ * stubs went with the typography ramps into TypographyStyles.css, which
+ * names a brand family through --font-*-brand and falls back to the
+ * system stack. Fonts by url: tasks/2-in-progress/load-fonts.md.
+ * @type {Votive.ProcessorWrite}
+ */
+function writeFile(target) {
+  return { data: target.buffer() }
 }
 
 /** @type {Votive.VotiveProcessor} */
 const fontsReader = {
   format: "buffer",
   extensions: [".woff", ".woff2", ".ttf", ".otf"],
-  readFile: readFont,
+  router: ({ name, dir, ext }) => ({ name, dir, ext }),
+  // A font carries no metadata worth inferring.
+  readFile: () => ({ metadata: {} }),
   writeFile
 }
 
 /** @type {Votive.VotivePlugin} */
 const vowelFontsPlugin = {
   name: "vowel-fonts",
-  processors: [fontsReader],
-  router: ({ name, dir, ext }) => {
-    return {
-      name, dir, ext
-    }
-  }
+  processors: [fontsReader]
 }
 
 export default vowelFontsPlugin

package/plugins/html/assets/bundle-BeK1Hptv.css

@@ -0,0 +1,21 @@
+@layer svedit-defaults {
+	:root {
+		/* Primary accent for active editing controls, carets, and selections. */
+		--editing: oklch(60% 0.22 283);
+		/* Low-opacity version of the editing accent for passive highlights. */
+		--editing-muted: oklch(from var(--editing) l c h / 0.1);
+		/* Low-emphasis strokes and outlines, such as inactive node gaps. */
+		--editing-stroke: color-mix(in oklch, currentColor 25%, transparent);
+		/* Foreground color for content displayed on the editing accent. */
+		--editing-foreground: oklch(100% 0 0);
+	}
+}
+
+@layer svedit-defaults {
+	@keyframes node-caret-blink {
+		0%, 60% { opacity: 1; }
+		68% { opacity: 0; }
+		88% { opacity: 0; }
+		100% { opacity: 1; }
+	}
+}

package/plugins/html/bundle/assets/index-BeK1Hptv.css

@@ -0,0 +1,21 @@
+@layer svedit-defaults {
+	:root {
+		/* Primary accent for active editing controls, carets, and selections. */
+		--editing: oklch(60% 0.22 283);
+		/* Low-opacity version of the editing accent for passive highlights. */
+		--editing-muted: oklch(from var(--editing) l c h / 0.1);
+		/* Low-emphasis strokes and outlines, such as inactive node gaps. */
+		--editing-stroke: color-mix(in oklch, currentColor 25%, transparent);
+		/* Foreground color for content displayed on the editing accent. */
+		--editing-foreground: oklch(100% 0 0);
+	}
+}
+
+@layer svedit-defaults {
+	@keyframes node-caret-blink {
+		0%, 60% { opacity: 1; }
+		68% { opacity: 0; }
+		88% { opacity: 0; }
+		100% { opacity: 1; }
+	}
+}