@ascribed/astro 0.2.1-next.14 → 0.2.1-next.16

package/dist/root-files.js

@@ -0,0 +1,100 @@
+import { normalizeBase } from "./project.js";
+import { robotsText, routeAs, routeKey, sitemapAddresses, sitemapRoute, sitemapXml, } from "./records.js";
+/** The sitemap and `robots.txt` for a site, and what the build says about them. */
+export function rootFiles(sources) {
+    const notes = [];
+    const base = normalizeBase(sources.base);
+    let sitemap;
+    let sitemapAddress;
+    if (sources.ownSitemap) {
+        // The site's own, at the same address, which robots.txt points to when there's an address.
+        notes.push({ level: "info", text: "no sitemap.xml: public/sitemap.xml is the site's own." });
+        if (sources.site !== undefined)
+            sitemapAddress = new URL(sitemapRoute(base), sources.site).href;
+    }
+    else if (sources.site === undefined) {
+        notes.push({
+            level: "warn",
+            text: "no sitemap.xml: a sitemap lists pages by their absolute addresses, and the site has no address. Set [consumer] site in ascribe.toml, or Astro's `site`.",
+        });
+    }
+    else {
+        sitemap = sitemapXml(sitemapAddresses({ ...sources, site: sources.site }));
+        sitemapAddress = new URL(sitemapRoute(base), sources.site).href;
+    }
+    let robots = robotsText(sources.lines, sitemapAddress);
+    if (robots !== undefined && base !== "/") {
+        notes.push({
+            level: "info",
+            text: `no robots.txt: Astro's \`base\` is "${base}", and a crawler reads robots.txt only at the host's root. Put these lines in the host's own:\n${robots}`,
+        });
+        robots = undefined;
+    }
+    else if (robots !== undefined && sources.ownRobots) {
+        notes.push({
+            level: "info",
+            text: `no robots.txt: public/robots.txt is the site's own. Ascribe's lines for it:\n${robots}`,
+        });
+        robots = undefined;
+    }
+    return { sitemap, robots, notes };
+}
+/**
+ * A dev-server middleware serving the sitemap at `<base>sitemap.xml` and
+ * `robots.txt` at `/`, each as `files` has it when it's asked for, so each
+ * rebuild's records are served.
+ */
+export function rootFilesMiddleware(base, files) {
+    const sitemapPath = sitemapRoute(base);
+    return (req, res, next) => {
+        if (req.method !== "GET" && req.method !== "HEAD")
+            return next();
+        // Vite strips the base from `req.url`; connect keeps the original in `originalUrl`.
+        const pathname = (req.originalUrl ?? req.url ?? "").split(/[?#]/, 1)[0] ?? "";
+        if (pathname !== sitemapPath && pathname !== "/robots.txt")
+            return next();
+        const current = files();
+        const [text, type] = pathname === sitemapPath
+            ? [current.sitemap, "application/xml; charset=utf-8"]
+            : [current.robots, "text/plain; charset=utf-8"];
+        if (text === undefined)
+            return next();
+        res.setHeader("Content-Type", type);
+        res.setHeader("Content-Length", Buffer.byteLength(text));
+        res.end(req.method === "HEAD" ? undefined : text);
+    };
+}
+/**
+ * The site's own pages `astro dev` can name: each route of the site's own
+ * with no parameters, other than the not-found and error pages, by its route
+ * from the host's root. A page a route's `getStaticPaths` lists is known only
+ * to a build.
+ */
+export function devSitePages(routes, astro) {
+    const root = normalizeBase(astro.base);
+    return routes
+        .filter((route) => route.type === "page" &&
+        route.origin === "project" &&
+        route.params.length === 0 &&
+        route.pattern !== "/404" &&
+        route.pattern !== "/500")
+        .map((route) => routeAs(`${root}${route.pattern.replace(/^\//, "")}`, astro.trailingSlash));
+}
+/**
+ * Whether a project's page, by its route from the host's root, has a route
+ * in the site in `astro dev`: whether one of the site's own routes matches
+ * it. A project no route shows, such as one whose collection a page only
+ * quotes from, has no pages in the sitemap.
+ */
+export function devRouted(routes, astro) {
+    const root = normalizeBase(astro.base);
+    const pages = routes.filter((route) => route.type === "page" && route.origin === "project");
+    return (route) => {
+        if (!`${route}/`.startsWith(root))
+            return false;
+        const under = `/${route.slice(root.length)}`;
+        const forms = new Set([under, routeKey(under), `${routeKey(under)}/`]);
+        return pages.some((page) => [...forms].some((form) => page.patternRegex.test(form)));
+    };
+}
+//# sourceMappingURL=root-files.js.map

package/dist/root-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"root-files.js","sourceRoot":"","sources":["../src/root-files.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EACL,UAAU,EACV,OAAO,EACP,QAAQ,EACR,gBAAgB,EAChB,YAAY,EACZ,UAAU,GAEX,MAAM,cAAc,CAAC;AA6BtB,mFAAmF;AACnF,MAAM,UAAU,SAAS,CAAC,OAAwB;IAChD,MAAM,KAAK,GAAmB,EAAE,CAAC;IACjC,MAAM,IAAI,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,OAA2B,CAAC;IAChC,IAAI,cAAkC,CAAC;IACvC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;QACvB,2FAA2F;QAC3F,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,uDAAuD,EAAE,CAAC,CAAC;QAC7F,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;YAAE,cAAc,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;IAClG,CAAC;SAAM,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC;YACT,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,yJAAyJ;SAChK,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,UAAU,CAAC,gBAAgB,CAAC,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3E,cAAc,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;IAClE,CAAC;IACD,IAAI,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACvD,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC;YACT,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,uCAAuC,IAAI,kGAAkG,MAAM,EAAE;SAC5J,CAAC,CAAC;QACH,MAAM,GAAG,SAAS,CAAC;IACrB,CAAC;SAAM,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACrD,KAAK,CAAC,IAAI,CAAC;YACT,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,gFAAgF,MAAM,EAAE;SAC/F,CAAC,CAAC;QACH,MAAM,GAAG,SAAS,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AACpC,CAAC;AAID;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY,EAAE,KAAsB;IACtE,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACxB,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM;YAAE,OAAO,IAAI,EAAE,CAAC;QACjE,oFAAoF;QACpF,MAAM,QAAQ,GACZ,CAAE,GAAgC,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7F,IAAI,QAAQ,KAAK,WAAW,IAAI,QAAQ,KAAK,aAAa;YAAE,OAAO,IAAI,EAAE,CAAC;QAC1E,MAAM,OAAO,GAAG,KAAK,EAAE,CAAC;QACxB,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAChB,QAAQ,KAAK,WAAW;YACtB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,gCAAgC,CAAC;YACrD,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;QACpD,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,IAAI,EAAE,CAAC;QACtC,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACpC,GAAG,CAAC,SAAS,CAAC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QACzD,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC,CAAC;AACJ,CAAC;AAiBD;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,MAA6B,EAAE,KAAc;IACxE,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO,MAAM;SACV,MAAM,CACL,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,IAAI,KAAK,MAAM;QACrB,KAAK,CAAC,MAAM,KAAK,SAAS;QAC1B,KAAK,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QACzB,KAAK,CAAC,OAAO,KAAK,MAAM;QACxB,KAAK,CAAC,OAAO,KAAK,MAAM,CAC3B;SACA,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;AAChG,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CACvB,MAA6B,EAC7B,KAAc;IAEd,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;IAC5F,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAChD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC7C,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACvE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC,CAAC;AACJ,CAAC","sourcesContent":["// The site's sitemap and `robots.txt`, from every project's page records\n// together: one of each for the site, at the host's root, which is above the\n// base path of every project that isn't mounted there. `astro build` writes\n// them into its output, and `astro dev` serves them.\n//\n// A site whose Astro `base` isn't `/` has no host root: its sitemap goes\n// under the base, and no `robots.txt` is written, since one under a path does\n// nothing. The build says what the host's own needs instead.\nimport type { IncomingMessage, ServerResponse } from \"node:http\";\nimport { normalizeBase } from \"./project.js\";\nimport {\n  robotsText,\n  routeAs,\n  routeKey,\n  sitemapAddresses,\n  sitemapRoute,\n  sitemapXml,\n  type SitemapSources,\n} from \"./records.js\";\n\n/** What the files are drawn from. */\nexport interface RootFileSources extends Omit<SitemapSources, \"site\"> {\n  /** Each project's `robots.txt` lines, from the host's root, each project once. */\n  lines: readonly (readonly string[])[];\n  /** Astro's `site`, when it's set. */\n  site: string | undefined;\n  /** Astro's `base`. */\n  base: string;\n  /** Whether the site has its own `robots.txt`, in `public/`. */\n  ownRobots: boolean;\n  /** Whether the site has its own `sitemap.xml`, in `public/`. */\n  ownSitemap: boolean;\n}\n\n/** A thing the build says about the files, and how loudly. */\ninterface RootFileNote {\n  level: \"info\" | \"warn\";\n  text: string;\n}\n\n/** The files, each `undefined` when none is written, and what to say about them. */\nexport interface RootFiles {\n  sitemap: string | undefined;\n  robots: string | undefined;\n  notes: RootFileNote[];\n}\n\n/** The sitemap and `robots.txt` for a site, and what the build says about them. */\nexport function rootFiles(sources: RootFileSources): RootFiles {\n  const notes: RootFileNote[] = [];\n  const base = normalizeBase(sources.base);\n  let sitemap: string | undefined;\n  let sitemapAddress: string | undefined;\n  if (sources.ownSitemap) {\n    // The site's own, at the same address, which robots.txt points to when there's an address.\n    notes.push({ level: \"info\", text: \"no sitemap.xml: public/sitemap.xml is the site's own.\" });\n    if (sources.site !== undefined) sitemapAddress = new URL(sitemapRoute(base), sources.site).href;\n  } else if (sources.site === undefined) {\n    notes.push({\n      level: \"warn\",\n      text: \"no sitemap.xml: a sitemap lists pages by their absolute addresses, and the site has no address. Set [consumer] site in ascribe.toml, or Astro's `site`.\",\n    });\n  } else {\n    sitemap = sitemapXml(sitemapAddresses({ ...sources, site: sources.site }));\n    sitemapAddress = new URL(sitemapRoute(base), sources.site).href;\n  }\n  let robots = robotsText(sources.lines, sitemapAddress);\n  if (robots !== undefined && base !== \"/\") {\n    notes.push({\n      level: \"info\",\n      text: `no robots.txt: Astro's \\`base\\` is \"${base}\", and a crawler reads robots.txt only at the host's root. Put these lines in the host's own:\\n${robots}`,\n    });\n    robots = undefined;\n  } else if (robots !== undefined && sources.ownRobots) {\n    notes.push({\n      level: \"info\",\n      text: `no robots.txt: public/robots.txt is the site's own. Ascribe's lines for it:\\n${robots}`,\n    });\n    robots = undefined;\n  }\n  return { sitemap, robots, notes };\n}\n\ntype Middleware = (req: IncomingMessage, res: ServerResponse, next: () => void) => void;\n\n/**\n * A dev-server middleware serving the sitemap at `<base>sitemap.xml` and\n * `robots.txt` at `/`, each as `files` has it when it's asked for, so each\n * rebuild's records are served.\n */\nexport function rootFilesMiddleware(base: string, files: () => RootFiles): Middleware {\n  const sitemapPath = sitemapRoute(base);\n  return (req, res, next) => {\n    if (req.method !== \"GET\" && req.method !== \"HEAD\") return next();\n    // Vite strips the base from `req.url`; connect keeps the original in `originalUrl`.\n    const pathname =\n      ((req as { originalUrl?: string }).originalUrl ?? req.url ?? \"\").split(/[?#]/, 1)[0] ?? \"\";\n    if (pathname !== sitemapPath && pathname !== \"/robots.txt\") return next();\n    const current = files();\n    const [text, type] =\n      pathname === sitemapPath\n        ? [current.sitemap, \"application/xml; charset=utf-8\"]\n        : [current.robots, \"text/plain; charset=utf-8\"];\n    if (text === undefined) return next();\n    res.setHeader(\"Content-Type\", type);\n    res.setHeader(\"Content-Length\", Buffer.byteLength(text));\n    res.end(req.method === \"HEAD\" ? undefined : text);\n  };\n}\n\n/** A route as `astro:routes:resolved` gives it, as much as these read. */\nexport interface AstroRoute {\n  pattern: string;\n  patternRegex: RegExp;\n  params: string[];\n  type: string;\n  origin: string;\n}\n\n/** Astro's routing, as much as these read. */\ninterface Routing {\n  base: string;\n  trailingSlash: \"always\" | \"never\" | \"ignore\";\n}\n\n/**\n * The site's own pages `astro dev` can name: each route of the site's own\n * with no parameters, other than the not-found and error pages, by its route\n * from the host's root. A page a route's `getStaticPaths` lists is known only\n * to a build.\n */\nexport function devSitePages(routes: readonly AstroRoute[], astro: Routing): string[] {\n  const root = normalizeBase(astro.base);\n  return routes\n    .filter(\n      (route) =>\n        route.type === \"page\" &&\n        route.origin === \"project\" &&\n        route.params.length === 0 &&\n        route.pattern !== \"/404\" &&\n        route.pattern !== \"/500\",\n    )\n    .map((route) => routeAs(`${root}${route.pattern.replace(/^\\//, \"\")}`, astro.trailingSlash));\n}\n\n/**\n * Whether a project's page, by its route from the host's root, has a route\n * in the site in `astro dev`: whether one of the site's own routes matches\n * it. A project no route shows, such as one whose collection a page only\n * quotes from, has no pages in the sitemap.\n */\nexport function devRouted(\n  routes: readonly AstroRoute[],\n  astro: Routing,\n): (route: string) => boolean {\n  const root = normalizeBase(astro.base);\n  const pages = routes.filter((route) => route.type === \"page\" && route.origin === \"project\");\n  return (route) => {\n    if (!`${route}/`.startsWith(root)) return false;\n    const under = `/${route.slice(root.length)}`;\n    const forms = new Set([under, routeKey(under), `${routeKey(under)}/`]);\n    return pages.some((page) => [...forms].some((form) => page.patternRegex.test(form)));\n  };\n}\n"]}

package/dist/run.js

@@ -2,8 +2,9 @@
 // its JSON output while review is on.
 import { execFile } from "node:child_process";
 /**
- * A check's summary line, the report's last: `checked 14 files: 0 errors, 0 warnings`,
- * with `, 3 advice` after when there is advice.
+ * A check's summary line, the report's last: `checked 14 files for build \`site\`, reported on 14:
+ * 0 errors, 0 warnings, 0 advice`. An older binary wrote `checked 14 files: 0 errors,
+ * 0 warnings`, with `, 3 advice` after only when there was advice.
  */
 const SUMMARY = /^checked [^:\n]*: (\d+) errors?, (\d+) warnings?(?:, \d+ advice)?$/;
 /**

package/dist/run.js.map

@@ -1 +1 @@
-{"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,sCAAsC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAU9C;;;GAGG;AACH,MAAM,OAAO,GAAG,oEAAoE,CAAC;AAErF;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,WAAmB;IAC7C,IAAI,WAAW,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IACrC,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7E,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACxB,OAAoC,EACpC,OAAe,EACf,MAAM,GAAG,KAAK;IAEd,OAAO,OAAO,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC;AAClF,CAAC;AAED,kHAAkH;AAClH,MAAM,UAAU,SAAS,CAAC,MAAoC,EAAE,OAAe;IAC7E,OAAO,OAAO,KAAK,KAAK,IAAI,MAAM,KAAK,KAAK,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,OASxB;IACC,MAAM,IAAI,GAAG;QACX,OAAO;QACP,QAAQ;QACR,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACvC,SAAS;QACT,OAAO,CAAC,KAAK;QACb,UAAU;QACV,OAAO,CAAC,UAAU;QAClB,SAAS;QACT,OAAO;KACR,CAAC;IACF,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI;QAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACrD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,QAAQ,CACN,OAAO,CAAC,MAAM,EACd,IAAI,EACJ,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI,EAAE,EACjD,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;YACxB,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACnB,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;gBAC3C,MAAM,CACJ,IAAI,KAAK,CACP,2BAA2B,OAAO,CAAC,KAAK,YAAY,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,EAAE,EAC3G,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CACF,CAAC;gBACF,OAAO;YACT,CAAC;YACD,OAAO,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAClE,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Running `ascribe build` for the configured build: its site output, and\n// its JSON output while review is on.\nimport { execFile } from \"node:child_process\";\n\n/** What a successful build printed. */\nexport interface BuildResult {\n  /** The checks' report, which is more than a summary line when there is anything to report. */\n  diagnostics: string;\n  /** The `built <build>/site: …` lines. */\n  summary: string;\n}\n\n/**\n * A check's summary line, the report's last: `checked 14 files: 0 errors, 0 warnings`,\n * with `, 3 advice` after when there is advice.\n */\nconst SUMMARY = /^checked [^:\\n]*: (\\d+) errors?, (\\d+) warnings?(?:, \\d+ advice)?$/;\n\n/**\n * Whether a build's report is worth a warning: anything but a report whose\n * summary line counts no errors and no warnings, which is logged at info\n * level, advice and all.\n */\nexport function hasWarnings(diagnostics: string): boolean {\n  if (diagnostics === \"\") return false;\n  const summary = SUMMARY.exec(diagnostics.trimEnd().split(\"\\n\").at(-1) ?? \"\");\n  return summary === null || summary[1] !== \"0\" || summary[2] !== \"0\";\n}\n\n/**\n * Whether an Astro command builds with source anchors, given the integration's\n * `anchors` option: `\"dev\"` means in `astro dev` only, so `astro build` has\n * them only when it is `true`. Review in the site preview (`review`) needs\n * them in `astro dev`.\n */\nexport function anchorsFor(\n  anchors: boolean | \"dev\" | undefined,\n  command: string,\n  review = false,\n): boolean {\n  return anchors === true || (command === \"dev\" && (anchors === \"dev\" || review));\n}\n\n/** Whether an Astro command has review in the site preview, given the `review` option (an entry's name is on). */\nexport function reviewFor(review: boolean | string | undefined, command: string): boolean {\n  return command === \"dev\" && review !== false;\n}\n\n/**\n * Builds one build's outputs, the site output by default. Rejects, with the compiler's report as the\n * message, if the build has errors: the Astro build fails with them.\n */\nexport function runBuild(options: {\n  binary: string;\n  configPath: string;\n  build: string;\n  cwd: string;\n  /** Write source anchors (`--anchors`). */\n  anchors?: boolean;\n  /** The outputs to write. Default: `[\"site\"]`. */\n  outputs?: readonly (\"site\" | \"plain\" | \"json\")[];\n}): Promise<BuildResult> {\n  const args = [\n    \"build\",\n    \"--emit\",\n    (options.outputs ?? [\"site\"]).join(\",\"),\n    \"--build\",\n    options.build,\n    \"--config\",\n    options.configPath,\n    \"--color\",\n    \"never\",\n  ];\n  if (options.anchors === true) args.push(\"--anchors\");\n  return new Promise((resolve, reject) => {\n    execFile(\n      options.binary,\n      args,\n      { cwd: options.cwd, maxBuffer: 64 * 1024 * 1024 },\n      (error, stdout, stderr) => {\n        if (error !== null) {\n          const report = `${stdout}${stderr}`.trim();\n          reject(\n            new Error(\n              `\\`ascribe build --build ${options.build}\\` failed${report === \"\" ? `: ${error.message}` : `:\\n${report}`}`,\n              { cause: error },\n            ),\n          );\n          return;\n        }\n        resolve({ diagnostics: stdout.trim(), summary: stderr.trim() });\n      },\n    );\n  });\n}\n"]}
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../src/run.ts"],"names":[],"mappings":"AAAA,yEAAyE;AACzE,sCAAsC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAU9C;;;;GAIG;AACH,MAAM,OAAO,GAAG,oEAAoE,CAAC;AAErF;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,WAAmB;IAC7C,IAAI,WAAW,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IACrC,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7E,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACxB,OAAoC,EACpC,OAAe,EACf,MAAM,GAAG,KAAK;IAEd,OAAO,OAAO,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,CAAC,OAAO,KAAK,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC;AAClF,CAAC;AAED,kHAAkH;AAClH,MAAM,UAAU,SAAS,CAAC,MAAoC,EAAE,OAAe;IAC7E,OAAO,OAAO,KAAK,KAAK,IAAI,MAAM,KAAK,KAAK,CAAC;AAC/C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,OASxB;IACC,MAAM,IAAI,GAAG;QACX,OAAO;QACP,QAAQ;QACR,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACvC,SAAS;QACT,OAAO,CAAC,KAAK;QACb,UAAU;QACV,OAAO,CAAC,UAAU;QAClB,SAAS;QACT,OAAO;KACR,CAAC;IACF,IAAI,OAAO,CAAC,OAAO,KAAK,IAAI;QAAE,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACrD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,QAAQ,CACN,OAAO,CAAC,MAAM,EACd,IAAI,EACJ,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI,EAAE,EACjD,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;YACxB,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACnB,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC;gBAC3C,MAAM,CACJ,IAAI,KAAK,CACP,2BAA2B,OAAO,CAAC,KAAK,YAAY,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,EAAE,EAC3G,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CACF,CAAC;gBACF,OAAO;YACT,CAAC;YACD,OAAO,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAClE,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Running `ascribe build` for the configured build: its site output, and\n// its JSON output while review is on.\nimport { execFile } from \"node:child_process\";\n\n/** What a successful build printed. */\nexport interface BuildResult {\n  /** The checks' report, which is more than a summary line when there is anything to report. */\n  diagnostics: string;\n  /** The `built <build>/site: …` lines. */\n  summary: string;\n}\n\n/**\n * A check's summary line, the report's last: `checked 14 files for build \\`site\\`, reported on 14:\n * 0 errors, 0 warnings, 0 advice`. An older binary wrote `checked 14 files: 0 errors,\n * 0 warnings`, with `, 3 advice` after only when there was advice.\n */\nconst SUMMARY = /^checked [^:\\n]*: (\\d+) errors?, (\\d+) warnings?(?:, \\d+ advice)?$/;\n\n/**\n * Whether a build's report is worth a warning: anything but a report whose\n * summary line counts no errors and no warnings, which is logged at info\n * level, advice and all.\n */\nexport function hasWarnings(diagnostics: string): boolean {\n  if (diagnostics === \"\") return false;\n  const summary = SUMMARY.exec(diagnostics.trimEnd().split(\"\\n\").at(-1) ?? \"\");\n  return summary === null || summary[1] !== \"0\" || summary[2] !== \"0\";\n}\n\n/**\n * Whether an Astro command builds with source anchors, given the integration's\n * `anchors` option: `\"dev\"` means in `astro dev` only, so `astro build` has\n * them only when it is `true`. Review in the site preview (`review`) needs\n * them in `astro dev`.\n */\nexport function anchorsFor(\n  anchors: boolean | \"dev\" | undefined,\n  command: string,\n  review = false,\n): boolean {\n  return anchors === true || (command === \"dev\" && (anchors === \"dev\" || review));\n}\n\n/** Whether an Astro command has review in the site preview, given the `review` option (an entry's name is on). */\nexport function reviewFor(review: boolean | string | undefined, command: string): boolean {\n  return command === \"dev\" && review !== false;\n}\n\n/**\n * Builds one build's outputs, the site output by default. Rejects, with the compiler's report as the\n * message, if the build has errors: the Astro build fails with them.\n */\nexport function runBuild(options: {\n  binary: string;\n  configPath: string;\n  build: string;\n  cwd: string;\n  /** Write source anchors (`--anchors`). */\n  anchors?: boolean;\n  /** The outputs to write. Default: `[\"site\"]`. */\n  outputs?: readonly (\"site\" | \"plain\" | \"json\")[];\n}): Promise<BuildResult> {\n  const args = [\n    \"build\",\n    \"--emit\",\n    (options.outputs ?? [\"site\"]).join(\",\"),\n    \"--build\",\n    options.build,\n    \"--config\",\n    options.configPath,\n    \"--color\",\n    \"never\",\n  ];\n  if (options.anchors === true) args.push(\"--anchors\");\n  return new Promise((resolve, reject) => {\n    execFile(\n      options.binary,\n      args,\n      { cwd: options.cwd, maxBuffer: 64 * 1024 * 1024 },\n      (error, stdout, stderr) => {\n        if (error !== null) {\n          const report = `${stdout}${stderr}`.trim();\n          reject(\n            new Error(\n              `\\`ascribe build --build ${options.build}\\` failed${report === \"\" ? `: ${error.message}` : `:\\n${report}`}`,\n              { cause: error },\n            ),\n          );\n          return;\n        }\n        resolve({ diagnostics: stdout.trim(), summary: stderr.trim() });\n      },\n    );\n  });\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ascribed/astro",
-  "version": "0.2.1-next.14",
+  "version": "0.2.1-next.16",
   "description": "The Astro integration for Ascribe.",
   "type": "module",
   "license": "MPL-2.0",
@@ -12,12 +12,17 @@
   "homepage": "https://github.com/ascribed-dev/ascribe/tree/main/packages/astro#readme",
   "bugs": "https://github.com/ascribed-dev/ascribe/issues",
   "sideEffects": false,
+  "bin": {
+    "ascribe-astro": "./dist/cli.js"
+  },
   "files": [
     "dist",
+    "starter",
     "src/Elements.astro",
     "src/Availability.astro",
     "src/Permalink.astro",
-    "src/MissingPermalink.astro"
+    "src/MissingPermalink.astro",
+    "src/Head.astro"
   ],
   "exports": {
     ".": {
@@ -35,6 +40,7 @@
     "./Elements.astro": "./src/Elements.astro",
     "./Availability.astro": "./src/Availability.astro",
     "./MissingPermalink.astro": "./src/MissingPermalink.astro",
+    "./Head.astro": "./src/Head.astro",
     "./content": {
       "types": "./dist/content.d.ts",
       "default": "./dist/content.js"
@@ -48,9 +54,9 @@
     "node": ">=24"
   },
   "dependencies": {
-    "@ascribed/cli": "0.2.1-next.14",
-    "@ascribed/elements": "0.2.1-next.14",
-    "@ascribed/review": "0.2.1-next.14",
+    "@ascribed/cli": "0.2.1-next.16",
+    "@ascribed/elements": "0.2.1-next.16",
+    "@ascribed/review": "0.2.1-next.16",
     "github-slugger": "^2.0.0",
     "property-information": "^7.2.0",
     "smol-toml": "^1.9.0"
@@ -86,7 +92,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7f59c3e433d6830ddb59e07f050bd1ac21f71d11",
+  "gitHead": "0077fa1e1fcd4ef67f9c6d48575c3f06f98adce8",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc --noEmit",

package/src/Head.astro

@@ -0,0 +1,40 @@
+---
+// What a page's head says about it to every reader that isn't a person, from
+// its record in the build's `_ascribe/pages.json`: its `<title>`, its
+// description, its canonical link, and `<meta name="robots" content="noindex">`
+// when it isn't listed. Each comes from the record, as the sitemap and
+// `llms.txt` do, so none can disagree with them. A layout includes it in
+// `<head>`, given the page's collection entry:
+//
+//   <Head entry={entry} title={(page, record) => `${page} · Loom`} />
+//
+// `title` is a function from the page's title and its record, which has its
+// route, to the whole title. A page with no record, such as an Astro page of
+// the site's own, gets nothing: it writes its own head.
+import { pageRecord, type PageRecord } from "@ascribed/astro/content";
+
+interface Props {
+  /** The page's collection entry, or `undefined` for a page that has none. */
+  entry?: { filePath?: string | undefined; data?: unknown } | undefined;
+  /** The whole title, from the page's title and its record. Default: the page's title. */
+  title?: (title: string, record: PageRecord) => string;
+}
+
+const { entry, title } = Astro.props;
+const record = entry === undefined ? undefined : pageRecord(entry);
+const whole =
+  record?.title === undefined
+    ? undefined
+    : title === undefined
+      ? record.title
+      : title(record.title, record);
+---
+
+{whole !== undefined && <title>{whole}</title>}
+{
+  record?.description !== undefined && (
+    <meta name="description" content={record.description} />
+  )
+}
+{record?.canonical !== undefined && <link rel="canonical" href={record.canonical} />}
+{record?.listing === "unlisted" && <meta name="robots" content="noindex" />}

package/starter/src/content.config.ts

@@ -0,0 +1,8 @@
+import { defineCollection } from "astro:content";
+import { ascribeCollection } from "@ascribed/astro/content";
+// Generated by `ascribe build --emit site`; the integration runs it first.
+import { schema } from "../.ascribe/build/site/site/_ascribe/schema.ts";
+
+export const collections = {
+  docs: defineCollection(ascribeCollection({ schema })),
+};

package/starter/src/layouts/Docs.astro

@@ -0,0 +1,87 @@
+---
+import { getCollection, type CollectionEntry } from "astro:content";
+import type { ComponentProps } from "astro/types";
+import Availability from "@ascribed/astro/Availability.astro";
+import Elements from "@ascribed/astro/Elements.astro";
+// The page's title, description, canonical link, and robots rule, from its record.
+import Head from "@ascribed/astro/Head.astro";
+import { sidebar } from "@ascribed/astro/content";
+import { nav } from "../nav.ts";
+
+interface Props {
+  entry: CollectionEntry<"docs">;
+  headings: { depth: number; slug: string; text: string }[];
+}
+
+/**
+ * What the layout reads of a page's frontmatter: `title`, which every content
+ * type has, and what a type may have. `title` is plain text; `formatted.title`
+ * is the title as HTML, with its code spans as <code>, when the content model
+ * sets `inline = "code"` on `title`.
+ */
+interface Page {
+  title: string;
+  available?: ComponentProps<typeof Availability>["available"];
+  formatted?: { title?: string };
+}
+
+const { entry, headings } = Astro.props;
+const page = (of: CollectionEntry<"docs">) => of.data as Page;
+/** A page's title as HTML: its formatted form, or its plain text escaped. */
+const titleHtml = (of: CollectionEntry<"docs">) =>
+  page(of).formatted?.title ??
+  page(of).title.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;");
+const { available } = page(entry);
+// The sidebar: src/nav.ts's groups, each page with its address. The build
+// fails when the list leaves out a page, or names one that doesn't exist.
+const groups = sidebar(nav, await getCollection("docs"));
+---
+
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <Head entry={entry} />
+    <Elements />
+  </head>
+  <body>
+    <nav aria-label="Docs">
+      {
+        groups.map((group) => (
+          <section>
+            <h2>{group.label}</h2>
+            <ul>
+              {group.pages.map((item) => (
+                <li>
+                  <a
+                    href={item.href}
+                    aria-current={item.entry.id === entry.id ? "page" : undefined}
+                  >
+                    <Fragment set:html={titleHtml(item.entry)} />
+                  </a>
+                </li>
+              ))}
+            </ul>
+          </section>
+        ))
+      }
+    </nav>
+    <main>
+      <h1 set:html={titleHtml(entry)} />
+      <Availability available={available} />
+      <nav aria-label="On this page">
+        <ul>
+          {
+            headings.map((heading) => (
+              <li data-depth={heading.depth}>
+                <a href={`#${heading.slug}`}>{heading.text}</a>
+              </li>
+            ))
+          }
+        </ul>
+      </nav>
+      <article><slot /></article>
+    </main>
+  </body>
+</html>

package/starter/src/nav.ts

@@ -0,0 +1,13 @@
+// The sidebar's list: its groups, in order, each with its pages' source files,
+// relative to the content root. `npx @ascribed/astro init` wrote it from the
+// pages there were then; it's yours to reorder, relabel, and add to. Ascribe's
+// content model has no page order or grouping yet, so the site keeps the list,
+// and the layout's `sidebar()` keeps it complete: the build fails on a page the
+// list leaves out, and on a file it names that isn't a page.
+import type { NavGroup } from "@ascribed/astro/content";
+
+export const nav: NavGroup[] = [
+  { label: "Start", pages: ["index.md"] },
+  { label: "Guides", pages: ["Guides/My Setup.md"] },
+  { label: "Reference", pages: ["Reference/Options.md"] },
+];

package/starter/src/pages/[...slug].astro

@@ -0,0 +1,20 @@
+---
+import { getCollection, render } from "astro:content";
+import Docs from "../layouts/Docs.astro";
+
+// A page's route is the base path plus its entry id, and the root page (id
+// `index`) is at the base path itself: what Ascribe's router computes for
+// every link it writes.
+export async function getStaticPaths() {
+  const entries = await getCollection("docs");
+  return entries.map((entry) => ({
+    params: { slug: entry.id === "index" ? undefined : entry.id },
+    props: { entry },
+  }));
+}
+
+const { entry } = Astro.props;
+const { Content, headings } = await render(entry);
+---
+
+<Docs entry={entry} headings={headings}><Content /></Docs>