@heroiclands/package-build 20.3.1 → 20.5.0

package/bin/package-build.mjs

@@ -78,6 +78,7 @@ import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
 import { loadPackageBuildConfig } from "../config.mjs";
+import { compilesFoundryDocuments } from "../content-config.mjs";
 import { loadPackConfig, packConfigPath } from "../engine/pack-config.mjs";
 import { cleanBuildArtifacts, stageAssets } from "../stage.mjs";
 import { buildSchemaArtifact } from "../engine/schema-extract.mjs";
@@ -133,7 +134,7 @@ function die(err) {
     const message = err instanceof Error ? err.message : String(err);
     // A located diagnostic already starts with `file:line:column:`, which is
     // exactly the position a parser reads the path from — prefixing it would
-    // yield a filename no editor can open (#95).
+    // yield a filename no editor can open.
     console.error(
         /** @type {{located?: boolean}} */ (err)?.located ? message : `package-build: ${message}`,
     );
@@ -325,7 +326,7 @@ async function formatGenerated(text, filepath) {
  *
  * The producing half of the check `content-build lint` runs: Foundry discards
  * an unknown `system` key at construction and says nothing, so a content build
- * needs to know what a document will actually receive (#60). It cannot ask a
+ * needs to know what a document will actually receive. It cannot ask a
  * running Foundry, and it cannot read `defineSchema()` from a sibling checkout,
  * so the system publishes the field sets as data — the same shape the link
  * manifest already uses for addresses.
@@ -413,6 +414,18 @@ function manifestCommand() {
         handler: handler(async () => {
             const config = loadPackageBuildConfig();
             const shared = loadPackConfig();
+            // Refused rather than written: a manifest is the file Foundry reads
+            // to install a package, and a documentation package is not one. An
+            // emitted `module.json` would advertise an installable package with
+            // no packs, no compatibility range and no id — the plausible lie
+            // this toolchain refuses everywhere else.
+            if (!compilesFoundryDocuments(shared)) {
+                die(
+                    `\`packageKind: ${shared.packageKind}\` ships no Foundry ` +
+                        `package, so there is no manifest to generate. The site ` +
+                        `and the book are built by \`content-build\`.`,
+                );
+            }
             const packageJson = readPackageJson(config);
 
             let flags;
@@ -704,16 +717,6 @@ function langHardcoded(config) {
     );
 }
 
-/**
- * `lang <action>` — the three localization guards.
- *
- * They are three questions about one subject, and each is blind to what the
- * others see: `check` asks whether the file will load at all, `coverage`
- * whether the keys and the code agree, `hardcoded` whether the markup ever
- * asks for a key in the first place.
- *
- * @returns {object} The yargs command module.
- */
 /**
  * `package-build yaml` — lint note frontmatter and every YAML file.
  *
@@ -826,6 +829,16 @@ function labelsCheck(args) {
     console.log(`package-build: registry and §3 agree (${count} labels).`);
 }
 
+/**
+ * `lang <action>` — the three localization guards.
+ *
+ * They are three questions about one subject, and each is blind to what the
+ * others see: `check` asks whether the file will load at all, `coverage`
+ * whether the keys and the code agree, `hardcoded` whether the markup ever
+ * asks for a key in the first place.
+ *
+ * @returns {object} The yargs command module.
+ */
 function langCommand() {
     return {
         command: "lang <action>",
@@ -931,17 +944,37 @@ function releaseCommand() {
     return {
         command: "release",
         describe: "Package the staged build for release",
-        builder: (y) => y,
-        handler: handler(async () => {
+        builder: (y) =>
+            y.option("no-pdf", {
+                describe:
+                    "Skip the content-tree book. A package that publishes no content " +
+                    "already builds none; this is for a release that has a tree and " +
+                    "does not want the book.",
+                type: "boolean",
+            }),
+        handler: handler(async (argv) => {
             const config = loadPackageBuildConfig();
-            const { zip, version, bytes } = await packRelease({
+            const result = await packRelease({
                 artifact: config.artifact,
+                pdf: argv.pdf !== false,
             });
+            const { zip, version, bytes } = result;
             console.log(
                 `✅ Packaged ${version} for release: ` +
                     `${path.relative(config.rootDir, zip)} ` +
                     `(${(bytes / 1024 / 1024).toFixed(1)} MB)`,
             );
+            // Reported, never fatal: the archive above is the release, and a
+            // book that would not set is a problem to fix rather than a reason
+            // to have published nothing.
+            for (const finding of result.pdfFindings ?? []) {
+                console.error(`${finding.file ?? "book"}: ${finding.severity}: ${finding.message}`);
+            }
+            if (result.pdf) {
+                console.log(`📕 Book: ${path.relative(config.rootDir, result.pdf)}`);
+            } else if (result.pdfSkipped) {
+                console.log(`   No book: ${result.pdfSkipped}`);
+            }
         }),
     };
 }

package/config.mjs

@@ -29,10 +29,8 @@
  * loader checks that the section is a mapping and hands it back frozen;
  * everything inside it is validated here.
  *
- * **That section used to be a reservation.** Until 3.0.0 these were two
- * packages, and `packageBuild:` was a block `@heroiclands/content-build`
- * carried on behalf of a toolchain it knew nothing about. One package now owns
- * the whole file, so it is an ordinary section — but the validation split is
+ * **That section is not a reservation.** One package owns the whole file, so
+ * `packageBuild:` is an ordinary section — but the validation split is
  * kept, because it is what stops a key being checked twice against two
  * disagreeing ideas of what it means.
  *
@@ -150,7 +148,7 @@ const ARTIFACT_OF_KIND = Object.freeze({
  *
  * The dotted path rides on the error as `field` as well as appearing in the
  * message, so {@link loadPackageBuildConfig} — the half that knows which file
- * was read — can resolve it to a line and column (#95). This half stays pure.
+ * was read — can resolve it to a line and column. This half stays pure.
  *
  * @param {string} where - Dotted path of the offending key.
  * @param {string} problem - What is wrong with it.
@@ -802,8 +800,8 @@ export function resolvePackageBuildConfig(shared) {
         e2eSuite: normalizeE2ESuite(e2eInput.suite),
         // Declaring nothing keeps the old contract — the suite's exit status is
         // taken at its word. Declaring where results land is what lets the
-        // harness tell "the suite ran and passed" from "the suite did not run"
-        // (#153); a repository that wants that distinction has to say where to
+        // harness tell "the suite ran and passed" from "the suite did not run";
+        // a repository that wants that distinction has to say where to
         // look for it, because the harness does not know what the suite is.
         e2eResults: normalizeGlobs(e2eInput.results, [], "packageBuild.e2e.results"),
         e2eBuild,
@@ -831,7 +829,7 @@ export function loadPackageBuildConfig() {
     } catch (err) {
         // The pure half names the offending key and nothing else; this half
         // knows the file it was read from, so the position is attached here
-        // (#95) — the same boundary `configFromData` is for the rest of the
+        // — the same boundary `configFromData` is for the rest of the
         // configuration.
         throw locateConfigError(err, packConfigPath());
     }