@metaobjectsdev/docs-site 0.15.8-rc.1

package/dist/package-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-docs.js","sourceRoot":"","sources":["../src/package-docs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAIhD,MAAM,UAAU,kBAAkB,CAAC,UAAoB;IACrD,MAAM,GAAG,GAAG,IAAI,GAAG,EAAsB,CAAC;IAC1C,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE;QACzB,KAAK,MAAM,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACrB,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;gBAAE,IAAI,CAAC,CAAC,CAAC,CAAC;iBAClC,IAAI,CAAC,KAAK,eAAe,EAAE,CAAC;gBAC/B,IAAI,CAAC;oBACH,MAAM,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAA8E,CAAC;oBACtH,MAAM,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC;oBACtB,IAAI,CAAC,EAAE,OAAO;wBAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;gBACjH,CAAC;gBAAC,MAAM,CAAC,CAAC,iFAAiF,CAAC,CAAC;YAC/F,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IACF,KAAK,MAAM,CAAC,IAAI,UAAU;QAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,CAAY,EAAE,CAAC,GAAG,CAAC;IAC1D,OAAO,CAAC,CAAC,KAAK,EAAE;SACb,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,QAAQ,IAAI,EAAE,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC;SAC7E,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;SAC7H,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACrE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACjB,CAAC"}

package/dist/scaffold.d.ts

@@ -0,0 +1,7 @@
+/** The 9 mustache templates the site is built from (basenames under templates/). */
+export declare const SITE_TEMPLATE_NAMES: readonly string[];
+/** The site's themeable assets (basenames under assets/). search-index.json is generated, not themed. */
+export declare const SITE_ASSET_NAMES: readonly string[];
+/** Read a bundled template or asset by basename (for scaffolding into a consumer). */
+export declare function readSiteFile(kind: "template" | "asset", name: string): string;
+//# sourceMappingURL=scaffold.d.ts.map

package/dist/scaffold.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":"AAIA,oFAAoF;AACpF,eAAO,MAAM,mBAAmB,EAAE,SAAS,MAAM,EAUhD,CAAC;AAEF,yGAAyG;AACzG,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAA4B,CAAC;AAE3E,sFAAsF;AACtF,wBAAgB,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI7E"}

package/dist/scaffold.js

@@ -0,0 +1,24 @@
+import { readFileSync } from "node:fs";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+/** The 9 mustache templates the site is built from (basenames under templates/). */
+export const SITE_TEMPLATE_NAMES = [
+    "chrome-head.mustache",
+    "chrome-foot.mustache",
+    "index.html.mustache",
+    "package.html.mustache",
+    "object.html.mustache",
+    "prompt.html.mustache",
+    "output.html.mustache",
+    "enums.html.mustache",
+    "coverage.html.mustache",
+];
+/** The site's themeable assets (basenames under assets/). search-index.json is generated, not themed. */
+export const SITE_ASSET_NAMES = ["site.css", "site.js"];
+/** Read a bundled template or asset by basename (for scaffolding into a consumer). */
+export function readSiteFile(kind, name) {
+    const selfDir = dirname(fileURLToPath(import.meta.url));
+    const dir = resolve(selfDir, kind === "template" ? "../templates" : "../assets");
+    return readFileSync(join(dir, name), "utf8");
+}
+//# sourceMappingURL=scaffold.js.map

package/dist/scaffold.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,oFAAoF;AACpF,MAAM,CAAC,MAAM,mBAAmB,GAAsB;IACpD,sBAAsB;IACtB,sBAAsB;IACtB,qBAAqB;IACrB,uBAAuB;IACvB,sBAAsB;IACtB,sBAAsB;IACtB,sBAAsB;IACtB,qBAAqB;IACrB,wBAAwB;CACzB,CAAC;AAEF,yGAAyG;AACzG,MAAM,CAAC,MAAM,gBAAgB,GAAsB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAE3E,sFAAsF;AACtF,MAAM,UAAU,YAAY,CAAC,IAA0B,EAAE,IAAY;IACnE,MAAM,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IACjF,OAAO,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC"}

package/dist/site.d.ts

@@ -0,0 +1,23 @@
+import type { CoverageReport } from "./coverage";
+import type { CoreConfig } from "./builders/index-data";
+import type { Anomaly } from "./builders/extras";
+export interface SiteOptions {
+    sourceDirs: string[];
+    outDir: string;
+    title: string;
+    stamp: string;
+    commit: string;
+    core?: CoreConfig;
+    /** Override dir; if a file of the same basename exists here, it wins over the bundled templates/ dir. */
+    templatesDir?: string;
+    /** Override dir for assets; if a file of the same basename exists here, it wins over the bundled assets/ dir. */
+    assetsDir?: string | undefined;
+}
+export interface SiteResult {
+    pages: string[];
+    coverage: CoverageReport;
+    anomalies: Anomaly[];
+    dangling: string[];
+}
+export declare function generateSite(opts: SiteOptions): Promise<SiteResult>;
+//# sourceMappingURL=site.d.ts.map

package/dist/site.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../src/site.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAGjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAMxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AASjD,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,yGAAyG;IACzG,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iHAAiH;IACjH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,cAAc,CAAC;IACzB,SAAS,EAAE,OAAO,EAAE,CAAC;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAwFD,wBAAsB,YAAY,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CA6JzE"}

package/dist/site.js

@@ -0,0 +1,219 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { render, InMemoryProvider } from "@metaobjectsdev/render";
+import { loadModel } from "./load";
+import { LinkGraph, fqnOf } from "./link-graph";
+import { CoverageTracker } from "./coverage";
+import { harvestComments } from "./yaml-comments";
+import { buildIndexPage } from "./builders/index-data";
+import { buildPackagePage } from "./builders/package-data";
+import { buildObjectPage } from "./builders/object-data";
+import { buildPromptPage } from "./builders/prompt-data";
+import { buildOutputPage } from "./builders/output-data";
+import { buildEnumsPage, findAnomalies, buildSearchIndex } from "./builders/extras";
+import { checkLinks } from "./link-check";
+import { legendHtml, esc as escBadge } from "./badges";
+// ─── Helpers ───────────────────────────────────────────────────────────────────
+/** Relative-root prefix: "" for root pages, "../../" for depth-2 pages. */
+function relRootFor(href) {
+    const depth = href.split("/").length - 1;
+    return "../".repeat(depth);
+}
+/** Write a file, creating parent dirs as needed. */
+function writeOut(outDir, relPath, content) {
+    const abs = join(outDir, relPath);
+    mkdirSync(dirname(abs), { recursive: true });
+    writeFileSync(abs, content);
+    return relPath;
+}
+// ─── Template loading ──────────────────────────────────────────────────────────
+const SELF_DIR = dirname(fileURLToPath(import.meta.url));
+const BUNDLED_TEMPLATES = resolve(SELF_DIR, "../templates");
+function loadTemplate(name, overrideDir) {
+    if (overrideDir) {
+        const candidate = join(overrideDir, name);
+        if (existsSync(candidate))
+            return readFileSync(candidate, "utf8");
+    }
+    return readFileSync(join(BUNDLED_TEMPLATES, name), "utf8");
+}
+const BUNDLED_ASSETS = resolve(SELF_DIR, "../assets");
+function loadAsset(name, overrideDir) {
+    if (overrideDir) {
+        const candidate = join(overrideDir, name);
+        if (existsSync(candidate))
+            return readFileSync(candidate, "utf8");
+    }
+    return readFileSync(join(BUNDLED_ASSETS, name), "utf8");
+}
+// ─── Nav HTML ─────────────────────────────────────────────────────────────────
+/**
+ * Build the sidebar nav HTML for a specific page as a collapsible tree.
+ * Each package is a <details> element (open if it's the current page's package).
+ * Members are listed as links within each package. Deterministic: sorted packages, sorted members.
+ */
+function buildNavHtml(g, relRoot, currentPkgPath, dataPackages, promptPackages) {
+    const nodes = g.nodes();
+    const renderGroup = (label, pkgList) => {
+        if (pkgList.length === 0)
+            return "";
+        const parts = [`<div class="text-xs font-semibold opacity-50 mt-3 mb-1">${label}</div>`];
+        for (const p of pkgList) {
+            const isOpen = p.pkgPath === currentPkgPath;
+            const pkgHref = escBadge(relRoot + p.pkgPath + "/index.html");
+            const pkgLabel = escBadge(p.pkg);
+            const members = nodes
+                .filter((n) => n.pkg === p.pkg)
+                .sort((a, b) => a.name.localeCompare(b.name));
+            const memberLinks = members.map((m) => `<a href="${escBadge(relRoot + m.href)}" class="link font-mono text-xs opacity-70 hover:opacity-100 pl-3 block">${escBadge(m.name)}</a>`).join("\n");
+            parts.push(`<details${isOpen ? " open" : ""}>\n` +
+                `<summary class="cursor-pointer font-mono text-xs opacity-70 hover:opacity-100"><a href="${pkgHref}">${pkgLabel}</a></summary>\n` +
+                memberLinks + `\n</details>`);
+        }
+        return parts.join("\n");
+    };
+    return [
+        renderGroup("Data", dataPackages),
+        renderGroup("Prompts", promptPackages),
+    ].filter(Boolean).join("\n");
+}
+// ─── Orchestrator ─────────────────────────────────────────────────────────────
+export async function generateSite(opts) {
+    // 1. Load + graph + comments
+    const loaded = await loadModel(opts.sourceDirs);
+    const g = new LinkGraph(loaded);
+    const docs = harvestComments(opts.sourceDirs);
+    const cov = new CoverageTracker();
+    // 2. Derive package lists (deterministic sort)
+    const nodes = g.nodes();
+    const allPkgs = [...new Set(nodes.map((n) => n.pkg))].sort();
+    const promptPkgSet = new Set(nodes.filter((n) => n.kind !== "object").map((n) => n.pkg));
+    const dataPkgList = allPkgs
+        .filter((p) => !promptPkgSet.has(p))
+        .map((p) => ({ pkg: p, pkgPath: p.split("::").join("/") }));
+    const promptPkgList = allPkgs
+        .filter((p) => promptPkgSet.has(p))
+        .map((p) => ({ pkg: p, pkgPath: p.split("::").join("/") }));
+    // 3. Load chrome templates (fixed)
+    const chromeHead = loadTemplate("chrome-head.mustache", opts.templatesDir);
+    const chromeFoot = loadTemplate("chrome-foot.mustache", opts.templatesDir);
+    // 4. Rendering helper: concat chrome + page template, render with payload + shared fields
+    const provider = new InMemoryProvider({});
+    const pages = [];
+    const legend = legendHtml();
+    // TOC builders — only list sections with non-empty data; ids must match id="s-..." in templates
+    const objectTocHtml = (d) => {
+        const sections = [
+            { id: "s-overview", label: "Overview", present: !!d.desc },
+            { id: "s-fields", label: "Fields", present: d.ownFields.length > 0 },
+            { id: "s-indexes", label: "Indexes &amp; keys", present: d.indexes.length > 0 },
+            { id: "s-validators", label: "Validators", present: d.validators.length > 0 },
+            { id: "s-relationships", label: "Relationships", present: d.relations.length > 0 },
+            { id: "s-provenance", label: "Field provenance", present: d.origins.length > 0 },
+            { id: "s-inheritance", label: "Inheritance", present: !!d.inheritanceMermaid },
+            { id: "s-neighborhood", label: "Neighborhood", present: !!d.neighborhoodMermaid },
+            { id: "s-referenced-by", label: "Referenced by", present: d.referencedBy.length > 0 },
+        ];
+        return sections
+            .filter((s) => s.present)
+            .map((s) => `<a href="#${s.id}" class="link opacity-70 hover:opacity-100">${s.label}</a>`)
+            .join("\n");
+    };
+    const promptTocHtml = (d) => {
+        const sections = [
+            { id: "s-payload", label: "Payload tree", present: d.payloadTree.length > 0 },
+            { id: "s-source", label: "Source", present: !!d.sourceHtml },
+        ];
+        return sections
+            .filter((s) => s.present)
+            .map((s) => `<a href="#${s.id}" class="link opacity-70 hover:opacity-100">${s.label}</a>`)
+            .join("\n");
+    };
+    const outputTocHtml = (d) => {
+        const sections = [
+            { id: "s-contract", label: "Parse contract", present: d.fields.length > 0 },
+        ];
+        return sections
+            .filter((s) => s.present)
+            .map((s) => `<a href="#${s.id}" class="link opacity-70 hover:opacity-100">${s.label}</a>`)
+            .join("\n");
+    };
+    const renderPage = (pageTemplateName, href, pageData, tocHtml = "", currentPkgPath = "") => {
+        const relRoot = relRootFor(href);
+        const navHtml = buildNavHtml(g, relRoot, currentPkgPath, dataPkgList, promptPkgList);
+        const pageTpl = loadTemplate(pageTemplateName, opts.templatesDir);
+        const template = chromeHead + pageTpl + chromeFoot;
+        const payload = {
+            ...pageData,
+            title: opts.title,
+            stamp: opts.stamp,
+            commit: opts.commit,
+            relRoot,
+            navHtml,
+            tocHtml,
+            legendHtml: legend,
+        };
+        const html = render({ template, payload, provider, format: "text" });
+        writeOut(opts.outDir, href, html);
+        pages.push(href);
+    };
+    // 5. Index page
+    const indexData = buildIndexPage(g, cov, {
+        title: opts.title,
+        stamp: opts.stamp,
+        commit: opts.commit,
+        core: opts.core,
+        sourceDirs: opts.sourceDirs,
+    });
+    renderPage("index.html.mustache", "index.html", indexData);
+    // 6. Enums page
+    const enumRows = buildEnumsPage(g);
+    renderPage("enums.html.mustache", "enums.html", { rows: enumRows });
+    // 7. Anomalies + coverage (deferred until all pages built — build now, write after member pages)
+    const anomalies = findAnomalies(g, opts.sourceDirs);
+    // 8. Package + member pages (deterministic: pkgs sorted, then members sorted)
+    for (const pkg of allPkgs) {
+        const pkgData = buildPackagePage(pkg, g, cov, opts.sourceDirs);
+        const pkgHref = `${pkgData.pkgPath}/index.html`;
+        renderPage("package.html.mustache", pkgHref, pkgData, "", pkgData.pkgPath);
+        // Member pages sorted by name
+        const pkgNodes = nodes.filter((n) => n.pkg === pkg).sort((a, b) => a.name.localeCompare(b.name));
+        for (const n of pkgNodes) {
+            const fqn = fqnOf(n.node);
+            const pkgPath = n.pkgPath;
+            if (n.kind === "object") {
+                const data = buildObjectPage(fqn, g, cov);
+                renderPage("object.html.mustache", n.href, data, objectTocHtml(data), pkgPath);
+            }
+            else if (n.kind === "prompt") {
+                const data = buildPromptPage(fqn, g, cov, opts.sourceDirs);
+                renderPage("prompt.html.mustache", n.href, data, promptTocHtml(data), pkgPath);
+            }
+            else if (n.kind === "output") {
+                const data = buildOutputPage(fqn, g, cov, docs, opts.sourceDirs);
+                renderPage("output.html.mustache", n.href, data, outputTocHtml(data), pkgPath);
+            }
+        }
+    }
+    // 9. Coverage page (after all member pages so cov is fully populated)
+    const coverage = cov.report(loaded.root);
+    const coverageData = {
+        kinds: coverage.kinds,
+        attrs: coverage.attrs,
+        anomalies,
+    };
+    renderPage("coverage.html.mustache", "coverage.html", coverageData);
+    // 10. Write assets (consumer assetsDir wins over the bundled dir)
+    writeOut(opts.outDir, "assets/site.css", loadAsset("site.css", opts.assetsDir));
+    writeOut(opts.outDir, "assets/site.js", loadAsset("site.js", opts.assetsDir));
+    // 11. Search index
+    const searchIndex = buildSearchIndex(g);
+    writeOut(opts.outDir, "assets/search-index.json", JSON.stringify(searchIndex));
+    // 12. Link check (throws if any dangling links found)
+    const dangling = checkLinks(opts.outDir, pages);
+    if (dangling.length)
+        throw new Error("link check failed:\n" + dangling.join("\n"));
+    return { pages, coverage, anomalies, dangling };
+}
+//# sourceMappingURL=site.js.map

package/dist/site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../src/site.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAEpF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,QAAQ,EAAE,MAAM,UAAU,CAAC;AA2BvD,kFAAkF;AAElF,2EAA2E;AAC3E,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACzC,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED,oDAAoD;AACpD,SAAS,QAAQ,CAAC,MAAc,EAAE,OAAe,EAAE,OAA4B;IAC7E,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC5B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,kFAAkF;AAElF,MAAM,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAEzD,MAAM,iBAAiB,GAAG,OAAO,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;AAE5D,SAAS,YAAY,CAAC,IAAY,EAAE,WAAoB;IACtD,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,UAAU,CAAC,SAAS,CAAC;YAAE,OAAO,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,YAAY,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAEtD,SAAS,SAAS,CAAC,IAAY,EAAE,WAAoB;IACnD,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,UAAU,CAAC,SAAS,CAAC;YAAE,OAAO,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;AAC1D,CAAC;AAED,iFAAiF;AAEjF;;;;GAIG;AACH,SAAS,YAAY,CACnB,CAAY,EACZ,OAAe,EACf,cAAsB,EACtB,YAAgD,EAChD,cAAkD;IAElD,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IAExB,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,OAA2C,EAAU,EAAE;QACzF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACpC,MAAM,KAAK,GAAa,CAAC,2DAA2D,KAAK,QAAQ,CAAC,CAAC;QACnG,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,MAAM,GAAG,CAAC,CAAC,OAAO,KAAK,cAAc,CAAC;YAC5C,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,GAAG,aAAa,CAAC,CAAC;YAC9D,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,OAAO,GAAG,KAAK;iBAClB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC;iBAC9B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YAChD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACpC,YAAY,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,4EAA4E,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CACzI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACb,KAAK,CAAC,IAAI,CACR,WAAW,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK;gBACrC,2FAA2F,OAAO,KAAK,QAAQ,kBAAkB;gBACjI,WAAW,GAAG,cAAc,CAC7B,CAAC;QACJ,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,CAAC;IAEF,OAAO;QACL,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC;QACjC,WAAW,CAAC,SAAS,EAAE,cAAc,CAAC;KACvC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,iFAAiF;AAEjF,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAiB;IAClD,6BAA6B;IAC7B,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAChD,MAAM,CAAC,GAAG,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9C,MAAM,GAAG,GAAG,IAAI,eAAe,EAAE,CAAC;IAElC,+CAA+C;IAC/C,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACxB,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7D,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzF,MAAM,WAAW,GAAG,OAAO;SACxB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACnC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAG,OAAO;SAC1B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SAClC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAE9D,mCAAmC;IACnC,MAAM,UAAU,GAAG,YAAY,CAAC,sBAAsB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,YAAY,CAAC,sBAAsB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAE3E,0FAA0F;IAC1F,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC;IAE5B,gGAAgG;IAChG,MAAM,aAAa,GAAG,CAAC,CAAiB,EAAU,EAAE;QAClD,MAAM,QAAQ,GAAsD;YAClE,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;YAC1D,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACpE,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/E,EAAE,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7E,EAAE,EAAE,EAAE,iBAAiB,EAAE,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YAClF,EAAE,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YAChF,EAAE,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,kBAAkB,EAAE;YAC9E,EAAE,EAAE,EAAE,gBAAgB,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,mBAAmB,EAAE;YACjF,EAAE,EAAE,EAAE,iBAAiB,EAAE,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;SACtF,CAAC;QACF,OAAO,QAAQ;aACZ,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACxB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,+CAA+C,CAAC,CAAC,KAAK,MAAM,CAAC;aACzF,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,CAAiB,EAAU,EAAE;QAClD,MAAM,QAAQ,GAAsD;YAClE,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7E,EAAE,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE;SAC7D,CAAC;QACF,OAAO,QAAQ;aACZ,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACxB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,+CAA+C,CAAC,CAAC,KAAK,MAAM,CAAC;aACzF,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,aAAa,GAAG,CAAC,CAAiB,EAAU,EAAE;QAClD,MAAM,QAAQ,GAAsD;YAClE,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;SAC5E,CAAC;QACF,OAAO,QAAQ;aACZ,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACxB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,+CAA+C,CAAC,CAAC,KAAK,MAAM,CAAC;aACzF,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG,CACjB,gBAAwB,EACxB,IAAY,EACZ,QAAiC,EACjC,UAAkB,EAAE,EACpB,iBAAyB,EAAE,EACrB,EAAE;QACR,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;QACrF,MAAM,OAAO,GAAG,YAAY,CAAC,gBAAgB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,CAAC;QACnD,MAAM,OAAO,GAAG;YACd,GAAG,QAAQ;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,OAAO;YACP,OAAO;YACP,OAAO;YACP,UAAU,EAAE,MAAM;SACnB,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QACrE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC,CAAC;IAEF,gBAAgB;IAChB,MAAM,SAAS,GAAG,cAAc,CAAC,CAAC,EAAE,GAAG,EAAE;QACvC,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,UAAU,EAAE,IAAI,CAAC,UAAU;KAC5B,CAAC,CAAC;IACH,UAAU,CAAC,qBAAqB,EAAE,YAAY,EAAE,SAA+C,CAAC,CAAC;IAEjG,gBAAgB;IAChB,MAAM,QAAQ,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IACnC,UAAU,CAAC,qBAAqB,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAA6B,CAAC,CAAC;IAE/F,iGAAiG;IACjG,MAAM,SAAS,GAAG,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAEpD,8EAA8E;IAC9E,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,gBAAgB,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,MAAM,OAAO,GAAG,GAAG,OAAO,CAAC,OAAO,aAAa,CAAC;QAChD,UAAU,CAAC,uBAAuB,EAAE,OAAO,EAAE,OAA6C,EAAE,EAAE,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAEjH,8BAA8B;QAC9B,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACjG,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC1B,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;YAC1B,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACxB,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;gBAC1C,UAAU,CAAC,sBAAsB,EAAE,CAAC,CAAC,IAAI,EAAE,IAA0C,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YACvH,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC3D,UAAU,CAAC,sBAAsB,EAAE,CAAC,CAAC,IAAI,EAAE,IAA0C,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YACvH,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;gBACjE,UAAU,CAAC,sBAAsB,EAAE,CAAC,CAAC,IAAI,EAAE,IAA0C,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;YACvH,CAAC;QACH,CAAC;IACH,CAAC;IAED,sEAAsE;IACtE,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG;QACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,SAAS;KACV,CAAC;IACF,UAAU,CAAC,wBAAwB,EAAE,eAAe,EAAE,YAAuC,CAAC,CAAC;IAE/F,kEAAkE;IAClE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAChF,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,gBAAgB,EAAE,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9E,mBAAmB;IACnB,MAAM,WAAW,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IACxC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,0BAA0B,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;IAE/E,sDAAsD;IACtD,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAChD,IAAI,QAAQ,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAEnF,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AAClD,CAAC"}

package/dist/yaml-comments.d.ts

@@ -0,0 +1,6 @@
+export interface CommentDocs {
+    objectDesc: Map<string, string>;
+    fieldNote: Map<string, string>;
+}
+export declare function harvestComments(sourceDirs: string[]): CommentDocs;
+//# sourceMappingURL=yaml-comments.d.ts.map

package/dist/yaml-comments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"yaml-comments.d.ts","sourceRoot":"","sources":["../src/yaml-comments.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,WAAW;IAAG,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAAE;AAGjG,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,WAAW,CA0BjE"}

package/dist/yaml-comments.js

@@ -0,0 +1,49 @@
+import { readdirSync, readFileSync, statSync } from "node:fs";
+import { join } from "node:path";
+const clean = (c) => c.replace(/^[#\s─═-]+/, "").replace(/[─═]+\s*$/, "").trim();
+export function harvestComments(sourceDirs) {
+    const objectDesc = new Map();
+    const fieldNote = new Map();
+    const files = [];
+    const walk = (d) => { for (const e of readdirSync(d)) {
+        const p = join(d, e);
+        if (statSync(p).isDirectory())
+            walk(p);
+        else if (/\.ya?ml$/.test(e))
+            files.push(p);
+    } };
+    for (const d of sourceDirs)
+        walk(d);
+    for (const f of files) {
+        const lines = readFileSync(f, "utf8").split("\n");
+        let current;
+        for (let i = 0; i < lines.length; i++) {
+            const m = lines[i].match(/^\s*-\s*object\.\w+:/);
+            if (m) {
+                current = undefined;
+                for (let j = i + 1; j < Math.min(i + 4, lines.length); j++) {
+                    const nm = lines[j].match(/^\s*name:\s*(\S+)/);
+                    if (nm) {
+                        current = nm[1];
+                        break;
+                    }
+                }
+                if (current) {
+                    const desc = [];
+                    for (let k = i - 1; k >= 0 && lines[k].trim().startsWith("#"); k--) {
+                        const c = clean(lines[k].trim());
+                        if (c)
+                            desc.unshift(c);
+                    }
+                    if (desc.length)
+                        objectDesc.set(current, desc.join(" ").replace(/\s+/g, " ").slice(0, 400));
+                }
+            }
+            const fm = lines[i].match(/^\s*-\s*field\.\w+:\s*\{\s*name:\s*(\w+)[^}]*\}\s*#\s*(.+)$/);
+            if (fm && current)
+                fieldNote.set(`${current}.${fm[1]}`, clean(fm[2]).slice(0, 160));
+        }
+    }
+    return { objectDesc, fieldNote };
+}
+//# sourceMappingURL=yaml-comments.js.map

package/dist/yaml-comments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yaml-comments.js","sourceRoot":"","sources":["../src/yaml-comments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGjC,MAAM,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAEzF,MAAM,UAAU,eAAe,CAAC,UAAoB;IAClD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAC;IAAC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1F,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,GAAG,KAAK,MAAM,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;QAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;YAAE,IAAI,CAAC,CAAC,CAAC,CAAC;aAAM,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAAC,CAAC,CAAC,CAAC,CAAC;IAC9K,KAAK,MAAM,CAAC,IAAI,UAAU;QAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,OAA2B,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAClD,IAAI,CAAC,EAAE,CAAC;gBACN,OAAO,GAAG,SAAS,CAAC;gBACpB,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3D,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;oBAAC,IAAI,EAAE,EAAE,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;wBAAC,MAAM;oBAAC,CAAC;gBACtF,CAAC;gBACD,IAAI,OAAO,EAAE,CAAC;oBACZ,MAAM,IAAI,GAAa,EAAE,CAAC;oBAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBAAC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,IAAI,EAAE,CAAC,CAAC;wBAAC,IAAI,CAAC;4BAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;oBAAC,CAAC;oBACnI,IAAI,IAAI,CAAC,MAAM;wBAAE,UAAU,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;gBAC9F,CAAC;YACH,CAAC;YACD,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,6DAA6D,CAAC,CAAC;YAC1F,IAAI,EAAE,IAAI,OAAO;gBAAE,SAAS,CAAC,GAAG,CAAC,GAAG,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,CAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QACvF,CAAC;IACH,CAAC;IACD,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AACnC,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@metaobjectsdev/docs-site",
+  "version": "0.15.8-rc.1",
+  "description": "HTML documentation-site generator for metaobjects models — a browsable multi-page site (nav, search, per-object/package pages, kind-aware ER diagrams). Powers the `meta docs --site` surface.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+  ".": {
+  "bun": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "default": "./dist/index.js"
+}
+},
+"files": ["dist", "src", "templates", "assets", "README.md", "LICENSE"],
+"scripts": {
+"build": "tsc -p .",
+"typecheck": "tsc -p tsconfig.typecheck.json",
+"test": "bun test"
+},
+"license": "Apache-2.0",
+"author": "Doug Mealing <doug@dougmealing.com>",
+"homepage": "https://metaobjects.dev",
+"bugs": {
+"url": "https://github.com/metaobjectsdev/metaobjects/issues"
+},
+"repository": {
+"type": "git",
+"url": "https://github.com/metaobjectsdev/metaobjects.git",
+"directory": "server/typescript/packages/docs-site"
+},
+"keywords": ["metaobjects", "docs", "documentation", "html", "site", "erd"],
+"publishConfig": {
+"access": "public"
+},
+"dependencies": {
+"@metaobjectsdev/metadata": "0.15.8-rc.1",
+"@metaobjectsdev/render": "0.15.8-rc.1",
+"yaml": "^2.9.0"
+},
+"devDependencies": {
+"bun-types": "latest",
+"typescript": "^5.6.0"
+}
+}

package/src/badges.ts

@@ -0,0 +1,26 @@
+export const esc = (s: unknown) =>
+  String(s).replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+
+export interface Badge { text: string; cls: string; href?: string; title?: string; }
+
+export function badge(b: Badge): string {
+  const cls = `badge ${b.cls} badge-xs`;
+  const title = b.title ? ` title="${esc(b.title)}"` : "";
+  return b.href
+    ? `<a href="${esc(b.href)}" class="${cls}"${title}>${esc(b.text)}</a>`
+    : `<span class="${cls}"${title}>${esc(b.text)}</span>`;
+}
+
+export const LEGEND: { label: string; cls: string }[] = [
+  { label: "reference (fk)", cls: "badge-soft badge-info" },
+  { label: "contains (nested)", cls: "badge-soft badge-secondary" },
+  { label: "indexed / pk", cls: "badge-soft badge-success" },
+  { label: "required", cls: "badge-soft badge-error" },
+  { label: "deprecated", cls: "badge-soft badge-warning" },
+  { label: "enum", cls: "badge-soft badge-accent" },
+  { label: "optional", cls: "badge-soft badge-neutral" },
+];
+
+export function legendHtml(): string {
+  return LEGEND.map((l) => `<span class="badge ${l.cls} badge-xs">${esc(l.label)}</span>`).join(" ");
+}

package/src/builders/extras.ts

@@ -0,0 +1,61 @@
+import { existsSync } from "node:fs";
+import { join } from "node:path";
+import { LinkGraph, fqnOf } from "../link-graph";
+
+export interface EnumRow { owner: string; ownerHref: string; field: string; values: string[]; deflt: string; }
+export function buildEnumsPage(g: LinkGraph): EnumRow[] {
+  const rows: EnumRow[] = [];
+  for (const o of g.nodes().filter((n) => n.kind === "object")) {
+    for (const f of o.node.childrenOfType("field")) {
+      const values = f.attr("values");
+      if (Array.isArray(values)) rows.push({ owner: o.name, ownerHref: o.href, field: f.name, values: values.map(String), deflt: String(f.attr("default") ?? "") });
+    }
+  }
+  return rows.sort((a, b) => (a.owner + a.field).localeCompare(b.owner + b.field));
+}
+
+export interface Anomaly { kind: string; subject: string; href: string; detail: string; }
+export function findAnomalies(g: LinkGraph, sourceDirs: string[]): Anomaly[] {
+  const out: Anomaly[] = [];
+  const objs = g.nodes().filter((n) => n.kind === "object");
+  for (const o of objs) {
+    const fqn = fqnOf(o.node);
+    if (!o.node.isAbstract && g.degree(fqn) === 0) out.push({ kind: "orphan", subject: o.name, href: o.href, detail: "no inbound or outbound references" });
+    if (o.node.isAbstract && g.extendedBy(fqn).length === 0) out.push({ kind: "unextended-abstract", subject: o.name, href: o.href, detail: "abstract with no descendants" });
+    const fkFields = new Set<string>();
+    for (const i of o.node.childrenOfType("identity").filter((i) => i.subType === "reference")) {
+      const fv = i.attr("fields");
+      const names = Array.isArray(fv) ? fv.map(String) : [String(fv ?? "")];
+      for (const n of names) fkFields.add(n);
+    }
+    for (const f of o.node.childrenOfType("field")) {
+      if (/(^|[a-z])Id$/.test(f.name) && (f.subType === "string" || f.subType === "uuid") && f.attr("objectRef") === undefined && !fkFields.has(f.name) && !o.node.isAbstract)
+        out.push({ kind: "implied-ref", subject: `${o.name}.${f.name}`, href: `${o.href}#f-${f.name}`, detail: "looks like a reference but declares none" });
+    }
+  }
+  // unreachable payload VOs: object.value not reached from any template payload tree
+  const reachable = new Set<string>();
+  for (const t of g.nodes().filter((n) => n.kind !== "object")) {
+    const q = g.refsFrom(fqnOf(t.node)).filter((r) => r.kind === "payload").map((r) => r.to);
+    while (q.length) { const cur = q.shift()!; if (reachable.has(cur)) continue; reachable.add(cur); for (const r of g.refsFrom(cur)) if (r.kind === "field") q.push(r.to); }
+  }
+  for (const o of objs.filter((o) => o.node.subType === "value" && g.nodes().some((t) => t.kind !== "object" && t.pkg === o.pkg)))
+    if (!reachable.has(fqnOf(o.node)) && g.degree(fqnOf(o.node)) === 0)
+      out.push({ kind: "unreachable-vo", subject: o.name, href: o.href, detail: "value object not reachable from any template payload" });
+  for (const t of g.nodes().filter((n) => n.kind !== "object")) {
+    const ref = String(t.node.attr("textRef") ?? "");
+    if (ref && !sourceDirs.some((d) => existsSync(join(d, ...ref.split("/")) + ".mustache")))
+      out.push({ kind: "unresolved-textref", subject: t.name, href: t.href, detail: `@textRef ${ref} does not resolve (forward-pointing)` });
+  }
+  return out.sort((a, b) => (a.kind + a.subject).localeCompare(b.kind + b.subject));
+}
+
+export interface SearchEntry { t: string; h: string; k: "object" | "prompt" | "output" | "field"; }
+export function buildSearchIndex(g: LinkGraph): SearchEntry[] {
+  const out: SearchEntry[] = [];
+  for (const n of g.nodes()) {
+    out.push({ t: `${n.pkg}::${n.name}`, h: n.href, k: n.kind });
+    if (n.kind === "object") for (const f of n.node.childrenOfType("field")) out.push({ t: `${n.name}.${f.name}`, h: `${n.href}#f-${f.name}`, k: "field" });
+  }
+  return out.sort((a, b) => a.t.localeCompare(b.t));
+}

package/src/builders/index-data.ts

@@ -0,0 +1,95 @@
+import { LinkGraph, fqnOf } from "../link-graph";
+import type { CoverageTracker } from "../coverage";
+import { flowchartDomain, packageFlowchart } from "../mermaid";
+import { harvestPackageDocs } from "../package-docs";
+import { esc } from "../badges";
+
+export interface PkgCard { pkg: string; href: string; objectCount: number; promptCount: number; contractCount: number; purpose: string; }
+export interface CoreConfig { pin?: string[]; exclude?: string[]; n?: number; }
+export interface IndexPageData { title: string; stamp: string; commit: string; stats: { objects: number; tables: number; packages: number; promptVos: number; prompts: number; contracts: number; enums: number }; coreMermaid: string; coreCaption: string; coreLegend: { pkg: string; fill: string; stroke: string }[]; packageMermaid: string; fullEdges: { from: string; to: string; n: number }[]; dataPackages: PkgCard[]; promptPackages: PkgCard[]; }
+
+export function buildIndexPage(g: LinkGraph, cov: CoverageTracker, opts: { title: string; stamp: string; commit: string; core?: CoreConfig | undefined; sourceDirs?: string[] | undefined }): IndexPageData {
+  const objs = g.nodes().filter((n) => n.kind === "object");
+  const tpls = g.nodes().filter((n) => n.kind !== "object");
+  const pkgs = [...new Set(g.nodes().map((n) => n.pkg))].sort();
+  const promptPkgSet = new Set(tpls.map((t) => t.pkg));
+  const shortPkg = (p: string) => p.split("::").pop()!;
+  // core map = a CONNECTED cluster of the most-connected objects of ALL kinds (entities, projections,
+  // value objects), traversing every edge type (fk, field.object, origin, extends, relationship).
+  // Seed by total degree, pull in the seeds' neighbors so nothing dangles, cap the total, drop isolates.
+  const CORE_MAX = opts.core?.n ?? 28;
+  const excluded = new Set(opts.core?.exclude ?? []);
+  const degOf = (fqn: string) => g.refsFrom(fqn).length + g.refsTo(fqn).length;
+  // seed a BALANCED mix so all object kinds appear (payload VOs otherwise dominate by degree):
+  // top entities (data-model backbone) + top value objects (payload structure) + projections (views).
+  const topByType = (st: string, k: number) => objs.filter((n) => !n.node.isAbstract && n.node.subType === st && !excluded.has(fqnOf(n.node)))
+    .map((dn) => ({ dn, fqn: fqnOf(dn.node), deg: degOf(fqnOf(dn.node)) }))
+    .sort((a, b) => b.deg - a.deg || a.dn.name.localeCompare(b.dn.name)).slice(0, k);
+  const seeds = [...topByType("entity", 8), ...topByType("value", 5), ...topByType("projection", 3)];
+  const shown = new Map<string, (typeof seeds)[0]["dn"]>();
+  // pinned objects are force-included (author override), never excluded.
+  for (const f of opts.core?.pin ?? []) {
+    if (excluded.has(f)) continue;
+    const dn = g.byFqn(f); if (dn && dn.kind === "object") shown.set(f, dn);
+  }
+  for (const s of seeds) { if (shown.size >= CORE_MAX) break; if (!shown.has(s.fqn)) shown.set(s.fqn, s.dn); }
+  // rank candidate neighbors by how many shown nodes touch them, add until the cap
+  const cand = new Map<string, number>();
+  for (const f of shown.keys()) {
+    for (const e of g.refsFrom(f)) cand.set(e.to, (cand.get(e.to) ?? 0) + 1);
+    for (const e of g.refsTo(f)) cand.set(e.from, (cand.get(e.from) ?? 0) + 1);
+  }
+  for (const [f] of [...cand.entries()].filter(([f]) => !shown.has(f) && !excluded.has(f)).sort((a, b) => b[1] - a[1] || a[0].localeCompare(b[0]))) {
+    if (shown.size >= CORE_MAX) break;
+    const dn = g.byFqn(f); if (dn && dn.kind === "object") shown.set(f, dn);
+  }
+  // edges among the shown set — collapse parallel edges between a pair to ONE unlabeled edge
+  // (a projection can join a source object on 6-12 fields; the overview only needs the connection).
+  const heroEdges: { from: string; to: string; label: string; style?: "dashed" }[] = [];
+  const seenEdge = new Set<string>();
+  for (const [f, dn] of shown) for (const e of g.refsFrom(f)) if (shown.has(e.to)) {
+    const to = g.byFqn(e.to)!.name;
+    const key = `${dn.name}|${to}`;
+    if (!seenEdge.has(key)) { seenEdge.add(key); heroEdges.push({ from: dn.name, to, label: "", ...(e.cardinality === "many" ? { style: "dashed" as const } : {}) }); }
+  }
+  const connected = new Set(heroEdges.flatMap((e) => [e.from, e.to]));
+  const heroNodes = [...shown.values()].filter((dn) => connected.has(dn.name));
+  const hero = flowchartDomain(heroNodes.map((dn) => ({ name: dn.name, pkg: dn.pkg, kind: dn.node.subType })), heroEdges);
+  const coreMermaid = hero.mermaid, coreLegend = hero.legend;
+  const coreCaption = `${heroNodes.length} of the most-connected objects (entities, views, and payloads), colored by domain.`;
+  // package docs for purpose cards
+  const pdocs = harvestPackageDocs(opts.sourceDirs ?? []);
+  // package edges
+  const pkgEdges = new Map<string, number>();
+  for (const o of objs) for (const r of g.refsFrom(fqnOf(o.node))) {
+    if (r.kind === "extends") continue;
+    const t = g.byFqn(r.to); if (!t || t.pkg === o.pkg) continue;
+    const k = `${shortPkg(o.pkg)}→${shortPkg(t.pkg)}`; pkgEdges.set(k, (pkgEdges.get(k) ?? 0) + 1);
+  }
+  const fullEdges = [...pkgEdges.entries()].sort().map(([k, n]) => { const [from = "", to = ""] = k.split("→"); return { from, to, n }; });
+  const counts = new Map<string, number>(); for (const o of objs) counts.set(shortPkg(o.pkg), (counts.get(shortPkg(o.pkg)) ?? 0) + 1);
+  const card = (p: string): PkgCard => {
+    const doc = pdocs.get(p);
+    const purpose = esc((doc?.title ? doc.title + " — " : "") + (doc?.description ?? "")).slice(0, 160);
+    return { pkg: p, href: `${p.split("::").join("/")}/index.html`,
+      objectCount: objs.filter((o) => o.pkg === p).length,
+      promptCount: tpls.filter((t) => t.pkg === p && t.kind === "prompt").length,
+      contractCount: tpls.filter((t) => t.pkg === p && t.kind === "output").length,
+      purpose };
+  };
+  const enums = objs.reduce((n, o) => n + o.node.childrenOfType("field").filter((f) => Array.isArray(f.attr("values"))).length, 0);
+  return { title: opts.title, stamp: opts.stamp, commit: opts.commit,
+    stats: { objects: objs.length,
+      tables: objs.filter((o) => o.node.childrenOfType("source").length > 0).length,
+      packages: pkgs.length,
+      promptVos: objs.filter((o) => promptPkgSet.has(o.pkg)).length,
+      prompts: tpls.filter((t) => t.kind === "prompt").length,
+      contracts: tpls.filter((t) => t.kind === "output").length, enums },
+    coreMermaid,
+    coreCaption,
+    coreLegend,
+    packageMermaid: packageFlowchart(fullEdges.filter((e) => e.n >= 2), counts),
+    fullEdges,
+    dataPackages: pkgs.filter((p) => !promptPkgSet.has(p)).map(card),
+    promptPackages: pkgs.filter((p) => promptPkgSet.has(p)).map(card) };
+}