@heroiclands/package-build 22.15.1 → 22.17.0

package/engine/anchors.mjs

@@ -12,7 +12,7 @@
  */
 
 /**
- * The anchors a note declares on its headings — read in one place.
+ * The anchors a note declares on headings and captioned blocks.
  *
  * **A leaf, deliberately.** This is asked by the link checker, by the content
  * index, and by the builds that emit a link, and they cannot all import one
@@ -25,6 +25,8 @@
  * @module
  */
 
+import { scanCaptions } from "./content-captions.mjs";
+
 /**
  * A heading, and the `{#slug}` anchor it declares.
  *
@@ -38,11 +40,10 @@
 const HEADING = /^\s*(#{1,6})\s+(.+?)\s*#*\s*$/;
 const ANCHOR = /^(.*?)\s*\{#([^}]+)\}\s*$/;
 /**
- * The `{#slug}` anchors a note's body declares, with where each one sits.
+ * The `{#slug}` and `:::caption {#slug}` anchors a note declares.
  *
- * Only headings carrying an explicit anchor are collected. A bare `#` heading
- * also starts a journal page, but it declares no slug, so nothing can address
- * it with `#…` — listing it would offer a link that cannot be written.
+ * A bare `#` heading starts a journal page without declaring a slug. Captioned
+ * blocks declare a slug and start an addressable journal page.
  *
  * @param {string} body - The note's markdown body, frontmatter already removed.
  * @param {number} [bodyLine] - The 1-based file line the body starts on, from
@@ -79,5 +80,13 @@ export function collectAnchors(body, bodyLine = 1) {
             line: bodyLine + i,
         });
     }
-    return anchors;
+    for (const caption of scanCaptions(body).captions) {
+        anchors.push({
+            slug: caption.id,
+            name: caption.label,
+            level: 1,
+            line: bodyLine + caption.line - 1,
+        });
+    }
+    return anchors.sort((a, b) => a.line - b.line);
 }

package/engine/asset-bindings.mjs

@@ -22,7 +22,11 @@ function assetFiles(root) {
     return files;
 }
 
-/** Check configured foreign Address bindings against fetched indexes. */
+/**
+ * Check configured foreign Address bindings against fetched indexes.
+ * @param {object} config
+ * @param {{foreignIndex?: Map<string, object>, assets?: object[]}} [options]
+ */
 export function checkForeignAssetBindings(config, { foreignIndex, assets } = {}) {
     const copies = (assets ?? config.packageBuild?.assets ?? []).filter((asset) => asset.bindsTo);
     if (!copies.length) return [];
@@ -39,7 +43,7 @@ export function checkForeignAssetBindings(config, { foreignIndex, assets } = {})
                 {
                     file: "package-build.config.yaml",
                     severity: "error",
-                    message: `asset binding index for ${bindsTo.package} is unavailable; run content-build deps fetch`,
+                    message: `asset binding index for ${bindsTo.package} is unavailable; run package-build deps fetch`,
                 },
             ];
     }

package/engine/base-compiler.mjs

@@ -63,6 +63,10 @@
 
 import { authoredFrontmatter } from "./index-records.mjs";
 import { renderSecretBlocks } from "./content-secrets.mjs";
+import { scanAdmonitions } from "./content-admonitions.mjs";
+import { scanCaptions } from "./content-captions.mjs";
+import { renderMarkdownExpressions } from "./markdown-expressions.mjs";
+import { isGmNote } from "./note-vocabulary.mjs";
 import { cloneAddressState } from "./address-values.mjs";
 import fs from "fs";
 import path from "path";
@@ -82,7 +86,7 @@ import {
 import { isNoteRecord, noteFile } from "./index-records.mjs";
 import { reduceAddressFields } from "./address-fields.mjs";
 import { artPathname, artSlot, unacceptedArtMessage, unresolvedArtMessage } from "./art-fields.mjs";
-import { emitDiagnostic } from "./diagnostics.mjs";
+import { emitDiagnostic, positionOfLiteral } from "./diagnostics.mjs";
 import { assertNoDeclaredPackage } from "./note-package.mjs";
 import { assertNoDeclaredFolder } from "./folder-notes.mjs";
 import {
@@ -434,6 +438,7 @@ export class BasePackCompiler {
      *   routes to no pack at all — a build failure, never a silent drop.
      */
     routesHere(fm) {
+        if (isGmNote(fm) && !this.router?.privateOf?.(this.packName)) return false;
         if (!this.router || !this.packName || !this.docType) return true;
         return (
             this.router.resolve(fm, this.docType, this.packSystem ?? undefined) === this.packName
@@ -600,7 +605,6 @@ export class BasePackCompiler {
         // that converts no prose still compiles a document that carries art.
         this.linkIndex = this.corpus.linkIndex;
         if (this.constructor.convertsWikilinks) {
-            this.contentDocs = this.corpus.contentDocs;
             this.sqlTables = this.corpus.sqlTables;
         }
         // The package's declared present, read once from the same corpus — so
@@ -622,7 +626,8 @@ export class BasePackCompiler {
      *   that does not convert.
      */
     convertBody(fm, body) {
-        const secretError = renderSecretBlocks(body, "book").errors[0];
+        const secretError =
+            renderSecretBlocks(body, "book").errors[0] ?? scanAdmonitions(body).errors[0];
         if (secretError) {
             const error = new Error(secretError.message);
             error.position = {
@@ -638,13 +643,35 @@ export class BasePackCompiler {
         const name = resolveName(fm);
         const { absPath, bodyLine, bodyColumn } = this.currentNote ?? {};
         const { markdown: tabulated, lineMap } = expandNoteTables(body, {
-            docs: this.contentDocs,
             name,
-            fm,
             bodyLine,
             sqlTables: absPath ? this.sqlTables?.get(absPath) : undefined,
         });
-        const { markdown, unresolved } = convertNoteWikilinks(tabulated, {
+        const captionError = scanCaptions(tabulated).errors[0];
+        if (captionError) {
+            const error = new Error(captionError.message);
+            error.position = {
+                line:
+                    (bodyLine ?? 1) +
+                    (lineMap[captionError.line - 1]?.line ?? captionError.line - 1),
+                column: captionError.column,
+            };
+            throw error;
+        }
+        const expressions = renderMarkdownExpressions(tabulated, {
+            fm,
+            dates: reckoningContext(this.linkIndex),
+            sqlResults: absPath ? this.sqlTables?.inline?.get(absPath) : undefined,
+            file: absPath,
+            bodyLine,
+        });
+        if (expressions.findings.length) {
+            const finding = expressions.findings[0];
+            const error = new Error(finding.message);
+            error.position = { line: finding.line, column: finding.column };
+            throw error;
+        }
+        const { markdown, unresolved } = convertNoteWikilinks(expressions.markdown, {
             type: fm.type,
             id: fm.id,
             // Where this note is, so a link that resolves nowhere is reported
@@ -808,7 +835,7 @@ export class BasePackCompiler {
      * a line rather than at a note.
      *
      * Silent where nothing can answer — no published schema, or a subtype the
-     * artifact does not name. `content-build lint` says that out loud once for
+     * artifact does not name. `package-build lint` says that out loud once for
      * the whole build rather than once per note.
      *
      * @param {object} fm - The note's frontmatter.
@@ -1211,13 +1238,22 @@ export class BasePackCompiler {
                 this.onCompiled(fm, doc);
             } catch (err) {
                 this.errorCount++;
+                const repeatedAnchor = err.message.match(
+                    /declares the anchor \{#([^}]+)\} on more than one heading/,
+                );
+                const position =
+                    err.position ??
+                    (repeatedAnchor ?
+                        positionOfLiteral(
+                            fs.readFileSync(absPath, "utf8"),
+                            `{#${repeatedAnchor[1]}}`,
+                            2,
+                        )
+                    :   undefined);
                 // `position` is set by whatever failed if it knew where — an
                 // unresolved address, a bad table directive — so the report
                 // points at the line rather than at the note.
-                this.noteError(
-                    `${this.noteLabel(fm)} failed to compile: ${err.message}`,
-                    err.position,
-                );
+                this.noteError(`${this.noteLabel(fm)} failed to compile: ${err.message}`, position);
             }
         }
 

package/engine/being-measurements.mjs

@@ -0,0 +1,70 @@
+/* SPDX-License-Identifier: GPL-3.0-or-later */
+
+import { positionOfFrontmatterPath } from "./diagnostics.mjs";
+
+const INCHES_PER_METRE = 39.3701;
+const POUNDS_PER_KILOGRAM = 2.20462;
+
+/** Measurements are displayed as whole imperial units. */
+function safeRound(value) {
+    const rounded = Math.round(value);
+    return Number.isSafeInteger(rounded) && rounded >= 0 ? rounded : null;
+}
+
+/** Read a being's height as a whole number of inches. */
+export function parseBeingHeight(value) {
+    if (typeof value === "number")
+        return Number.isFinite(value) && value >= 0 ? safeRound(value * INCHES_PER_METRE) : null;
+    if (typeof value !== "string") return null;
+    const metric = /^(\d+(?:\.\d+)?) ?m$/.exec(value);
+    if (metric) return safeRound(Number(metric[1]) * INCHES_PER_METRE);
+    const imperial = /^(\d+)'(?:\s*(\d{1,2})")?$/.exec(value);
+    if (!imperial) return null;
+    const inches = Number(imperial[2] ?? 0);
+    return inches <= 11 ? safeRound(Number(imperial[1]) * 12 + inches) : null;
+}
+
+/** Read a being's weight as a whole number of pounds. */
+export function parseBeingWeight(value) {
+    if (typeof value === "number")
+        return Number.isFinite(value) && value >= 0 ? safeRound(value * POUNDS_PER_KILOGRAM) : null;
+    if (typeof value !== "string") return null;
+    const metric = /^(\d+(?:\.\d+)?) ?kg$/.exec(value);
+    if (metric) return safeRound(Number(metric[1]) * POUNDS_PER_KILOGRAM);
+    const imperial = /^(\d+) ?lbs$/.exec(value);
+    return imperial ? safeRound(Number(imperial[1])) : null;
+}
+
+/** Show a being's height in feet and inches. */
+export function displayBeingHeight(value) {
+    const inches = parseBeingHeight(value);
+    if (inches === null) return String(value);
+    const feet = Math.floor(inches / 12);
+    const remainder = inches % 12;
+    return String(feet) + "′" + (remainder ? " " + String(remainder) + "″" : "");
+}
+
+/** Show a being's weight in pounds. */
+export function displayBeingWeight(value) {
+    const pounds = parseBeingWeight(value);
+    return pounds === null ? String(value) : String(pounds) + " lbs";
+}
+
+/** Check one authored being measurement at its frontmatter position. */
+export function checkBeingMeasurement(note, key, parse) {
+    const value = note.fm?.data?.[key];
+    if (value === undefined || value === null || parse(value) !== null) return [];
+    return [
+        {
+            ...(note.file ? { file: note.file } : {}),
+            ...positionOfFrontmatterPath(note.raw ?? "", ["data", key]),
+            severity: "error",
+            message:
+                "data." +
+                key +
+                (key === "height" ?
+                    " needs metres or feet and inches, such as 1.91m or 6' 3\""
+                :   " needs kilograms or pounds, such as 85kg or 187 lbs"),
+        },
+    ];
+}

package/engine/calendar-artifacts.mjs

@@ -32,7 +32,7 @@ function readIndex(file) {
     const display = path.relative(process.cwd(), file) || file;
     if (!fs.existsSync(file)) {
         const error = new Error(
-            `${display}: error: content index is absent; run content-build content-index`,
+            `${display}: error: content index is absent; run package-build content-index`,
         );
         error.located = true;
         throw error;

package/engine/calendar-choice.mjs

@@ -0,0 +1,32 @@
+/* SPDX-License-Identifier: GPL-3.0-or-later */
+
+import { isAddressTuple, parseAddress, renderAddress } from "./address.mjs";
+import { positionOfFrontmatterPath } from "./diagnostics.mjs";
+
+/**
+ * Require a being's or place's chosen calendar to address a calendar note.
+ * @param {object} note
+ * @param {{index?: object}} [options]
+ */
+export function checkCalendarChoice(note, { index } = {}) {
+    const value = note.fm?.data?.calendar;
+    if (value === undefined || value === null || !index?.addressHit) return [];
+    const tuple = parseAddress(value, {
+        package: index.contentPackage,
+        system: "note",
+        type: "lore",
+        types: index.types,
+        packages: index.packages,
+    });
+    if (tuple.reason || tuple.type !== "lore") return [];
+    const target = index.addressHit(renderAddress(tuple));
+    if (!target || (target.fm ?? target).subType === "calendar") return [];
+    return [
+        {
+            file: note.file,
+            ...positionOfFrontmatterPath(note.raw ?? "", ["data", "calendar"]),
+            severity: "error",
+            message: `data.calendar ${isAddressTuple(value) ? renderAddress(value) : value} names lore whose subType is not calendar`,
+        },
+    ];
+}