@heroiclands/package-build 8.0.0 → 9.0.0

package/bin/package-build.mjs

@@ -96,13 +96,7 @@ import { packRelease } from "../release.mjs";
 import { writeManifest } from "../manifest.mjs";
 import { deployStage } from "../deploy.mjs";
 import { CONTAINER_ACTIONS, containerAction } from "../container.mjs";
-import {
-    E2E_MODES,
-    e2eFast,
-    e2eRun,
-    e2eSweep,
-    seedTestWorld,
-} from "../e2e.mjs";
+import { E2E_MODES, e2eFast, e2eRun, e2eSweep, seedTestWorld } from "../e2e.mjs";
 import { reportFindings } from "./report.mjs";
 
 /**
@@ -124,9 +118,7 @@ const ADVISORY_PREVIEW = 20;
  * @returns {string} The `version` field of this package's manifest.
  */
 function ownVersion() {
-    return JSON.parse(
-        fs.readFileSync(new URL("../package.json", import.meta.url), "utf8"),
-    ).version;
+    return JSON.parse(fs.readFileSync(new URL("../package.json", import.meta.url), "utf8")).version;
 }
 
 /**
@@ -141,9 +133,7 @@ function die(err) {
     // exactly the position a parser reads the path from — prefixing it would
     // yield a filename no editor can open (#95).
     console.error(
-        /** @type {{located?: boolean}} */ (err)?.located ? message : (
-            `package-build: ${message}`
-        ),
+        /** @type {{located?: boolean}} */ (err)?.located ? message : `package-build: ${message}`,
     );
     process.exit(1);
 }
@@ -195,9 +185,7 @@ async function loadEnvironment(config) {
  * @returns {object} The parsed manifest.
  */
 function readPackageJson(config) {
-    return JSON.parse(
-        fs.readFileSync(path.join(config.rootDir, "package.json"), "utf8"),
-    );
+    return JSON.parse(fs.readFileSync(path.join(config.rootDir, "package.json"), "utf8"));
 }
 
 /**
@@ -270,17 +258,13 @@ function assetsCommand() {
         handler: handler(async () => {
             const config = loadPackageBuildConfig();
             if (!config.assets.length) {
-                console.log(
-                    "package-build: no `packageBuild.assets` declared; nothing to stage.",
-                );
+                console.log("package-build: no `packageBuild.assets` declared; nothing to stage.");
                 return;
             }
 
             let transform;
             if (config.assetTransform) {
-                const module = await import(
-                    `file://${config.assetTransform}`
-                ).catch((err) =>
+                const module = await import(`file://${config.assetTransform}`).catch((err) =>
                     die(
                         `cannot load \`packageBuild.assetTransform\` ` +
                             `(${config.assetTransform}): ${err.message}`,
@@ -307,9 +291,7 @@ function assetsCommand() {
                 cwd: config.rootDir,
                 transform,
             });
-            console.log(
-                `✅ Static assets staged (${count} entries, ${files} files).`,
-            );
+            console.log(`✅ Static assets staged (${count} entries, ${files} files).`);
         }),
     };
 }
@@ -368,8 +350,7 @@ function schemaCommand() {
             const config = loadPackageBuildConfig();
             if (!config.schema.length) {
                 console.log(
-                    "package-build: no `packageBuild.schema` declared; " +
-                        "nothing to publish.",
+                    "package-build: no `packageBuild.schema` declared; " + "nothing to publish.",
                 );
                 return;
             }
@@ -385,15 +366,11 @@ function schemaCommand() {
             const out = path.join(config.rootDir, SCHEMA_ARTIFACT_FILE);
             const text = await formatGenerated(JSON.stringify(artifact), out);
             const counts = Object.entries(artifact.documents)
-                .map(
-                    ([kind, subtypes]) =>
-                        `${Object.keys(subtypes).length} ${kind}`,
-                )
+                .map(([kind, subtypes]) => `${Object.keys(subtypes).length} ${kind}`)
                 .join(", ");
 
             if (argv.check) {
-                const current =
-                    fs.existsSync(out) ? fs.readFileSync(out, "utf8") : null;
+                const current = fs.existsSync(out) ? fs.readFileSync(out, "utf8") : null;
                 if (current !== text) {
                     die(
                         `${SCHEMA_ARTIFACT_FILE} does not match what this ` +
@@ -401,10 +378,7 @@ function schemaCommand() {
                             `it with \`package-build schema\`.`,
                     );
                 }
-                console.log(
-                    `✅ ${SCHEMA_ARTIFACT_FILE} is up to date ` +
-                        `(${counts} subtypes).`,
-                );
+                console.log(`✅ ${SCHEMA_ARTIFACT_FILE} is up to date ` + `(${counts} subtypes).`);
                 return;
             }
 
@@ -441,9 +415,7 @@ function manifestCommand() {
 
             let flags;
             if (config.manifestFlags) {
-                const module = await import(
-                    `file://${config.manifestFlags}`
-                ).catch((err) =>
+                const module = await import(`file://${config.manifestFlags}`).catch((err) =>
                     die(
                         `cannot load \`packageBuild.manifestFlags\` ` +
                             `(${config.manifestFlags}): ${err.message}`,
@@ -512,8 +484,7 @@ function langCheck(config) {
     const files = readMatching(config.langSources, config.rootDir);
     if (!files.length) {
         die(
-            `no localization files matched \`${config.langSources}\` under ` +
-                `${config.rootDir}.`,
+            `no localization files matched \`${config.langSources}\` under ` + `${config.rootDir}.`,
         );
     }
 
@@ -528,10 +499,7 @@ function langCheck(config) {
         if (config.langHelp) console.error(`\n${config.langHelp}`);
         process.exit(1);
     }
-    console.log(
-        `package-build: ${files.length} localization file(s) are ` +
-            `expandObject-safe.`,
-    );
+    console.log(`package-build: ${files.length} localization file(s) are ` + `expandObject-safe.`);
 }
 
 /**
@@ -578,10 +546,7 @@ async function langCoverage(config, args) {
         // Capped by default: the advisory half of a large package is pages
         // long, and pages of warnings on every build is how a guard stops being
         // read at all. The count is always stated, so nothing is hidden.
-        const shown =
-            args.unused ? unreferenced : (
-                unreferenced.slice(0, ADVISORY_PREVIEW)
-            );
+        const shown = args.unused ? unreferenced : unreferenced.slice(0, ADVISORY_PREVIEW);
         reportFindings(shown, {});
         if (shown.length < unreferenced.length) {
             console.error(
@@ -637,21 +602,18 @@ async function langCoverage(config, args) {
         );
     }
     const sets = [
-        ...scripts.map((file) =>
-            collectScriptReferences(file.text, { file: file.path, roots }),
-        ),
+        ...scripts.map((file) => collectScriptReferences(file.text, { file: file.path, roots })),
         ...templates.map((file) =>
             collectTemplateReferences(file.text, { file: file.path, roots }),
         ),
     ];
 
     if (config.langReferences) {
-        const module = await import(`file://${config.langReferences}`).catch(
-            (err) =>
-                die(
-                    `cannot load \`packageBuild.lang.references\` ` +
-                        `(${config.langReferences}): ${err.message}`,
-                ),
+        const module = await import(`file://${config.langReferences}`).catch((err) =>
+            die(
+                `cannot load \`packageBuild.lang.references\` ` +
+                    `(${config.langReferences}): ${err.message}`,
+            ),
         );
         if (typeof module.references !== "function") {
             die(
@@ -707,10 +669,9 @@ function langHardcoded(config) {
     let literals = 0;
     let broken = 0;
     for (const file of templates) {
-        literals += reportFindings(
-            findHardcodedText(file.text, { allow: config.langAllow }),
-            { file: file.path },
-        );
+        literals += reportFindings(findHardcodedText(file.text, { allow: config.langAllow }), {
+            file: file.path,
+        });
         broken += reportFindings(findTemplateSyntaxErrors(file.text), {
             file: file.path,
         });
@@ -737,8 +698,7 @@ function langHardcoded(config) {
     }
 
     console.log(
-        `package-build: ${templates.length} template(s) fully localized and ` +
-            `compiling.`,
+        `package-build: ${templates.length} template(s) fully localized and ` + `compiling.`,
     );
 }
 
@@ -768,8 +728,7 @@ function langCommand() {
                 .option("unused", {
                     type: "boolean",
                     default: false,
-                    describe:
-                        "coverage: list every unreferenced key, not a preview",
+                    describe: "coverage: list every unreferenced key, not a preview",
                 }),
         handler: handler(async (args) => {
             const config = loadPackageBuildConfig();
@@ -803,8 +762,7 @@ function bundleCommand() {
         builder: (y) =>
             y.positional("action", {
                 choices: ["check"],
-                describe:
-                    "check: verify the manifest and the staged bundle agree",
+                describe: "check: verify the manifest and the staged bundle agree",
             }),
         handler: handler(() => {
             const config = loadPackageBuildConfig();

package/bin/report.mjs

@@ -79,8 +79,7 @@ import { emitDiagnostic } from "../engine/diagnostics.mjs";
 export function toDiagnostics(findings, { file }) {
     return findings.map((finding) => {
         const hasLine = finding.line !== undefined && finding.line !== null;
-        const hasColumn =
-            finding.column !== undefined && finding.column !== null;
+        const hasColumn = finding.column !== undefined && finding.column !== null;
         return {
             file: finding.file ?? file,
             ...(hasLine ? { line: finding.line } : {}),

package/bundle.mjs

@@ -72,10 +72,7 @@ export function declaredGlobals(node) {
                 break;
             case "ObjectPattern":
                 for (const p of pattern.properties)
-                    namesIn(
-                        p.type === "RestElement" ? p.argument : p.value,
-                        out,
-                    );
+                    namesIn(p.type === "RestElement" ? p.argument : p.value, out);
                 break;
             case "ArrayPattern":
                 for (const e of pattern.elements) namesIn(e, out);
@@ -157,12 +154,7 @@ export function globalDeclarations(source) {
  *   declaredAs: "esmodules"|"scripts"|"both"|"neither"}} The findings, empty
  *   when the two agree, and how the entry was declared.
  */
-export function checkBundleLoading({
-    manifest,
-    source,
-    entry,
-    manifestName = "the manifest",
-}) {
+export function checkBundleLoading({ manifest, source, entry, manifestName = "the manifest" }) {
     const declaredAs = entryDeclaration(manifest, entry);
 
     if (declaredAs === "both") {

package/config.mjs

@@ -59,11 +59,7 @@
  */
 
 import path from "node:path";
-import {
-    loadPackConfig,
-    locateConfigError,
-    packConfigPath,
-} from "./engine/pack-config.mjs";
+import { loadPackConfig, locateConfigError, packConfigPath } from "./engine/pack-config.mjs";
 
 /** Keys the reserved section may declare. */
 const SECTION_KEYS = [
@@ -161,10 +157,9 @@ const ARTIFACT_OF_KIND = Object.freeze({
  * @returns {never}
  */
 function fail(where, problem) {
-    throw Object.assign(
-        new TypeError(`package-build config: \`${where}\` ${problem}.`),
-        { field: where },
-    );
+    throw Object.assign(new TypeError(`package-build config: \`${where}\` ${problem}.`), {
+        field: where,
+    });
 }
 
 /**
@@ -315,10 +310,7 @@ function normalizeGlobs(value, fallback, where) {
     const list = Array.isArray(value) ? value : [value];
     return Object.freeze(
         list.map((glob, index) =>
-            requireNonEmptyString(
-                glob,
-                Array.isArray(value) ? `${where}[${index}]` : where,
-            ),
+            requireNonEmptyString(glob, Array.isArray(value) ? `${where}[${index}]` : where),
         ),
     );
 }
@@ -443,9 +435,7 @@ function normalizeE2ESuite(value) {
             fail(where, "must be a non-empty list naming a program to run");
         }
         return Object.freeze(
-            value_.map((part, i) =>
-                requireNonEmptyString(part, `${where}[${i}]`),
-            ),
+            value_.map((part, i) => requireNonEmptyString(part, `${where}[${i}]`)),
         );
     };
 
@@ -589,9 +579,7 @@ function normalizeExceptions(value, field, where) {
  * @throws {TypeError} When the reserved section declares something malformed.
  */
 export function resolvePackageBuildConfig(shared) {
-    const section = /** @type {Record<string, unknown>} */ (
-        shared.packageBuild ?? {}
-    );
+    const section = /** @type {Record<string, unknown>} */ (shared.packageBuild ?? {});
     rejectUnknownKeys(section, SECTION_KEYS, "packageBuild.");
 
     if (section.assets !== undefined && !Array.isArray(section.assets)) {
@@ -661,31 +649,22 @@ export function resolvePackageBuildConfig(shared) {
     );
     const containerInput = /** @type {Record<string, unknown>} */ (container);
     const containerName =
-        containerInput.name === undefined ?
-            null
-        :   requireContainerName(containerInput.name);
+        containerInput.name === undefined ? null : requireContainerName(containerInput.name);
     const declaredStages = containerInput.stages ?? {};
     if (!isMapping(declaredStages)) {
         fail("packageBuild.container.stages", "must be a mapping");
     }
     const containerStages = Object.freeze(
         Object.fromEntries(
-            Object.entries(
-                /** @type {Record<string, unknown>} */ (declaredStages),
-            ).map(([name, entry]) => [
-                name,
-                normalizeContainerStage(entry, name),
-            ]),
+            Object.entries(/** @type {Record<string, unknown>} */ (declaredStages)).map(
+                ([name, entry]) => [name, normalizeContainerStage(entry, name)],
+            ),
         ),
     );
 
     const e2e = section.e2e ?? {};
     if (!isMapping(e2e)) fail("packageBuild.e2e", "must be a mapping");
-    rejectUnknownKeys(
-        /** @type {Record<string, unknown>} */ (e2e),
-        E2E_KEYS,
-        "packageBuild.e2e.",
-    );
+    rejectUnknownKeys(/** @type {Record<string, unknown>} */ (e2e), E2E_KEYS, "packageBuild.e2e.");
     const e2eInput = /** @type {Record<string, unknown>} */ (e2e);
     const declaredBuild = e2eInput.build ?? {};
     if (!isMapping(declaredBuild)) {
@@ -695,12 +674,9 @@ export function resolvePackageBuildConfig(shared) {
     // bundler has to run before the passes that copy into the stage it empties.
     const e2eBuild = Object.freeze(
         Object.fromEntries(
-            Object.entries(
-                /** @type {Record<string, unknown>} */ (declaredBuild),
-            ).map(([name, entry]) => [
-                name,
-                normalizeE2EBuildTarget(entry, name),
-            ]),
+            Object.entries(/** @type {Record<string, unknown>} */ (declaredBuild)).map(
+                ([name, entry]) => [name, normalizeE2EBuildTarget(entry, name)],
+            ),
         ),
     );
 
@@ -713,23 +689,15 @@ export function resolvePackageBuildConfig(shared) {
         stageDir:
             section.stageDir === undefined ?
                 "build/stage"
-            :   requireNonEmptyString(
-                    section.stageDir,
-                    "packageBuild.stageDir",
-                ),
+            :   requireNonEmptyString(section.stageDir, "packageBuild.stageDir"),
         packageKind: shared.packageKind,
         packageId: shared.foundryPackage,
         // Derived from the kind, which already decides it. Stating it was one
         // more literal every consumer's release script carried.
         artifact:
             releaseInput.artifact === undefined ?
-                ARTIFACT_OF_KIND[
-                    /** @type {"systems"|"modules"} */ (shared.packageKind)
-                ]
-            :   requireNonEmptyString(
-                    releaseInput.artifact,
-                    "packageBuild.release.artifact",
-                ),
+                ARTIFACT_OF_KIND[/** @type {"systems"|"modules"} */ (shared.packageKind)]
+            :   requireNonEmptyString(releaseInput.artifact, "packageBuild.release.artifact"),
         assets: Object.freeze(assets),
         schema: normalizeSchema(section.schema),
         assetTransform:
@@ -737,10 +705,7 @@ export function resolvePackageBuildConfig(shared) {
                 null
             :   path.resolve(
                     shared.rootDir,
-                    requireNonEmptyString(
-                        section.assetTransform,
-                        "packageBuild.assetTransform",
-                    ),
+                    requireNonEmptyString(section.assetTransform, "packageBuild.assetTransform"),
                 ),
         manifest: normalizeManifest(section.manifest),
         manifestFlags:
@@ -748,19 +713,13 @@ export function resolvePackageBuildConfig(shared) {
                 null
             :   path.resolve(
                     shared.rootDir,
-                    requireNonEmptyString(
-                        section.manifestFlags,
-                        "packageBuild.manifestFlags",
-                    ),
+                    requireNonEmptyString(section.manifestFlags, "packageBuild.manifestFlags"),
                 ),
         cleanExtra: Object.freeze(cleanExtra),
         langSources:
             langInput.sources === undefined ?
                 "lang/*.json"
-            :   requireNonEmptyString(
-                    langInput.sources,
-                    "packageBuild.lang.sources",
-                ),
+            :   requireNonEmptyString(langInput.sources, "packageBuild.lang.sources"),
         langHelp:
             langInput.help === undefined ?
                 null
@@ -771,10 +730,7 @@ export function resolvePackageBuildConfig(shared) {
         langPrimary:
             langInput.primary === undefined ?
                 "lang/en.json"
-            :   requireNonEmptyString(
-                    langInput.primary,
-                    "packageBuild.lang.primary",
-                ),
+            :   requireNonEmptyString(langInput.primary, "packageBuild.lang.primary"),
         langScripts: normalizeGlobs(
             langInput.scripts,
             ["src/**/*.{ts,mjs}"],
@@ -791,38 +747,24 @@ export function resolvePackageBuildConfig(shared) {
         langKeyRoots:
             langInput.keyRoots === undefined ?
                 null
-            :   normalizeGlobs(
-                    langInput.keyRoots,
-                    [],
-                    "packageBuild.lang.keyRoots",
-                ),
+            :   normalizeGlobs(langInput.keyRoots, [], "packageBuild.lang.keyRoots"),
         langReferences:
             langInput.references === undefined ?
                 null
             :   path.resolve(
                     shared.rootDir,
-                    requireNonEmptyString(
-                        langInput.references,
-                        "packageBuild.lang.references",
-                    ),
+                    requireNonEmptyString(langInput.references, "packageBuild.lang.references"),
                 ),
         langRetained: normalizeExceptions(
             langInput.retained,
             "prefix",
             "packageBuild.lang.retained",
         ),
-        langAllow: normalizeExceptions(
-            langInput.allow,
-            "literal",
-            "packageBuild.lang.allow",
-        ),
+        langAllow: normalizeExceptions(langInput.allow, "literal", "packageBuild.lang.allow"),
         envPrefix:
             deployInput.envPrefix === undefined ?
                 "SOHL"
-            :   requireNonEmptyString(
-                    deployInput.envPrefix,
-                    "packageBuild.deploy.envPrefix",
-                ),
+            :   requireNonEmptyString(deployInput.envPrefix, "packageBuild.deploy.envPrefix"),
         // The file Foundry loads, as the manifest spells it. Named after the
         // package by convention, and the id is already derived from
         // package.json `name` — so a repository states this only when its
@@ -835,10 +777,7 @@ export function resolvePackageBuildConfig(shared) {
         bundleEntry:
             bundleInput.entry === undefined ?
                 `${shared.foundryPackage}.mjs`
-            :   requireNonEmptyString(
-                    bundleInput.entry,
-                    "packageBuild.bundle.entry",
-                ),
+            :   requireNonEmptyString(bundleInput.entry, "packageBuild.bundle.entry"),
         // Read from the top level, where the package already claims it. The
         // end-to-end pin derives from this, so the claim and the evidence for
         // it are the same number and cannot drift apart.
@@ -851,10 +790,7 @@ export function resolvePackageBuildConfig(shared) {
         containerImage:
             containerInput.image === undefined ?
                 null
-            :   requireNonEmptyString(
-                    containerInput.image,
-                    "packageBuild.container.image",
-                ),
+            :   requireNonEmptyString(containerInput.image, "packageBuild.container.image"),
         containerName,
         containerStages,
         e2eStage:
@@ -863,20 +799,9 @@ export function resolvePackageBuildConfig(shared) {
             :   requireNonEmptyString(e2eInput.stage, "packageBuild.e2e.stage"),
         e2eSuite: normalizeE2ESuite(e2eInput.suite),
         e2eBuild,
-        e2eWorld: normalizeStringMap(
-            e2eInput.world,
-            "packageBuild.e2e.world",
-            E2E_WORLD_KEYS,
-        ),
-        e2eGm: normalizeStringMap(
-            e2eInput.gm,
-            "packageBuild.e2e.gm",
-            E2E_GM_KEYS,
-        ),
-        e2eDocuments: normalizeStringMap(
-            e2eInput.documents,
-            "packageBuild.e2e.documents",
-        ),
+        e2eWorld: normalizeStringMap(e2eInput.world, "packageBuild.e2e.world", E2E_WORLD_KEYS),
+        e2eGm: normalizeStringMap(e2eInput.gm, "packageBuild.e2e.gm", E2E_GM_KEYS),
+        e2eDocuments: normalizeStringMap(e2eInput.documents, "packageBuild.e2e.documents"),
     });
 }