From 4415c645f797ae17b512b85ff21bb61feba7bf4e Mon Sep 17 00:00:00 2001 From: James Babcock Date: Sat, 29 Aug 2026 15:21:53 -0700 Subject: [PATCH] Add sync-site script --- scripts/sync-site.mjs | 126 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 126 insertions(+) create mode 100755 scripts/sync-site.mjs diff --git a/scripts/sync-site.mjs b/scripts/sync-site.mjs new file mode 100755 index 00000000..a699f361 --- /dev/null +++ b/scripts/sync-site.mjs @@ -0,0 +1,126 @@ +#!/usr/bin/env node +// Keeps the website in step with the files that own the content. +// +// website/content/features.md -> README.md and website/index.html +// PRIVACY -> website/privacy.html +// +// Each destination has a `` / `` +// pair; everything between them is replaced. Run after editing either source: +// +// node scripts/sync-site.mjs rewrite the destinations +// node scripts/sync-site.mjs --check exit non-zero if they are out of date + +import { readFileSync, writeFileSync } from "node:fs"; +import { fileURLToPath } from "node:url"; +import { dirname, join } from "node:path"; + +const root = join(dirname(fileURLToPath(import.meta.url)), ".."); +const check = process.argv.includes("--check"); +const stale = []; + +// ---------- generic helpers ---------- + +function splice(relPath, key, body) { + const path = join(root, relPath); + const before = readFileSync(path, "utf8"); + const begin = ``; + const end = ``; + const i = before.indexOf(begin); + const j = before.indexOf(end); + if (i < 0 || j < 0) throw new Error(`${relPath}: missing ${begin} / ${end} markers`); + if (j < i) throw new Error(`${relPath}: ${end} comes before ${begin}`); + const after = before.slice(0, i + begin.length) + "\n" + body.replace(/\n+$/, "") + "\n" + before.slice(j); + if (after === before) return; + if (check) stale.push(`${relPath} (${key})`); + else writeFileSync(path, after); +} + +const escapeHtml = (s) => + s.replace(/&/g, "&").replace(//g, ">"); + +// The small markdown subset the sources use: `code`, **bold**, [text](url), bare URLs. +function inlineHtml(text) { + return escapeHtml(text) + .replace(/`([^`]+)`/g, "$1") + .replace(/\*\*([^*]+)\*\*/g, "$1") + .replace(/\[([^\]]+)\]\((https?:\/\/[^)\s]+)\)/g, '$1') + // Bare URLs, minus any trailing sentence punctuation. + .replace(/(^|[\s(])(https?:\/\/[^\s<)]+?)([.,;:)]?)(?=$|[\s<)])/g, + (_, lead, url, tail) => `${lead}${url}${tail}`); +} + +function wrap(text, width, firstPrefix, contPrefix) { + const lines = []; + let line = firstPrefix; + let indent = firstPrefix; + for (const word of text.split(/\s+/)) { + if (line !== indent && (line + " " + word).length > width) { + lines.push(line); + indent = contPrefix; + line = contPrefix + word; + } else { + line = line === indent ? line + word : line + " " + word; + } + } + lines.push(line); + return lines.join("\n"); +} + +// ---------- features ---------- + +function parseFeatures(md) { + const body = md.replace(//g, ""); + const features = []; + for (const raw of body.split("\n")) { + const line = raw.trimEnd(); + if (/^- /.test(line)) features.push(line.slice(2).trim()); + else if (/^\s+\S/.test(line) && features.length) { + features[features.length - 1] += " " + line.trim(); + } + } + if (!features.length) throw new Error("website/content/features.md: no `- ` bullets found"); + return features; +} + +const features = parseFeatures(readFileSync(join(root, "website/content/features.md"), "utf8")); + +splice("README.md", "features", + features.map((f) => wrap(f, 78, " * ", " ")).join("\n")); + +splice("website/index.html", "features", + ' "); + +// ---------- privacy ---------- + +function privacyHtml(md) { + const out = []; + for (const block of md.trim().split(/\n\s*\n/)) { + const lines = block.split("\n").filter((l) => l.trim()); + if (/^# /.test(lines[0])) { + out.push(`

${inlineHtml(lines[0].slice(2).trim())}

`); + } else if (/^## /.test(lines[0])) { + out.push(`

${inlineHtml(lines[0].slice(3).trim())}

`); + } else if (lines.every((l) => /^\s{2,}\S/.test(l))) { + // An indented run of "Provider: https://..." lines. + out.push('"); + } else { + out.push(`

${inlineHtml(lines.map((l) => l.trim()).join(" "))}

`); + } + } + return out.map((l) => " " + l).join("\n"); +} + +splice("website/privacy.html", "privacy", + privacyHtml(readFileSync(join(root, "PRIVACY"), "utf8"))); + +// ---------- report ---------- + +if (check && stale.length) { + console.error("Out of date, run `node scripts/sync-site.mjs`:\n " + stale.join("\n ")); + process.exit(1); +} +console.log(check ? "sync-site: up to date" : "sync-site: wrote generated blocks");