@forumulate/cli 0.8.0 → 0.10.0

package/dist/publish/scan-docs.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scanDocs = scanDocs;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const yaml_1 = require("yaml");
+const frontmatter_1 = require("./frontmatter");
+const names_1 = require("./names");
+const slots_1 = require("./slots");
+/**
+ * The docs half of reading a folder: one top-level folder per collection,
+ * files at the root in the root collection, nested folders as parent pages
+ * (the folder's `index.md` — or `README.md`, unless the space says
+ * `readme: skip` — is the parent; a folder without one gets a title-only stub
+ * so its children still have somewhere to hang).
+ */
+function scanDocs(absDir, spec, out, read, w) {
+    const rootName = spec.rootCollection ?? '';
+    const rootFiles = [];
+    const folders = [];
+    for (const e of (0, node_fs_1.readdirSync)(absDir).sort()) {
+        if (w.skip(absDir, e))
+            continue;
+        const abs = (0, node_path_1.join)(absDir, e);
+        if ((0, node_fs_1.statSync)(abs).isDirectory()) {
+            if (w.hasMarkdown(abs))
+                folders.push(e);
+        }
+        else if (names_1.MD.test(e))
+            rootFiles.push(e);
+    }
+    if (rootFiles.length) {
+        out.collections.push(collectionOf(absDir, '', rootName ? (0, names_1.slugify)(rootName) : '', rootName, [-1, ''], {}, out, read, w, rootFiles));
+    }
+    for (const name of folders) {
+        const abs = (0, node_path_1.join)(absDir, name);
+        const declared = { ...folderMeta(abs), ...(spec.collections?.[name] ?? {}) };
+        const [n, key] = (0, names_1.prefixOrder)(name);
+        const order = [typeof declared.order === 'number' ? declared.order : n, key];
+        const slug = typeof declared.slug === 'string'
+            ? (0, names_1.slugify)(declared.slug)
+            : (0, names_1.slugify)(name.replace(names_1.NUMERIC, ''));
+        const title = typeof declared.name === 'string' ? declared.name : (0, names_1.titleize)(name);
+        const nav = (declared.nav ?? undefined);
+        out.collections.push(collectionOf(abs, name, slug, title, order, nav, out, read, w));
+    }
+    out.collections.sort((a, b) => a.order[0] - b.order[0] || a.order[1].localeCompare(b.order[1]));
+}
+/** `_collection.yml` / `.yaml` / `.json` beside a collection's files. */
+function folderMeta(dir) {
+    for (const n of ['_collection.yml', '_collection.yaml', '_collection.json']) {
+        const p = (0, node_path_1.join)(dir, n);
+        if ((0, node_fs_1.existsSync)(p))
+            return ((0, yaml_1.parse)((0, node_fs_1.readFileSync)(p, 'utf8')) ?? {});
+    }
+    return {};
+}
+function collectionOf(abs, dir, slug, name, order, nav, out, read, w, onlyFiles) {
+    const col = { dir, slug, name, order, nav, pages: [] };
+    /**
+     * Walk one folder. `own` is the page that stands for this folder (its files
+     * nest under it; null at the collection's top) and `above` is the page that
+     * one nests under — which is where the folder's own index file hangs.
+     */
+    const walk = (folder, rel, own, above) => {
+        const entries = (onlyFiles ?? (0, node_fs_1.readdirSync)(folder).sort()).filter((e) => !w.skip(folder, e));
+        const files = entries.filter((e) => names_1.MD.test(e) && !(0, node_fs_1.statSync)((0, node_path_1.join)(folder, e)).isDirectory());
+        const dirs = onlyFiles
+            ? []
+            : entries.filter((e) => (0, node_fs_1.statSync)((0, node_path_1.join)(folder, e)).isDirectory() && w.hasMarkdown((0, node_path_1.join)(folder, e)));
+        const index = rel ? files.find(w.isIndex) : undefined;
+        for (const f of files) {
+            const parentSlug = f === index ? above : own;
+            const where = { importName: rel ? `${rel}/${f}` : f, rel, isFolderIndex: f === index };
+            const page = pageOf((0, node_path_1.join)(folder, f), where, parentSlug, slug, out, read, w);
+            if (page)
+                col.pages.push(page);
+        }
+        for (const d of dirs) {
+            const sub = (0, node_path_1.join)(folder, d);
+            const subRel = rel ? `${rel}/${d}` : d;
+            const subFiles = (0, node_fs_1.readdirSync)(sub).filter((e) => !w.skip(sub, e) && names_1.MD.test(e));
+            const subIndex = subFiles.find(w.isIndex);
+            let folderSlug;
+            if (subIndex) {
+                // The index decides the folder page's address; read it once for that.
+                const { data } = (0, frontmatter_1.splitFront)((0, node_fs_1.readFileSync)((0, node_path_1.join)(sub, subIndex), 'utf8'));
+                folderSlug =
+                    typeof data.slug === 'string' && data.slug.trim()
+                        ? (0, names_1.slugify)(data.slug)
+                        : (0, names_1.slugify)(d.replace(names_1.NUMERIC, ''));
+            }
+            else {
+                folderSlug = (0, names_1.slugify)(d.replace(names_1.NUMERIC, ''));
+                const title = (0, names_1.titleize)(d);
+                col.pages.push({
+                    file: `${(0, node_path_1.relative)(out.absDir, sub).split(node_path_1.sep).join('/')}/ (no index.md)`,
+                    importName: `${subRel}/index.md`,
+                    slug: folderSlug,
+                    parentSlug: own,
+                    order: (0, names_1.prefixOrder)(d),
+                    title,
+                    source: `---\ntitle: ${JSON.stringify(title)}\nslug: ${folderSlug}\n---\n`,
+                    body: '',
+                    meta: {},
+                    unknown: [],
+                    sections: {},
+                    stub: true,
+                });
+            }
+            walk(sub, subRel, folderSlug, own);
+        }
+    };
+    walk(abs, '', null, null);
+    return col;
+}
+function pageOf(abs, where, parentSlug, collectionSlug, out, read, w) {
+    const { importName, rel, isFolderIndex } = where;
+    const f = read(abs);
+    const name = (0, node_path_1.basename)(abs);
+    const stem = name.replace(names_1.MD, '');
+    const declaredSlug = typeof f.data.slug === 'string' && f.data.slug.trim() ? (0, names_1.slugify)(f.data.slug) : '';
+    const folder = node_path_1.posix.basename(rel);
+    const atCollectionTop = w.isIndex(name) && !rel;
+    const slug = declaredSlug ||
+        (isFolderIndex
+            ? (0, names_1.slugify)(folder.replace(names_1.NUMERIC, ''))
+            : atCollectionTop
+                ? collectionSlug || (0, names_1.slugify)((0, names_1.titleOf)(f.data, f.body, 'overview'))
+                : (0, names_1.slugify)(stem.replace(names_1.NUMERIC, '')));
+    if ((0, frontmatter_1.isDraft)(f.data)) {
+        // Remembered by slug: a draft is never written, and never pruned either.
+        out.drafts.add(slug);
+        out.warnings.push(`${f.rel}: draft — left out (and kept if it is live)`);
+        return null;
+    }
+    // Slots first: `short-answer:` on an FAQ question is a slot, not an unknown key.
+    const slotted = (0, slots_1.pageSlots)(f.data, f.body, w.slots);
+    const { meta, unknown } = (0, frontmatter_1.pageMeta)(slotted.rest, w.fieldKeys);
+    const n = (0, frontmatter_1.declaredOrder)(f.data);
+    const [prefixN, key] = (0, names_1.prefixOrder)(isFolderIndex ? folder : stem);
+    // A folder's index is ordered among the folder's siblings, by the folder's
+    // prefix; a collection's own index leads it unless it says otherwise.
+    const order = [n ?? (atCollectionTop ? -1 : prefixN), key];
+    out.slugByFile.set(f.rel, slug);
+    return {
+        file: f.rel,
+        importName,
+        slug,
+        parentSlug,
+        order,
+        title: (0, names_1.titleOf)(f.data, f.body, slug),
+        source: f.text,
+        body: f.body,
+        meta,
+        unknown: [...unknown, ...slotted.notes],
+        sections: slotted.sections,
+    };
+}
+//# sourceMappingURL=scan-docs.js.map

package/dist/publish/scan-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan-docs.js","sourceRoot":"","sources":["../../src/publish/scan-docs.ts"],"names":[],"mappings":";;AAeA,4BAoCC;AAnDD,qCAA0E;AAC1E,yCAAiE;AACjE,+BAA0C;AAC1C,+CAA6E;AAC7E,mCAA+E;AAC/E,mCAAoC;AAGpC;;;;;;GAMG;AACH,SAAgB,QAAQ,CACtB,MAAc,EACd,IAAe,EACf,GAAe,EACf,IAAY,EACZ,CAAW;IAEX,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,IAAI,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,MAAM,CAAC,IAAI,IAAA,qBAAW,EAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC3C,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAAE,SAAS;QAChC,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5B,IAAI,IAAA,kBAAQ,EAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;YAChC,IAAI,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,UAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;QACrB,GAAG,CAAC,WAAW,CAAC,IAAI,CAClB,YAAY,CAAC,MAAM,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAA,eAAO,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,SAAS,CAAC,CAC7G,CAAC;IACJ,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC/B,MAAM,QAAQ,GAAG,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC7E,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,CAAC;QACnC,MAAM,KAAK,GAAqB,CAAC,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC/F,MAAM,IAAI,GACR,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ;YAC/B,CAAC,CAAC,IAAA,eAAO,EAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,CAAC,CAAC,IAAA,eAAO,EAAC,IAAI,CAAC,OAAO,CAAC,eAAO,EAAE,EAAE,CAAC,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,gBAAQ,EAAC,IAAI,CAAC,CAAC;QACjF,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,IAAI,SAAS,CAAwC,CAAC;QAC/E,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC;IACD,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClG,CAAC;AAED,yEAAyE;AACzE,SAAS,UAAU,CAAC,GAAW;IAC7B,KAAK,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,EAAE,CAAC;QAC5E,MAAM,CAAC,GAAG,IAAA,gBAAI,EAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QACvB,IAAI,IAAA,oBAAU,EAAC,CAAC,CAAC;YAAE,OAAO,CAAC,IAAA,YAAS,EAAC,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAA4B,CAAC;IAClG,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,YAAY,CACnB,GAAW,EACX,GAAW,EACX,IAAY,EACZ,IAAY,EACZ,KAAuB,EACvB,GAAwC,EACxC,GAAe,EACf,IAAY,EACZ,CAAW,EACX,SAAoB;IAEpB,MAAM,GAAG,GAAoB,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACxE;;;;OAIG;IACH,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,GAAW,EAAE,GAAkB,EAAE,KAAoB,EAAE,EAAE;QACrF,MAAM,OAAO,GAAG,CAAC,SAAS,IAAI,IAAA,qBAAW,EAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5F,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAA,kBAAQ,EAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAC5F,MAAM,IAAI,GAAG,SAAS;YACpB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,OAAO,CAAC,MAAM,CACZ,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,kBAAQ,EAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,WAAW,CAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CACjF,CAAC;QACN,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,UAAU,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;YAC7C,MAAM,KAAK,GAAG,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC;YACvF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC5E,IAAI,IAAI;gBAAE,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACrB,MAAM,GAAG,GAAG,IAAA,gBAAI,EAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC5B,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,QAAQ,GAAG,IAAA,qBAAW,EAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,UAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/E,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YAC1C,IAAI,UAAkB,CAAC;YACvB,IAAI,QAAQ,EAAE,CAAC;gBACb,sEAAsE;gBACtE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAA,wBAAU,EAAC,IAAA,sBAAY,EAAC,IAAA,gBAAI,EAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;gBACvE,UAAU;oBACR,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;wBAC/C,CAAC,CAAC,IAAA,eAAO,EAAC,IAAI,CAAC,IAAI,CAAC;wBACpB,CAAC,CAAC,IAAA,eAAO,EAAC,CAAC,CAAC,OAAO,CAAC,eAAO,EAAE,EAAE,CAAC,CAAC,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,UAAU,GAAG,IAAA,eAAO,EAAC,CAAC,CAAC,OAAO,CAAC,eAAO,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC7C,MAAM,KAAK,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAC;gBAC1B,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;oBACb,IAAI,EAAE,GAAG,IAAA,oBAAQ,EAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,eAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,iBAAiB;oBACxE,UAAU,EAAE,GAAG,MAAM,WAAW;oBAChC,IAAI,EAAE,UAAU;oBAChB,UAAU,EAAE,GAAG;oBACf,KAAK,EAAE,IAAA,mBAAW,EAAC,CAAC,CAAC;oBACrB,KAAK;oBACL,MAAM,EAAE,eAAe,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,UAAU,SAAS;oBAC1E,IAAI,EAAE,EAAE;oBACR,IAAI,EAAE,EAAE;oBACR,OAAO,EAAE,EAAE;oBACX,QAAQ,EAAE,EAAE;oBACZ,IAAI,EAAE,IAAI;iBACX,CAAC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC;QACrC,CAAC;IACH,CAAC,CAAC;IACF,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1B,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,MAAM,CACb,GAAW,EACX,KAAkE,EAClE,UAAyB,EACzB,cAAsB,EACtB,GAAe,EACf,IAAY,EACZ,CAAW;IAEX,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;IACjD,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;IACpB,MAAM,IAAI,GAAG,IAAA,oBAAQ,EAAC,GAAG,CAAC,CAAC;IAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,UAAE,EAAE,EAAE,CAAC,CAAC;IAClC,MAAM,YAAY,GAChB,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAA,eAAO,EAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACpF,MAAM,MAAM,GAAG,iBAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAChD,MAAM,IAAI,GACR,YAAY;QACZ,CAAC,aAAa;YACZ,CAAC,CAAC,IAAA,eAAO,EAAC,MAAM,CAAC,OAAO,CAAC,eAAO,EAAE,EAAE,CAAC,CAAC;YACtC,CAAC,CAAC,eAAe;gBACf,CAAC,CAAC,cAAc,IAAI,IAAA,eAAO,EAAC,IAAA,eAAO,EAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;gBAChE,CAAC,CAAC,IAAA,eAAO,EAAC,IAAI,CAAC,OAAO,CAAC,eAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5C,IAAI,IAAA,qBAAO,EAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QACpB,yEAAyE;QACzE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrB,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,6CAA6C,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,iFAAiF;IACjF,MAAM,OAAO,GAAG,IAAA,iBAAS,EAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAA,sBAAQ,EAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IAC9D,MAAM,CAAC,GAAG,IAAA,2BAAa,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,IAAA,mBAAW,EAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAClE,2EAA2E;IAC3E,sEAAsE;IACtE,MAAM,KAAK,GAAqB,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;IAC7E,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAChC,OAAO;QACL,IAAI,EAAE,CAAC,CAAC,GAAG;QACX,UAAU;QACV,IAAI;QACJ,UAAU;QACV,KAAK;QACL,KAAK,EAAE,IAAA,eAAO,EAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC;QACpC,MAAM,EAAE,CAAC,CAAC,IAAI;QACd,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,IAAI;QACJ,OAAO,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;QACvC,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B,CAAC;AACJ,CAAC"}

package/dist/publish/scan.d.ts

@@ -1,24 +1,28 @@
-import type { LocalSpace, SpaceSpec } from './types';
-export declare const MANIFEST_NAMES: string[];
-/** The product's slug rule (packages/shared `slugify`), mirrored: this package ships alone. */
-export declare function slugify(input: string, fallback?: string, max?: number): string;
+import { MANIFEST_NAMES } from './reserved';
+import type { Slot } from './slots';
+import type { ScanResult, SpaceSpec } from './types';
 /**
- * The product's TAG rule (apps/api `normalizeTag`), mirrored for the same reason
- * as `slugify`. Used to compare a front-matter tag list with the stored one: an
- * ASCII-only fold here turned every Japanese or Cyrillic tag into `-`, so two
- * different non-Latin tag lists compared equal and the update was skipped.
+ * A folder on disk, read into what it would publish.
+ *
+ * Docs are walked in `scan-docs.ts` (collections, nesting, folder pages).
+ * Everything else — blog, changelog, any type whose pieces are posts — is a
+ * flat set of posts, folders or not. Both go through the same skip rules
+ * (`reserved.ts`) and the same reader, which records the local files each
+ * document points at for upload.
  */
-export declare function tagKey(raw: string): string;
-/** `02-getting-started` → `Getting Started`. */
-export declare function titleize(name: string): string;
-export interface ScanResult extends LocalSpace {
-    /** Per file (relative to the space folder): reference as written → absolute asset path. */
-    refs: Map<string, Map<string, string>>;
-    /** Every Markdown file of the space (relative to the space folder) → its slug. */
-    slugByFile: Map<string, string>;
+export { slugify, tagKey, titleize } from './names';
+export type { ScanResult } from './types';
+export type { ScanShape };
+export { MANIFEST_NAMES };
+/** What the space's type declares, as far as reading a folder needs it. */
+interface ScanShape {
+    /** Declared parameters (`audience`, `topic`, …): front matter keys that go to `fields`. */
+    fieldKeys: string[];
+    /** Declared slots of a page-backed type, for front matter that fills them. */
+    slots?: Slot[];
 }
 /** Read one space folder. `kind` decides whether its files are pages or posts. */
-export declare function scanSpace(root: string, spec: SpaceSpec, kind: 'docs' | 'posts', fieldKeys: string[]): ScanResult;
+export declare function scanSpace(root: string, spec: SpaceSpec, kind: 'docs' | 'posts', shape: ScanShape | string[]): ScanResult;
 /** Every relative path → posix, for comparing with `importName`s. */
 export declare const toPosix: (p: string) => string;
 export declare const extOf: (p: string) => string;

package/dist/publish/scan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scan.d.ts","sourceRoot":"","sources":["../../src/publish/scan.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAA8B,UAAU,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAejF,eAAO,MAAM,cAAc,UAA2D,CAAC;AAKvF,+FAA+F;AAC/F,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,SAAS,EAAE,GAAG,SAAK,GAAG,MAAM,CAa1E;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAc1C;AAED,gDAAgD;AAChD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG7C;AAwED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,2FAA2F;IAC3F,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACvC,kFAAkF;IAClF,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,SAAS,EACf,IAAI,EAAE,MAAM,GAAG,OAAO,EACtB,SAAS,EAAE,MAAM,EAAE,GAClB,UAAU,CAgCZ;AAqPD,qEAAqE;AACrE,eAAO,MAAM,OAAO,GAAI,GAAG,MAAM,WAA2B,CAAC;AAC7D,eAAO,MAAM,KAAK,GAAI,GAAG,MAAM,WAA6B,CAAC"}
+{"version":3,"file":"scan.d.ts","sourceRoot":"","sources":["../../src/publish/scan.ts"],"names":[],"mappings":"AAKA,OAAO,EAA2B,cAAc,EAAkB,MAAM,YAAY,CAAC;AAErF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,KAAK,EAAU,UAAU,EAAE,SAAS,EAAW,MAAM,SAAS,CAAC;AAEtE;;;;;;;;GAQG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACpD,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC1C,YAAY,EAAE,SAAS,EAAE,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,CAAC;AAkG1B,2EAA2E;AAC3E,UAAU,SAAS;IACjB,2FAA2F;IAC3F,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,8EAA8E;IAC9E,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAChB;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,SAAS,EACf,IAAI,EAAE,MAAM,GAAG,OAAO,EACtB,KAAK,EAAE,SAAS,GAAG,MAAM,EAAE,GAC1B,UAAU,CAiDZ;AAgDD,qEAAqE;AACrE,eAAO,MAAM,OAAO,GAAI,GAAG,MAAM,WAA2B,CAAC;AAC7D,eAAO,MAAM,KAAK,GAAI,GAAG,MAAM,WAA6B,CAAC"}