@heroiclands/package-build 11.0.0 → 13.0.0

package/types/content-config.d.mts

@@ -56,28 +56,36 @@ export namespace DEFAULT_PATHS {
  */
 export const PACK_DOCUMENT_TYPES: readonly ["Actor", "Adventure", "Item", "JournalEntry", "Macro", "Scene"];
 /**
- * The landing-page rules a repository may route by.
+ * The landing-page rules a repository may route by. **Inert since #204.**
  *
- * A *landing page* is a note that addresses a whole section rather than a page
- * within one, so it has no slug of its own. Which note that is differs between
- * repositories, and both live rules are represented here because switching
- * either one on for the other repository moves addresses that are already
- * published:
+ * A *landing page* was a note that addressed a whole section rather than a page
+ * within one, so it had no slug of its own. There are no sections in the note
+ * format any more — a section is a Hugo content directory, and a page's address
+ * names no directory — so there are no landings and this selects nothing.
  *
- * - `readme` — a `README.md` **is** its section's landing page. This is `sohl`'s
- *   rule, and a `doc` note routes by its `category` like any other, so `sohl`'s
- *   eleven `category: collection` notes publish under a literal `collection/`
- *   section (`kb/collection/skills/`).
- * - `collection` — a `doc` note whose `category` is `collection` addresses the
- *   section it introduces, named by its authored `section`. This is `thalorna`'s
- *   rule, under which the same note publishes at `creature/`.
- *
- * The two are not disjoint and cannot simply both apply: each tree holds notes
- * the other rule would move.
+ * The key survives its own mechanism on purpose. Both publishing consumers
+ * declare `landing: readme`, which stated something true when they wrote it;
+ * refusing it now would break them over a correct statement, and silently
+ * ignoring an unknown value would be worse. So `readme` stays accepted, the
+ * retired `collection` stays refused by name (below), and the key is deleted
+ * once no configuration writes it — `content-config.mjs` has no warning channel
+ * with which to say "accepted, and does nothing" in between.
  *
  * @type {readonly string[]}
  */
 export const LANDING_RULES: readonly string[];
+/**
+ * What a configuration naming the retired `collection` landing rule is told.
+ *
+ * A retired *value* is refused the way a retired *field* is (see
+ * `engine/retired-fields.mjs`): left merely unrecognized it would be reported
+ * as a bad value, which names something to correct and leaves the author to
+ * work out for themselves that the mechanism is gone. The message says the rule
+ * is retired, what lands a section instead, and what to do with the key.
+ *
+ * @type {Readonly<Record<string, string>>}
+ */
+export const RETIRED_LANDING_RULES: Readonly<Record<string, string>>;
 /**
  * A repository's address scheme, with the defaults an unconfigured one gets.
  *
@@ -87,6 +95,8 @@ export const LANDING_RULES: readonly string[];
  * own mount point: where the package itself is served is the consuming build's
  * knowledge, held in `PACKAGE_BASE` (`engine/kb-manifest.mjs`) and prefixed at
  * resolve time, so it is never recorded here (#1465).
+ *
+ * `landing` is inert — see {@link LANDING_RULES}.
  */
 export const DEFAULT_ADDRESS_SCHEME: Readonly<{
     prefix: "";
@@ -506,7 +516,9 @@ export type AddressSchemeInput = {
      */
     prefix?: string | undefined;
     /**
-     * Which note addresses a whole section.
+     * Which note addressed a whole section. Inert
+     * since #204 retired sections from the note format — see
+     * {@link LANDING_RULES}.
      */
     landing?: string | undefined;
 };

package/types/engine/content-address.d.mts

@@ -1,14 +1,3 @@
-/**
- * The URL section a note routes to.
- *
- * A `doc` is narrative content whose only identity is its subtype label, so it
- * routes by `subType`; every other type names its own section.
- *
- * @param {object} fm - Parsed frontmatter.
- * @returns {string|undefined} The section, or `undefined` when the note has
- *   none — a `doc` with no subtype has no address and is not published.
- */
-export function sectionOf(fm: object): string | undefined;
 /**
  * The single path segment a note is addressed by: `type-shortcode`.
  *
@@ -34,15 +23,16 @@ export function addressSlug(fm: object): string;
 /**
  * A note's address below the knowledgebase mount, e.g. `affliction-aconite/`.
  *
- * A `README.md` **is** its section's landing page rather than a page within it,
- * so it addresses the section itself and has no address of its own.
+ * Every note, without exception. A `README.md` used to be its section's landing
+ * page and to address the section instead of itself; a section is a Hugo
+ * directory concept the note format no longer carries (#204), so a file's name
+ * decides nothing about where it publishes.
  *
  * @param {object} fm - Parsed frontmatter.
- * @param {boolean} isReadme - Whether the file is a `README.md`.
  * @returns {string} The mount-relative address, with a trailing slash.
  * @throws {Error} When the note has no address.
  */
-export function contentAddress(fm: object, isReadme: boolean): string;
+export function contentAddress(fm: object): string;
 /**
  * A note's address relative to its **package**, e.g. `affliction-aconite/`.
  *
@@ -51,36 +41,34 @@ export function contentAddress(fm: object, isReadme: boolean): string;
  * address the site does not publish resolves at build time and 404s for the
  * reader, which is the failure this module exists to prevent.
  *
+ * **It is a pure function of the frontmatter.** Nothing about the file the note
+ * was read from reaches it: the `README.md` convention that made one note
+ * address a whole section is retired with the section itself (#204), so there
+ * is one rule and no branch.
+ *
  * **The prefix does not apply to a page's own address.** `prefix` says where the
- * content tree *mounts inside the package* — where its section directories and
- * their landing pages live — and a landing page is addressed by that mount
- * (`kb/rules/`). An ordinary page is addressed by `(type, shortcode)`, which is
- * a package-wide identity and takes no mount: `sohl` publishes
- * `/sohl/affliction-aconite/` while its section landings stay at
- * `/sohl/kb/affliction/`. The `type-` half is what keeps that flat namespace
- * clear of the package's fixed mounts — `/<package>/` for the landing,
+ * content tree *mounts inside the package* — the Hugo directory its pages are
+ * written under — and an address is `(type, shortcode)`, a package-wide identity
+ * that takes no mount: `sohl` publishes `/sohl/affliction-aconite/` from a file
+ * written under `kb/`. The `type-` half is what keeps that flat namespace clear
+ * of the package's fixed mounts — `/<package>/` for the landing,
  * `/<package>/api/` for generated API docs, neither of which contains a hyphen
  * or names a type.
  *
- * **The section still decides where the *file* is written**, which is why a
- * note without one still has no address: Hugo derives a section from a page's
- * directory rather than from its URL, so a page with nowhere to be filed is a
- * page with no section landing, no `.CurrentSection` and no per-section layout.
- *
  * @param {object} fm - Parsed frontmatter.
  * @param {object} [options] - Options.
- * @param {boolean} [options.isReadme] - Whether the file is a `README.md`.
  * @param {{prefix?: string, landing?: string}} [options.scheme] - The
  *   repository's address scheme; defaults to {@link DEFAULT_ADDRESS_SCHEME}.
+ *   `landing` is validated against {@link LANDING_RULES} and selects nothing —
+ *   it is accepted so a configuration declaring the still-true `landing: readme`
+ *   keeps loading, and is removed once none does.
  * @returns {string} The package-relative address, with a trailing slash and no
  *   leading one.
- * @throws {Error} When the note has no address — no section, a landing page
- *   naming no section, or no shortcode to be addressed by. Each is a note that
- *   is not published, and inventing an address for one would put a dead entry
- *   in the manifest.
+ * @throws {Error} When the note has no type or no shortcode to be addressed by.
+ *   Such a note is not published, and inventing an address for one would put a
+ *   dead entry in the manifest.
  */
-export function packageAddress(fm: object, { isReadme, scheme }?: {
-    isReadme?: boolean | undefined;
+export function packageAddress(fm: object, { scheme }?: {
     scheme?: {
         prefix?: string;
         landing?: string;

package/types/engine/note-vocabulary.d.mts

@@ -35,6 +35,57 @@ export function hasTag(fm: object | null | undefined, tag: string): boolean;
  * @returns {boolean} Whether the note carries the `draft` tag.
  */
 export function isDraftNote(fm: object | null | undefined): boolean;
+/**
+ * What to write in place of a retired subType value, if it is one.
+ *
+ * @param {string} type - The note's `type`.
+ * @param {string} value - The authored `subType`.
+ * @param {Readonly<Record<string, Readonly<Record<string, string>>>>} [retired]
+ *   The map to read, defaulting to {@link RETIRED_SUBTYPES}.
+ * @returns {string|undefined} The current spelling, or `undefined` when the
+ *   value is not a retired one — which is not the same as it being valid.
+ */
+export function retiredSubType(type: string, value: string, retired?: Readonly<Record<string, Readonly<Record<string, string>>>>): string | undefined;
+/**
+ * What a note carrying a retired subType is told.
+ *
+ * One message, so the lint and any later refusal cannot describe the same
+ * retirement differently.
+ *
+ * @param {string} type - The note's `type`.
+ * @param {string} value - The retired spelling the note carries.
+ * @param {string} replacement - What to write instead.
+ * @returns {string} The message.
+ */
+export function retiredSubTypeMessage(type: string, value: string, replacement: string): string;
+/**
+ * What a note carrying a subType outside the address charset is told.
+ *
+ * @param {string} value - The authored `subType`.
+ * @returns {string} The message.
+ */
+export function subTypeCharsetMessage(value: string): string;
+/**
+ * What a note carrying a type outside the address charset is told.
+ *
+ * @param {string} type - The authored `type`.
+ * @returns {string} The message.
+ */
+export function typeCharsetMessage(type: string): string;
+/**
+ * Refuse a vocabulary that declares a type or subType outside the charset.
+ *
+ * Run over {@link NOTE_VOCABULARY} as this module loads, so a declaration that
+ * breaks the rule cannot be imported. That is stricter than a lint on purpose:
+ * a note's bad value is one author's mistake and belongs in a report, while a
+ * bad *declaration* would tell every author to write something unaddressable.
+ *
+ * @param {Readonly<Record<string, TypeVocabulary>>} vocabulary - The registry.
+ * @param {string} [where] - What declares it, for the message.
+ * @throws {Error} Naming every offending type and subType at once, rather than
+ *   stopping at the first — a reader fixing a list wants the whole list.
+ */
+export function assertVocabularyCharset(vocabulary: Readonly<Record<string, TypeVocabulary>>, where?: string): void;
 /**
  * The `data:` keys a note type may carry.
  *
@@ -237,6 +288,31 @@ export const NOTE_VOCABULARY: Readonly<{
         })[];
     }>;
 }>;
+/**
+ * The retired spelling of a subType a type declares → what to write now (#206).
+ *
+ * Keyed by type, because a retirement is a statement about *that type's*
+ * vocabulary: `user-guide` on a `doc` is the old spelling of `userguide`, while
+ * the same string on any other type is nothing but a charset violation, and
+ * saying "did you mean userguide" there would be a guess dressed as a fact.
+ *
+ * **Recorded here rather than left in `subTypes`** so the declared list stays
+ * the list of values a note *should* write. A retired value is accepted, not
+ * declared — the difference is exactly what makes the finding possible.
+ *
+ * **Deliberately not the shape of a type rename** ({@link
+ * import("./ids.mjs").RETIRED_TYPES}), which is an error: a retired type routes
+ * a note to the wrong pack, whereas a retired subType still compiles to the
+ * correct page. The sweep is the consumer's, and the ordering is the reverse of
+ * the usual — the acceptance ships *first*, because declaring only the new
+ * spelling while 43 `sohl` notes still author the old one would invalidate all
+ * 43 with a release they had no chance to sweep ahead of. A later change
+ * removes this map, and the old spelling then falls through to the ordinary
+ * undeclared-value error with no code left to remove.
+ *
+ * @type {Readonly<Record<string, Readonly<Record<string, string>>>>}
+ */
+export const RETIRED_SUBTYPES: Readonly<Record<string, Readonly<Record<string, string>>>>;
 /**
  * One `data:` key a note type may carry.
  *

package/types/engine/retired-fields.d.mts

@@ -106,6 +106,53 @@ export function assertNoAliasesField(fm: object | null | undefined, { file, absP
  * @returns {boolean} Whether the retired field is declared.
  */
 export function declaresRetiredAliasesField(fm: object | null | undefined): boolean;
+/**
+ * What a note declaring `section:` is told, in one place.
+ *
+ * Shared by the compile-time refusal and the frontmatter lint, because an
+ * author meets whichever of the two runs first and they should read the same.
+ * It names what lands a section now rather than a value to correct: no value
+ * makes declaring the field right.
+ *
+ * **What it did (#202).** It named the section a `collection` note headed,
+ * under the `collection` landing rule — the only reader it ever had, in the
+ * second branch of `landingOf` (`engine/content-address.mjs`). That rule went
+ * first, and the whole mechanism went with it (#204): a section is a Hugo
+ * directory the note format does not carry, so no note lands one and a page
+ * that introduces a type is an ordinary note addressed `doc-<type>`. Nothing
+ * else read the field, and no schema or vocabulary declared it, so left in
+ * place it would be ignored in silence — the note saying one thing and the
+ * build doing another.
+ *
+ * @param {string} [file] - The note's path, named in the message. Omit it where
+ *   the caller emits through a diagnostic, whose locator already starts the
+ *   line — repeating it prints the path twice.
+ * @returns {string} The message, unpunctuated at the end as a finding is.
+ */
+export function sectionRetiredMessage(file?: string): string;
+/**
+ * Refuse a note that declares `section:` at all.
+ *
+ * Presence is the whole test, as it is for `draft:` and `aliases:`: an empty
+ * value reads as "this note heads a section and names none", a statement about
+ * a rule that no longer exists.
+ *
+ * @param {object|null|undefined} fm - Parsed frontmatter, or nothing when it
+ *   could not be parsed.
+ * @param {object} [options] - Options.
+ * @param {string} [options.file] - The note's path, named in the message. Omit
+ *   it where the caller emits through a diagnostic, which puts the locator at
+ *   the start of the line already — repeating it prints the path twice.
+ * @param {string} [options.absPath] - The note's file on disk, read only on the
+ *   failing path to locate the offending line and column. The position rides on
+ *   the thrown error as `position`, for a caller that emits a diagnostic.
+ * @returns {void}
+ * @throws {Error} When the note declares the field.
+ */
+export function assertNoSectionField(fm: object | null | undefined, { file, absPath }?: {
+    file?: string | undefined;
+    absPath?: string | undefined;
+}): void;
 /**
  * A frontmatter key's position in a note's file, or nothing.
  *

package/types/engine/site-build.d.mts

@@ -196,12 +196,10 @@ export function sectionFrontmatter(meta: object): object;
  * redirects of its own.
  *
  * A content page states its own **`url`**, which is its address rather than its
- * path (#181). Hugo would otherwise publish it where the file sits — under the
- * mount, inside its section directory — and the file sits there for a reason:
- * Hugo derives a page's section from its directory, which is what gives the
- * section its landing page, `.CurrentSection` and its per-section layout
- * lookup. So the directory stays and the address is stated, and the two are
- * free to differ.
+ * path (#181). It is written flat under the content mount (#204), so Hugo would
+ * otherwise publish it at `<mount><type>-<shortcode>/` rather than at the
+ * package-wide address the link manifest records — the same address, one
+ * segment too deep. So the address is stated and the mount does not reach it.
  *
  * A content page carries the package the build **derived** (#65). No note
  * declares one — `package:` is retired (#56) — so the note's frontmatter alone
@@ -213,24 +211,34 @@ export function sectionFrontmatter(meta: object): object;
  * self-describing and makes sweeping the field out of a content tree
  * output-preserving for a site as it already is for the packs.
  *
+ * A **tree** page is the one that still reads `readmeSections`: a `trees` entry
+ * keeps its source layout below a named section, so its own `README` is that
+ * section's landing and takes the title and hero the section declares.
+ *
  * @param {object} page - The page.
- * @param {object} options - `{ sections, readmeSections, decorate }`.
+ * @param {object} options - `{ readmeSections, decorate }`.
  * @returns {object} The frontmatter to write.
  */
 export function pageFrontmatter(page: object, { readmeSections, decorate }: object): object;
 /**
  * Where a page is written, relative to the output root.
  *
- * **Into its section directory, which is not where it publishes** (#181). A
- * content page's URL is its address — `/<package>/<type>-<shortcode>/` — and it
- * is stated in the front matter; the file still goes to `<section>/`, because
- * Hugo reads a page's section from its path and nothing else. Flattening the
- * tree to match the URL would take the section landings, `.CurrentSection` and
- * every per-section layout with it.
- *
- * The filename is the address rather than the section-relative half of it, so
- * two sections cannot fight over one file: a `doc` note routes by its `subType`,
- * which may be spelled the same as another note's `type`.
+ * **Flat, under the mount, named by its address** (#204). A content page's URL
+ * is its address — `/<package>/<type>-<shortcode>/` — and the file is now named
+ * the same way, so the two agree. It used to be filed into `<section>/` so that
+ * Hugo would read a section off its path; a section appears in no address, and
+ * a directory chosen only to satisfy a rendering engine's idea of what a
+ * section is has no business in the note format.
+ *
+ * The name is the *whole* address rather than a section-relative half of it, so
+ * two types cannot fight over one file: a `doc` note's `subType` may be spelled
+ * the same as another note's `type`, and `doc-gear.md` and `weapongear-gear.md`
+ * are distinct whatever the sections used to be.
+ *
+ * **A `trees` entry is the exception, and always was.** Those pages preserve
+ * their source layout below a named section — they are a book with chapters,
+ * addressed by their path — so a `README` there is still its directory's
+ * `_index.md`.
  */
 export function pageDestination(page: any): string;
 /**
@@ -259,26 +267,43 @@ export function renderPages(pages: object[], options: object): {
     wikiErrors: object[];
 };
 /**
- * Writes the section landings a published tree needs but no note supplies.
- *
- * Two separate jobs, and both exist because of how Hugo decides what a section
- * is:
- *
+ * Writes the Hugo sections a published tree declares.
+ *
+ * **This is where a section lives now, and the only place** (#204). A content
+ * note carries none: it is addressed by `(type, shortcode)` and emitted flat
+ * under the mount, so nothing a page does creates a directory. A site that wants
+ * `/<package>/<prefix><section>/` to answer — with a title, a hero, and whatever
+ * listing its layout builds — says so here, in configuration, and this writes
+ * the `_index.md` that makes Hugo agree it is a section.
+ *
+ * Three jobs, all of them Hugo's directory semantics rather than the note
+ * format's:
+ *
+ * - **The mount's own landing**, so `/<package>/<prefix>` is a page rather than
+ *   a directory listing. It carries a `type` of its own: Hugo's template lookup
+ *   walks up a page's path, so an untyped landing template at the mount would
+ *   also serve every section below it that has none.
  * - **Declared sections** get a titled `_index.md` with their hero, so a landing
  *   matches the card that links to it instead of showing Hugo's auto-humanised
- *   directory name. The body is empty, which lets the theme list the section's
- *   children — or say it is empty, for a section whose content has not shipped.
- * - **Every other section directly under the mount** gets a bare `_index.md`,
+ *   directory name. The body is empty, which lets the theme decide what to list.
+ * - **Every other directory directly under the mount** gets a bare `_index.md`,
  *   or its own address publishes nothing. Hugo generates a section page
  *   automatically only for a *top-level* content directory; below that, a
- *   directory without an `_index.md` is not a section, so its URL 404s while
- *   its children publish normally. Mounting a tree one level down demotes every
- *   section it holds, and the ones with no landing of their own quietly stop
- *   existing while every page inside them keeps working.
+ *   directory without an `_index.md` is not a section, so its URL 404s while its
+ *   children publish normally. With content pages flat, what that reaches is a
+ *   `trees` entry's directory — the one thing left below the mount that a note
+ *   creates.
+ *
+ * **A section listing is not a page listing any more.** A layout that reads
+ * `.Pages` off a section it declares here will find nothing, because no file is
+ * filed into it; one that queries `site.RegularPages` by `Params.type` — which
+ * is how `sohl`'s eleven catalog layouts already work — is unaffected. That is a
+ * consumer's layout to choose, and it is stated here because the choice is no
+ * longer free.
  *
  * Scoped to one level on purpose. A directory further down was not a section
- * before the move either, and giving it one here would silently re-scope the
- * prev/next navigation of every page inside it.
+ * before either, and giving it one here would silently re-scope the prev/next
+ * navigation of every page inside it.
  *
  * @param {string} outRoot - The mount directory.
  * @param {object} options - `{ sections, landing, sectionTitle }`.

package/types/engine/site-index.d.mts

@@ -73,9 +73,13 @@ export type SiteEntry = {
      */
     slug: string;
     /**
-     * Section the page is filed under.
+     * The Hugo section a **tree** page is filed under, and
+     *   the first segment of the `<sec>/<slug>` address it
+     *   is reachable by. A content page has none: it is
+     *   addressed by `(type, shortcode)` and emitted flat
+     *   (#204).
      */
-    sec: string;
+    sec?: string | undefined;
     /**
      * Source file's basename, e.g. `Climbing.md`.
      */
@@ -85,9 +89,10 @@ export type SiteEntry = {
      */
     url: string;
     /**
-     * Whether the page is its section's landing.
+     * Whether a tree page is its directory's
+     * landing.
      */
-    isReadme: boolean;
+    isReadme?: boolean | undefined;
 };
 /**
  * The resolved index and everything a wikilink resolver reads beside it.