@heroiclands/package-build 20.3.1 → 20.5.0

package/types/engine/folder-notes.d.mts

@@ -27,7 +27,7 @@ export function folderAddress(pkg: string, shortcode: string): string;
  * never run this build. Deriving it twice is how the index came to publish a
  * plausible-looking id that resolved to nothing — the general id rule hashes a
  * note's address under the `document` namespace, and a folder's is hashed under
- * {@link FOLDER_ID_NAMESPACE} (#310).
+ * {@link FOLDER_ID_NAMESPACE}.
  *
  * An **authored `id` still wins**, and is applied by the caller: this is the
  * derivation, not the resolution, so the pin rule stays stated once, where
@@ -42,8 +42,7 @@ export function folderDocId(pkg: string, shortcode: string): string;
  * Collect every folder note in a content tree.
  *
  * The walk is the caller's to supply, so this stays testable without a tree on
- * disk and so one build cannot disagree with another about what the corpus is
- * (#243).
+ * disk and so one build cannot disagree with another about what the corpus is.
  *
  * @param {Iterable<{frontmatter: object|null, absPath: string}>} notes - As
  *   yielded by `walkMarkdownTree`.
@@ -62,7 +61,7 @@ export function collectFolderNotes(notes: Iterable<{
  *
  * Three keys per folder, and no more: the canonical address, the
  * `folder-<shortcode>` short form, and the bare shortcode. They are the
- * suffixes of the canonical address the grammar admits (#273) — a `packFolder`
+ * suffixes of the canonical address the grammar admits — a `packFolder`
  * or `parent` field supplies the type itself, so a bare shortcode is a complete
  * address there.
  *
@@ -101,7 +100,7 @@ export function folderDocument(folder: FolderNote, parent: FolderNote | null, do
  * Refuse a note that declares the retired `folder:` spelling.
  *
  * `folder:` named a compendium folder by the raw Foundry id declared in a
- * per-pack `*-folders.yaml`. Both halves are retired together (#260): the id
+ * per-pack `*-folders.yaml`. Both halves are retired together: the id
  * spelling has nothing left to resolve against once the YAML is gone, and the
  * YAML has no reader once the spelling is refused.
  *

package/types/engine/foreign-catalog.d.mts

@@ -112,7 +112,7 @@ export function fetchCatalogFromPath(config: object, rel: {
     id: string;
 }, source: string): Promise<string>;
 /**
- * Fetch one dependency's published content index (#239).
+ * Fetch one dependency's published content index.
  *
  * **The chain is entirely declared.** The relationship names the dependency's
  * manifest, the manifest advertises `flags.metadataUrl`, and that URL is the
@@ -178,7 +178,7 @@ export function fetchAllCatalogs(config: object): Promise<number>;
  * Reads the cache only. A cold cache is an error naming the command that fills
  * it, rather than a download nobody asked for.
  *
- * **Scoped to one system when the caller compiles for one (#58)**, exactly as
+ * **Scoped to one system when the caller compiles for one**, exactly as
  * {@link module:engine/generate.itemPackJsonDirs} scopes the local half. The
  * two halves answer the same lookup — `loadItemsMap` merges them into one
  * address space keyed by `subType:shortcode` — so scoping only the local one
@@ -200,7 +200,7 @@ export function foreignItemCatalogDirs(config: object, system?: string | null):
     package: string;
 }>;
 /**
- * The file a system publishes its `system` field sets as (#60).
+ * The file a system publishes its `system` field sets as.
  *
  * @type {string}
  */

package/types/engine/foundry-entries.d.mts

@@ -20,8 +20,8 @@ export function anchorsOf(entryUuid: string, entryId: string, body: string, name
  * An item note produces **two**: the item, and separately the JournalEntry its
  * prose compiles into. They are two documents with two UUIDs, so they get two
  * addresses; the item's entry points at the other by address rather than
- * repeating its UUID, because the doc entry owns that fact (#1499). A `macro`
- * note is the same arrangement (#1514), which is why the type set comes from
+ * repeating its UUID, because the doc entry owns that fact. A `macro`
+ * note is the same arrangement, which is why the type set comes from
  * {@link hasDocEntry} rather than being spelled here — the journals compiler
  * reads the same one, so a manifest cannot claim documentation nothing compiled.
  *
@@ -33,7 +33,7 @@ export function anchorsOf(entryUuid: string, entryId: string, body: string, name
  * UUID. The two are one fact — a UUID ends in the id — but only the entry knows
  * which derivation produced it: an item's is its note's `fm.id`, and its
  * documentation journal's is {@link itemDocEntryId} of that. Stating it here is
- * what lets the content index publish an identity it did not re-derive (#310).
+ * what lets the content index publish an identity it did not re-derive.
  *
  * @param {object} ctx - Resolved identities: `{ contentPackage,
  *   foundryPackageId, packRouter }`.
@@ -44,12 +44,11 @@ export function entriesForNote(fm: object, name: string, address: string, body:
  * Every note this package publishes, as manifest entries.
  *
  * Every note in the tree is this package's, so nothing here selects by package:
- * the key's first segment is `contentPackage` (#56). A note still declaring the
+ * the key's first segment is `contentPackage`. A note still declaring the
  * retired `package:` or `draft:` field **throws** rather than being skipped —
  * skipping one silently is how a whole tree came to be filtered out of a
  * manifest that then claimed the package published nothing, and it is what let
- * a drafted note's inbound links look like links to a note that never existed
- * (#69).
+ * a drafted note's inbound links look like links to a note that never existed.
  *
  * A note that has no address is **reported, not guessed** — the finding carries
  * the file and the reason, so a caller can print it or fail on it. Inventing an
@@ -93,7 +92,7 @@ export function foundryIdentities(config?: object): {
  * {@link foundryIdentities} plus what only a *manifest* emission needs. The
  * split is what lets the content index derive the same Foundry addresses from
  * the same code without also depending on whether the package publishes pages,
- * which is no part of a UUID (#239).
+ * which is no part of a UUID.
  *
  * @param {object} [config] - A resolved configuration; loaded when omitted.
  * @returns {{contentPackage: string, foundryPackageId: string, packRouter: object,

package/types/engine/frontmatter-lint.d.mts

@@ -11,13 +11,13 @@
  *   than reported wholesale.
  */
 /**
- * Every system a configuration says its tree carries (#58).
+ * Every system a configuration says its tree carries.
  *
  * **Which systems a package ships for is already declared**, in three places
  * that answer different questions, so this reads all three rather than asking a
  * new one:
  *
- * - `systems:` (#48) declares them without requiring one, which is how a
+ * - `systems:` declares them without requiring one, which is how a
  *   package ships for several;
  * - a **pack's** `system:` is the same statement made per pack, and it is the
  *   one some trees make: `harn-ensemble` declares an `actors-sohl` and an
@@ -40,7 +40,7 @@
 export function declaredSystems(config?: object): string[];
 /**
  * The system blocks a configuration says its tree carries, and what each
- * accepts (#58).
+ * accepts.
  *
  * The lint checks the blocks its caller names, and for as long as there was one
  * system the only caller named none — so every tree took the `sohl:` of
@@ -112,10 +112,11 @@ export function matchesKind(value: unknown, kind: string): boolean;
  * @param {object} note - A note from the link index (`{fm, file, raw, type}`).
  * @param {object} opts
  * @param {Record<string, readonly object[]>} opts.schemas - Type → declaration.
- * @param {object} [opts.index] - The link index, for the reference check. Its
- *   absence skips that check rather than reporting every reference as dead.
+ * @param {object} [opts.index] - The link index, for the reference check, which
+ *   runs through its `referenceHit`. Its absence skips that check rather than
+ *   reporting every reference as dead.
  * @param {Record<string, object>} [opts.vocabulary] - Type → the closed regions
- *   it declares, as `engine/note-vocabulary.mjs` states them (#128). Supplied
+ *   it declares, as `engine/note-vocabulary.mjs` states them. Supplied
  *   by the caller for the same reason `schemas` is: this module validates a
  *   note against whatever its type declares and knows no type names of its
  *   own. Its absence skips the `data:` and `subType` checks rather than
@@ -125,7 +126,7 @@ export function matchesKind(value: unknown, kind: string): boolean;
  *   declaration, asked through `engine/generate.mjs`'s `emittedArtFor`.
  *   Supplied by the caller like `schemas`, so this module states no list of
  *   iconless types of its own; absent it, an inert `img:` goes unreported
- *   rather than every note's being (#349).
+ *   rather than every note's being.
  * @param {Readonly<Record<string, SystemBlockSpec>>} [opts.systems]
  *   The system blocks to check, and what each accepts. Supplied by the caller
  *   for the same reason `schemas` is — a build derives them from its
@@ -155,7 +156,7 @@ export function lintNote(note: object, { schemas, index, vocabulary, packs, emit
  * @param {object} opts
  * @param {Record<string, readonly object[]>} opts.schemas - Type → declaration.
  * @param {Record<string, object>} [opts.vocabulary] - Type → the closed regions
- *   it declares (#128); see {@link lintNote}.
+ *   it declares; see {@link lintNote}.
  * @param {boolean} [opts.references=true] - Whether to check references.
  * @param {Readonly<Record<string, SystemBlockSpec>>} [opts.systems]
  *   The system blocks to check; see {@link lintNote} and
@@ -191,7 +192,7 @@ export function lintFrontmatter(index: object, { schemas, vocabulary, packs, emi
  *
  * - `folder` — the compendium folder the document is filed in.
  * - `pack` — which compendium of the note's document type receives it, for a
- *   repository shipping several (#1566).
+ *   repository shipping several.
  * - `archetype` — the archetype flag, read for any note by the walk itself.
  * - `kbcat` — the knowledgebase category a note is grouped under.
  *

package/types/engine/frontmatter.d.mts

@@ -10,7 +10,7 @@ export function getFrontmatter(fm: any, key: any, defaultValue?: undefined): any
  */
 export function sohlField(fm: any, key: any, defaultValue?: undefined): any;
 /**
- * Read a `sohl:` field, seeing the **destination** position as well (#126).
+ * Read a `sohl:` field, seeing the **destination** position as well.
  *
  * Five declarations resolve their value by re-reading the note rather than by
  * taking the one {@link module:engine/system-block.resolveFieldValue} handed
@@ -29,8 +29,8 @@ export function sohlField(fm: any, key: any, defaultValue?: undefined): any;
  *
  * `legacyKey` is for the one pair whose two positions are spelled differently:
  * a projectile authors `impact.die` and stores `impactBase.die`, so the reader
- * has to be told both. It is the same split `FieldSpec.name`/`legacyKey` makes
- * (#305), for the same reason — one name cannot key two positions.
+ * has to be told both. It is the same split `FieldSpec.name`/`legacyKey` makes,
+ * for the same reason — one name cannot key two positions.
  *
  * @param {object} fm - The note's frontmatter.
  * @param {string} to - The key at the destination, dotted for a nested one.
@@ -46,7 +46,7 @@ export function sohlSystemField(fm: object, to: string, defaultValue?: any, { le
 /**
  * Resolve the `charges` block shared by Mystery and Mystical Ability items.
  *
- * Charge usage is carried by the **maximum** alone (#1129): a `null` max means
+ * Charge usage is carried by the **maximum** alone: a `null` max means
  * the item does not use charges at all, `0` means it is counted but uncapped,
  * and a positive number is a real cap. `value` is the current count, with
  * `null` meaning "infinite remaining". Both persist as nullable NumberFields,
@@ -87,7 +87,7 @@ export function resolveCharges(fm: object): {
 export function resolveSkillAptitudes(fm: object, ctx?: string): Record<string, number>;
 /**
  * Resolve an affiliation's `relation` map — the shortcode of another
- * affiliation → this one's standing toward it (#1404).
+ * affiliation → this one's standing toward it.
  *
  * An unrecognized standing would fail the schema's `choices` validation at load
  * and be dropped silently, shipping an affiliation whose authored hostility had
@@ -138,12 +138,12 @@ export function parseValueDesc(raw: any): {
  * (`folder-poisonsandtoxins`), resolved through the address index the whole
  * build shares. The `folder:` Foundry-id spelling this function once read
  * beside it, and the per-pack `*-folders.yaml` that id was resolved against,
- * are retired together (#260) — a note declaring `folder:` is refused by
+ * are retired together — a note declaring `folder:` is refused by
  * {@link module:engine/folder-notes.assertNoDeclaredFolder} rather than
  * reaching here, so there is no second source for a value to come from.
  *
  * **`packFolder` was a path for one release** (`Possessions/Misc_Gear/Cooking`)
- * and is an address now (#255). A path encoded the hierarchy *in the value*, so
+ * and is an address now. A path encoded the hierarchy *in the value*, so
  * reparenting a folder made every note naming it wrong — a structural edit
  * became a corpus-wide rewrite. An address is stable under reparenting, which
  * is exactly why a note is addressed by `(type, shortcode)` and never by

package/types/engine/generate.d.mts

@@ -10,7 +10,7 @@
 export function compilerFor(docType: string, system?: string | null): Function | undefined;
 /**
  * The art fields a note of one content type reaches its document through, and
- * the document it reaches (#349).
+ * the document it reaches.
  *
  * **Derived, never listed.** A note's type routes to a document type
  * ({@link packForType}), a document type routes to the pass that compiles it
@@ -39,7 +39,7 @@ export function emittedArtFor(type: string): {
  * The generated JSON of **every** configured Item pack — what the actors pass
  * reads its predefined items from.
  *
- * All of them, not the first: a repository may ship several Item packs (#1566),
+ * All of them, not the first: a repository may ship several Item packs,
  * and an actor's embedded items may be sourced from any of them. Finding one
  * pack and stopping is how embedded-item resolution would silently miss every
  * item that landed in another. Returned in configured order, which is also the
@@ -47,7 +47,7 @@ export function emittedArtFor(type: string): {
  * order among packs of one type — and every one of them is written before the
  * actors pass that reads them.
  *
- * **Scoped to one system when the caller has one (#58).** A being addresses an
+ * **Scoped to one system when the caller has one.** A being addresses an
  * item by `(type, shortcode)`, and that address is unique within one system and
  * not across two: `skill:sword` is an HM3 skill *and* a SoHL skill, with
  * different data models behind them. The reference itself is unambiguous — it
@@ -65,7 +65,7 @@ export function emittedArtFor(type: string): {
  * @returns {string[]} Each Item pack's JSON directory. Empty when the
  *   repository ships no items at all, which is a legitimate package: the actors
  *   pass accepts an empty list and reports an item it cannot resolve per
- *   `(type, shortcode)` instead, naming the being (#49).
+ *   `(type, shortcode)` instead, naming the being.
  */
 export function itemPackJsonDirs(config?: object, system?: string | null): string[];
 /**
@@ -74,7 +74,7 @@ export function itemPackJsonDirs(config?: object, system?: string | null): strin
  * An `Adventure` carries **copies**, not references, so a bundle resolves its
  * `contents` against compiled output rather than against the content tree — the
  * same arrangement the actors pass has for `itemsSourceDirs`, generalised to
- * every document class an Adventure can hold (#259).
+ * every document class an Adventure can hold.
  *
  * Two kinds of pack are left out, each because it holds nothing a note
  * addresses. A **prebuilt** pack's JSON is checked in rather than compiled, so
@@ -99,7 +99,7 @@ export function bundleSourceJsonDirs(config?: object, system?: string | null): R
 /**
  * The passes to run, ordered so that each one follows the output it reads.
  *
- * **Declaration order is presentation, not compile order (#73).** The same
+ * **Declaration order is presentation, not compile order.** The same
  * `packs:` list is the manifest's `packs` array, which a consumer orders for a
  * reader browsing compendiums; the actors pass, meanwhile, resolves each
  * being's embedded items against the item passes' *output*. Making one list
@@ -149,7 +149,7 @@ export function unsatisfiedPassDependencies(running: readonly object[], config:
  *
  * A pack ships blank whenever every note in a full tree was rejected — by a
  * `selects` that claims nothing, or a `pack:` that routes everything elsewhere
- * — and the build then exits 0 (#1502). The empty-tree guard in
+ * — and the build then exits 0. The empty-tree guard in
  * {@link generatePacksJson} cannot see that: the tree is full, it is the
  * *output* that is empty.
  *