@heroiclands/package-build 8.0.0 → 9.0.0

package/engine/frontmatter-lint.mjs

@@ -89,9 +89,7 @@ import { draftRetiredMessage } from "./retired-fields.mjs";
  *
  * @type {ReadonlySet<string>}
  */
-export const UNIVERSAL_KEYS = Object.freeze(
-    new Set(["folder", "pack", "archetype", "kbcat"]),
-);
+export const UNIVERSAL_KEYS = Object.freeze(new Set(["folder", "pack", "archetype", "kbcat"]));
 
 /**
  * Edit distance, capped — enough to answer "did you mean".
@@ -166,11 +164,7 @@ export function matchesKind(value, kind) {
                         value.trim() !== "" &&
                         Number.isFinite(Number(value));
         case "boolean":
-            return (
-                typeof value === "boolean" ||
-                value === "true" ||
-                value === "false"
-            );
+            return typeof value === "boolean" || value === "true" || value === "false";
         case "string":
             return typeof value !== "object" || value === null;
         case "list":
@@ -179,9 +173,7 @@ export function matchesKind(value, kind) {
             // An emptied map arrives as `[]` from the property editor, and
             // means "this note authors no entries" — the same thing `{}` means.
             return (
-                (typeof value === "object" &&
-                    value !== null &&
-                    !Array.isArray(value)) ||
+                (typeof value === "object" && value !== null && !Array.isArray(value)) ||
                 (Array.isArray(value) && value.length === 0)
             );
         default:
@@ -197,9 +189,7 @@ export function matchesKind(value, kind) {
  */
 function sohlBlock(fm) {
     const block = fm?.sohl;
-    return block && typeof block === "object" && !Array.isArray(block) ?
-            block
-        :   {};
+    return block && typeof block === "object" && !Array.isArray(block) ? block : {};
 }
 
 /**
@@ -217,8 +207,7 @@ export function lintNote(note, { schemas, index }) {
     const fm = note.fm ?? {};
     const type = String(fm.type ?? "");
     const raw = () => note.raw ?? "";
-    const at = (key, literal) =>
-        positionInFrontmatter(raw(), key, literal ?? undefined);
+    const at = (key, literal) => positionInFrontmatter(raw(), key, literal ?? undefined);
 
     // The retired top-level fields, checked before the type: a note may carry
     // one whatever its type is, and each finding stands on its own. Reported
@@ -312,8 +301,7 @@ export function lintNote(note, { schemas, index }) {
         const [head, ...rest] = field.name.split(".");
         let value = block[head];
         for (const segment of rest) {
-            value =
-                value && typeof value === "object" ? value[segment] : undefined;
+            value = value && typeof value === "object" ? value[segment] : undefined;
         }
         const absent = value === undefined || value === null;
 

package/engine/frontmatter.mjs

@@ -119,8 +119,7 @@ export function resolveCharges(fm) {
     // A blank maximum means "does not use charges" — a stray current count
     // cannot outlive it, since the logic layer disables both modifiers.
     return {
-        value:
-            max === null ? null : toCount(sohlField(fm, "charges.value", null)),
+        value: max === null ? null : toCount(sohlField(fm, "charges.value", null)),
         max,
     };
 }
@@ -149,9 +148,7 @@ export function resolveCharges(fm) {
 export function resolveSkillAptitudes(fm, ctx = "item") {
     const entries = readMapEntries(fm, "skillAptitudes");
     if (entries === null) {
-        throw new Error(
-            `${ctx}: skillAptitudes must be a map of selector → number`,
-        );
+        throw new Error(`${ctx}: skillAptitudes must be a map of selector → number`);
     }
     const out = {};
     for (const [selector, value] of entries) {
@@ -187,9 +184,7 @@ export function resolveSkillAptitudes(fm, ctx = "item") {
 export function resolveRelation(fm, ctx = "item") {
     const entries = readMapEntries(fm, "relation");
     if (entries === null) {
-        throw new Error(
-            `${ctx}: relation must be a map of shortcode → standing`,
-        );
+        throw new Error(`${ctx}: relation must be a map of shortcode → standing`);
     }
     const out = {};
     for (const [code, value] of entries) {

package/engine/generate.mjs

@@ -48,12 +48,7 @@ import { Journals } from "./journals.mjs";
 import { Actors } from "../sohl/actors.mjs";
 import { Macros } from "./macros.mjs";
 import { Scenes } from "./scenes.mjs";
-import {
-    statsForPack,
-    loadFolders,
-    buildFolderResolver,
-    writeFolderDocs,
-} from "./helpers.mjs";
+import { statsForPack, loadFolders, buildFolderResolver, writeFolderDocs } from "./helpers.mjs";
 import { countContentNotes } from "./content-tree.mjs";
 import { emitDiagnostic } from "./diagnostics.mjs";
 import { loadPackConfig } from "./pack-config.mjs";
@@ -170,10 +165,7 @@ export function orderPassesByDependency(packs) {
         readsOutputOf(pack.type).every(
             (dependency) =>
                 !declared.has(dependency) ||
-                packs.every(
-                    (other) =>
-                        other.type !== dependency || emitted.has(other.name),
-                ),
+                packs.every((other) => other.type !== dependency || emitted.has(other.name)),
         );
 
     while (remaining.length) {
@@ -269,8 +261,7 @@ async function generatePack(
     let folderList;
     let resolver;
     try {
-        folderList =
-            folders ? loadFolders(path.join(contentBase, folders)) : [];
+        folderList = folders ? loadFolders(path.join(contentBase, folders)) : [];
         ({ resolver } = buildFolderResolver(folderList));
     } catch (err) {
         log.error(`${name} ${folders} validation failed: ${err.message}`);
@@ -365,10 +356,7 @@ export function emptyPassErrors(passes) {
  * @throws {Error} If the configured Foundry package id has drifted from the
  *   shipped manifest's `id` (see `package-manifest.mjs`).
  */
-export async function generatePacksJson({
-    only,
-    config = loadPackConfig(),
-} = {}) {
+export async function generatePacksJson({ only, config = loadPackConfig() } = {}) {
     // Before anything is generated: every UUID written below is addressed to
     // the configured `foundryPackage`, so a value that has drifted from the shipped
     // manifest's `id` produces a whole pack of links that resolve nowhere.

package/engine/helpers.mjs

@@ -89,8 +89,7 @@ export function parseMarkdownFile(filePath) {
     // be reported as a file position (#17). The frontmatter's lines and the
     // blank lines `trim()` removes both sit in between, and the trim can take
     // indentation off the first line as well — hence a column, not just a line.
-    const bodyStart =
-        content.length - raw.length + (raw.length - raw.trimStart().length);
+    const bodyStart = content.length - raw.length + (raw.length - raw.trimStart().length);
     const before = content.slice(0, bodyStart);
     const bodyLine = before.split("\n").length;
     const bodyColumn = bodyStart - before.lastIndexOf("\n");
@@ -321,10 +320,7 @@ export function supportedCoreVersion(config = loadPackConfig()) {
  *   The resolved build configuration. Defaults to this repository's.
  * @returns {object} The `_stats` block.
  */
-export function buildStats(
-    systemVersion = undefined,
-    config = loadPackConfig(),
-) {
+export function buildStats(systemVersion = undefined, config = loadPackConfig()) {
     return {
         systemId: config.stats.systemId,
         systemVersion: systemVersion ?? config.stats.systemVersion,
@@ -473,9 +469,7 @@ export function buildContentLinkIndex(contentBase, router = packRouter()) {
     );
     if (stale.length) {
         for (const st of stale) {
-            log.error(
-                `Unusable link manifest for "${st.package}": ${st.reason}`,
-            );
+            log.error(`Unusable link manifest for "${st.package}": ${st.reason}`);
         }
         throw new Error(
             "Cross-package links cannot be resolved from a stale manifest; " +
@@ -486,12 +480,7 @@ export function buildContentLinkIndex(contentBase, router = packRouter()) {
         `Wikilink index: ${docs.length} local document(s), ` +
             `${foreign.size} foreign address(es)`,
     );
-    return buildWikilinkIndex(
-        docs,
-        foundryPackageId(),
-        foreign,
-        contentPackage(),
-    );
+    return buildWikilinkIndex(docs, foundryPackageId(), foreign, contentPackage());
 }
 
 /**
@@ -518,18 +507,7 @@ export function buildContentLinkIndex(contentBase, router = packRouter()) {
  */
 export function convertNoteWikilinks(
     body,
-    {
-        type,
-        id,
-        pack,
-        docPack,
-        index,
-        name,
-        file,
-        bodyLine,
-        bodyColumn,
-        lineMap,
-    },
+    { type, id, pack, docPack, index, name, file, bodyLine, bodyColumn, lineMap },
 ) {
     const result = convertWikilinks(body ?? "", {
         type,
@@ -580,9 +558,7 @@ export function convertNoteWikilinks(
             const claims = u.candidates ?? [];
             const named =
                 claims.length ?
-                    claims
-                        .map((c) => `"${c.name}" (${c.type}-${c.shortcode})`)
-                        .join(" and ")
+                    claims.map((c) => `"${c.name}" (${c.type}-${c.shortcode})`).join(" and ")
                 :   "two or more notes";
             fail(
                 u,
@@ -613,9 +589,7 @@ export function convertNoteWikilinks(
                 `unresolved wikilink ${u.link} (${u.reason}) in "${name}"` +
                 // A link this build wrote is not at any authored position, so
                 // say where it came from instead of implying an edit site.
-                (at.generated ?
-                    " — emitted by the content table on this line"
-                :   ""),
+                (at.generated ? " — emitted by the content table on this line" : ""),
         });
     }
     return result;
@@ -668,8 +642,7 @@ export function collectContentDocs(contentBase) {
  * unlinkable; a note missing either renders as plain text rather than shipping a
  * literal wikilink into a journal.
  */
-const packLinkable = (doc) =>
-    Boolean(doc.fm?.shortcode) && Boolean(doc.fm?.type);
+const packLinkable = (doc) => Boolean(doc.fm?.shortcode) && Boolean(doc.fm?.type);
 
 /**
  * Expand the fenced `dataview` tables in one note's markdown, before wikilinks
@@ -710,9 +683,7 @@ export function expandNoteTables(body, { docs, name, fm, bodyLine }) {
         self,
     });
     if (errors.length) {
-        const err = new Error(
-            errors.map((e) => `content table — ${e.reason}`).join("; "),
-        );
+        const err = new Error(errors.map((e) => `content table — ${e.reason}`).join("; "));
         // The first failing directive's line. Reporting one position for a
         // message that may name several is honest here: a caller opens the
         // file at the first thing to fix, and the message lists the rest.
@@ -735,18 +706,14 @@ export function expandNoteTables(body, { docs, name, fm, bodyLine }) {
  */
 export function loadFolders(foldersFile) {
     if (!fs.existsSync(foldersFile)) {
-        log.warn(
-            `No folders.yaml at ${foldersFile}; no folders will be emitted`,
-        );
+        log.warn(`No folders.yaml at ${foldersFile}; no folders will be emitted`);
         return [];
     }
     const raw = fs.readFileSync(foldersFile, "utf8");
     const parsed = yaml.parse(raw);
     if (parsed == null) return [];
     if (!Array.isArray(parsed)) {
-        throw new Error(
-            `folders.yaml must contain a YAML list; got ${typeof parsed}`,
-        );
+        throw new Error(`folders.yaml must contain a YAML list; got ${typeof parsed}`);
     }
     return parsed;
 }
@@ -818,10 +785,7 @@ export function buildFolderResolver(folders) {
  * underscores.
  */
 export function folderFilename(name, id) {
-    return (
-        `folder_${unidecode(name)}_${id}`.replace(/[^0-9a-zA-Z]+/g, "_") +
-        ".json"
-    );
+    return `folder_${unidecode(name)}_${id}`.replace(/[^0-9a-zA-Z]+/g, "_") + ".json";
 }
 
 /**
@@ -843,10 +807,7 @@ export function writeFolderDocs(folders, stats, destDir, documentType) {
             _stats: stats,
             _key: `!folders!${folder.id}`,
         };
-        const outPath = path.join(
-            destDir,
-            folderFilename(folder.name, folder.id),
-        );
+        const outPath = path.join(destDir, folderFilename(folder.name, folder.id));
         fs.writeFileSync(outPath, JSON.stringify(doc, null, 2), "utf8");
     }
     log.info(`Emitted ${folders.length} folder document(s) to ${destDir}`);

package/engine/homepage.mjs

@@ -262,9 +262,7 @@ export function checkHomepageCount(found, { contentBase, contentPackage }) {
     if (pages.length === 1) return [];
 
     return pages.map((page) => {
-        const others = pages
-            .filter((p) => p !== page)
-            .map((p) => formatLocator({ file: p.file }));
+        const others = pages.filter((p) => p !== page).map((p) => formatLocator({ file: p.file }));
         return {
             file: page.file,
             ...positionOfType(page.file),
@@ -292,11 +290,7 @@ export function checkHomepageCount(found, { contentBase, contentPackage }) {
  */
 function positionOfType(file) {
     try {
-        return positionInFrontmatter(
-            fs.readFileSync(file, "utf8"),
-            "type",
-            HOMEPAGE_TYPE,
-        );
+        return positionInFrontmatter(fs.readFileSync(file, "utf8"), "type", HOMEPAGE_TYPE);
     } catch {
         return {};
     }
@@ -325,9 +319,7 @@ export function homepageTitle(fm, config) {
         config?.packageBuild?.manifest
     );
     const title = manifest?.title;
-    return typeof title === "string" && title.trim() ?
-            title
-        :   config.contentPackage;
+    return typeof title === "string" && title.trim() ? title : config.contentPackage;
 }
 
 /**
@@ -394,10 +386,7 @@ export const HOMEPAGE_ADDRESS_KEYS = Object.freeze(new Set(["url", "href"]));
  */
 function collectProse(text, field, kind, out, skipCode = false) {
     const pattern = new RegExp(MARKDOWN_LINK.source, "g");
-    const matches =
-        skipCode ?
-            matchAllOutsideCode(text, pattern)
-        :   [...text.matchAll(pattern)];
+    const matches = skipCode ? matchAllOutsideCode(text, pattern) : [...text.matchAll(pattern)];
     for (const m of matches) out.push({ field, url: m[1], kind });
 }
 

package/engine/ids.mjs

@@ -36,11 +36,7 @@ import crypto from "crypto";
  * @returns {string} A 16-character hexadecimal Foundry id.
  */
 export function makeId(namespace, value) {
-    return crypto
-        .createHash("sha1")
-        .update(`${namespace}:${value}`)
-        .digest("hex")
-        .slice(0, 16);
+    return crypto.createHash("sha1").update(`${namespace}:${value}`).digest("hex").slice(0, 16);
 }
 
 /**
@@ -55,9 +51,7 @@ export function makeId(namespace, value) {
  *
  * @type {ReadonlySet<string>}
  */
-export const MAP_TYPES = Object.freeze(
-    new Set(["battlemap", "localmap", "regionalmap"]),
-);
+export const MAP_TYPES = Object.freeze(new Set(["battlemap", "localmap", "regionalmap"]));
 
 /**
  * Content type → the pack its documents compile into, and the document type
@@ -77,10 +71,7 @@ export const PACK_BY_TYPE = Object.freeze({
     macro: { pack: "macros", docType: "Macro" },
     being: { pack: "actors", docType: "Actor" },
     ...Object.fromEntries(
-        [...MAP_TYPES].map((type) => [
-            type,
-            { pack: "scenes", docType: "Scene" },
-        ]),
+        [...MAP_TYPES].map((type) => [type, { pack: "scenes", docType: "Scene" }]),
     ),
 });
 

package/engine/item-registry.mjs

@@ -72,9 +72,7 @@ export function itemTypes() {
  * @throws {Error} When the configuration registers no builder for `type`.
  */
 export function itemBuilder(type) {
-    const builder = /** @type {Record<string, Function>} */ (
-        loadPackConfig().itemBuilders
-    )[type];
+    const builder = /** @type {Record<string, Function>} */ (loadPackConfig().itemBuilders)[type];
     if (typeof builder !== "function") {
         throw new Error(
             `No builder registered for item type "${type}" — add one to the ` +
@@ -112,9 +110,7 @@ export function itemBuilder(type) {
  * @throws {Error} When the type's registry entry pairs no `img`.
  */
 export function itemArt(type) {
-    const art = /** @type {Record<string, string|undefined>} */ (
-        loadPackConfig().itemArt
-    )[type];
+    const art = /** @type {Record<string, string|undefined>} */ (loadPackConfig().itemArt)[type];
     if (!art) {
         throw new Error(
             `No default art for item type "${type}" — the note carries no ` +

package/engine/journals.mjs

@@ -45,13 +45,7 @@
 
 import log from "loglevel";
 
-import {
-    sohlField,
-    makeId,
-    resolveName,
-    defaultStats,
-    md,
-} from "./helpers.mjs";
+import { sohlField, makeId, resolveName, defaultStats, md } from "./helpers.mjs";
 import { BasePackCompiler } from "./base-compiler.mjs";
 import { anchorPageId } from "./wikilinks.mjs";
 import { hasDocEntry, itemDocEntryId } from "./item-docs.mjs";
@@ -98,12 +92,10 @@ export function splitPages(body, leadName = "Introduction") {
         // An H1 starts a page, as does any heading carrying an `{#slug}`
         // anchor: a Foundry UUID can only address a page, so a linkable
         // section has to be one.
-        const headingMatch =
-            !inCodeBlock ? line.match(/^\s*(#{1,6})\s+(.+?)\s*#*\s*$/) : null;
+        const headingMatch = !inCodeBlock ? line.match(/^\s*(#{1,6})\s+(.+?)\s*#*\s*$/) : null;
         const rawHeading = headingMatch?.[2]?.trim();
         const anchorMatch = rawHeading?.match(/^(.*?)\s*\{#([^}]+)\}\s*$/);
-        const startsPage =
-            headingMatch && (headingMatch[1].length === 1 || anchorMatch);
+        const startsPage = headingMatch && (headingMatch[1].length === 1 || anchorMatch);
         if (startsPage) {
             closeCurrent();
             current = {
@@ -371,8 +363,6 @@ export class Journals extends BasePackCompiler {
 
     /** @inheritdoc */
     reportDetail(stats) {
-        log.debug(
-            `Skipped ${stats.skippedOther} non-doc file(s) (not type:doc)`,
-        );
+        log.debug(`Skipped ${stats.skippedOther} non-doc file(s) (not type:doc)`);
     }
 }

package/engine/kb-manifest.mjs

@@ -180,9 +180,7 @@ export const PACKAGE_BASE = Object.freeze({
  */
 function checkBase(base, what) {
     if (typeof base !== "string" || !base.endsWith("/")) {
-        throw new Error(
-            `${what}: package base ${JSON.stringify(base)} must end in a slash`,
-        );
+        throw new Error(`${what}: package base ${JSON.stringify(base)} must end in a slash`);
     }
     return base;
 }
@@ -226,8 +224,7 @@ export function resolvePackageUrl(rel, base) {
     checkBase(base, "resolvePackageUrl");
     if (typeof rel !== "string" || !rel || rel.startsWith("/")) {
         throw new Error(
-            `resolvePackageUrl: ${JSON.stringify(rel)} is not a package-` +
-                `relative address`,
+            `resolvePackageUrl: ${JSON.stringify(rel)} is not a package-` + `relative address`,
         );
     }
     return `${base}${rel}`;
@@ -289,8 +286,7 @@ export function buildManifest(pkg, entries, base, foundryPackage) {
         // address, so there is no fact being restated, and an anchor is not
         // required to live inside its own entry. Publishing the complete link
         // also keeps the page-id hash out of the published contract entirely.
-        if (e.anchors && Object.keys(e.anchors).length)
-            entry.anchors = e.anchors;
+        if (e.anchors && Object.keys(e.anchors).length) entry.anchors = e.anchors;
         out[e.key ?? canonicalKey(pkg, type, shortcode)] = entry;
     }
     return {
@@ -327,12 +323,7 @@ export function writeManifests(entriesByPackage, dir, bases, foundryPackages) {
     fs.mkdirSync(dir, { recursive: true });
     const written = [];
     for (const [pkg, entries] of entriesByPackage) {
-        const doc = buildManifest(
-            pkg,
-            entries,
-            bases?.[pkg],
-            foundryPackages?.[pkg],
-        );
+        const doc = buildManifest(pkg, entries, bases?.[pkg], foundryPackages?.[pkg]);
         const file = path.join(dir, `${pkg}.json`);
         fs.writeFileSync(file, `${JSON.stringify(doc, null, 2)}\n`);
         written.push({
@@ -430,10 +421,7 @@ export function loadForeignManifests(dir, localPackages, bases = PACKAGE_BASE) {
                         // Absent for an entry with no page. A consumer must
                         // tolerate that rather than invent an href, exactly as
                         // it already tolerates an entry with no `uuid`.
-                        url:
-                            v.path == null ?
-                                undefined
-                            :   resolvePackageUrl(v.path, base),
+                        url: v.path == null ? undefined : resolvePackageUrl(v.path, base),
                         uuid: v.uuid,
                         doc: v.doc,
                         anchors: v.anchors,

package/engine/macros.mjs

@@ -51,12 +51,7 @@
 
 import log from "loglevel";
 
-import {
-    sohlField,
-    resolveName,
-    resolveImg,
-    defaultStats,
-} from "./helpers.mjs";
+import { sohlField, resolveName, resolveImg, defaultStats } from "./helpers.mjs";
 import { BasePackCompiler } from "./base-compiler.mjs";
 import { splitPages } from "./journals.mjs";
 
@@ -256,10 +251,7 @@ export function resolveMacroScope(fm, label) {
  * @returns {MacroDocument} The Macro document.
  * @throws {Error} When the frontmatter's macro type or scope is unusable.
  */
-export function buildMacroEntry(
-    fm,
-    { command, folder = null, stats = defaultStats() },
-) {
+export function buildMacroEntry(fm, { command, folder = null, stats = defaultStats() }) {
     const name = resolveName(fm);
     const id = fm.id;
     return {

package/engine/manifest-emit.mjs

@@ -142,11 +142,7 @@ export function entriesForNote(fm, name, address, body, ctx) {
         :   undefined;
 
     if (hasDocEntry(fm.type)) {
-        const docKey = canonicalKey(
-            contentPackage,
-            `doc${fm.type}`,
-            fm.shortcode,
-        );
+        const docKey = canonicalKey(contentPackage, `doc${fm.type}`, fm.shortcode);
         const docEntryId = fm.id ? itemDocEntryId(fm.id) : undefined;
         const docUuid = uuidFor("doc", docEntryId);
         return [
@@ -166,10 +162,7 @@ export function entriesForNote(fm, name, address, body, ctx) {
                 // documentation, so both addresses resolve to the same URL.
                 url,
                 uuid: docUuid,
-                anchors:
-                    docUuid ?
-                        anchorsOf(docUuid, docEntryId, body ?? "", name)
-                    :   undefined,
+                anchors: docUuid ? anchorsOf(docUuid, docEntryId, body ?? "", name) : undefined,
             },
         ];
     }
@@ -184,10 +177,7 @@ export function entriesForNote(fm, name, address, body, ctx) {
             name,
             url,
             uuid: own,
-            anchors:
-                own && fm.type === "doc" ?
-                    anchorsOf(own, fm.id, body ?? "", name)
-                :   undefined,
+            anchors: own && fm.type === "doc" ? anchorsOf(own, fm.id, body ?? "", name) : undefined,
         },
     ];
 }
@@ -221,10 +211,9 @@ export function collectManifestEntries(contentBase, ctx) {
     // note yields two entries, so reporting one as the other overstates how
     // much of the tree is published.
     let notes = 0;
-    for (const { frontmatter: fm, body, absPath } of walkMarkdownTree(
-        contentBase,
-        { skipDirectories: ctx.skipDirectories },
-    )) {
+    for (const { frontmatter: fm, body, absPath } of walkMarkdownTree(contentBase, {
+        skipDirectories: ctx.skipDirectories,
+    })) {
         if (!fm) continue;
         const rel = path.relative(contentBase, absPath);
         assertNoDeclaredPackage(fm, {