@heroiclands/package-build 8.0.0 → 9.0.0

package/coverage.mjs

@@ -230,12 +230,7 @@ function shapeOf(literal) {
 export function collectScriptReferences(source, { file, roots }) {
     const { whole, scan } = patternsFor(roots);
     const result = emptySet();
-    const sourceFile = ts.createSourceFile(
-        file,
-        source,
-        ts.ScriptTarget.Latest,
-        true,
-    );
+    const sourceFile = ts.createSourceFile(file, source, ts.ScriptTarget.Latest, true);
 
     // `parseDiagnostics` is TypeScript's own and not part of its published
     // surface, hence the guard. A file that does not parse contributes no
@@ -278,11 +273,7 @@ export function collectScriptReferences(source, { file, roots }) {
      * @returns {boolean} Whether its `.text` is the whole literal.
      */
     const isPlainString = (node) =>
-        Boolean(
-            node &&
-            (ts.isStringLiteral(node) ||
-                ts.isNoSubstitutionTemplateLiteral(node)),
-        );
+        Boolean(node && (ts.isStringLiteral(node) || ts.isNoSubstitutionTemplateLiteral(node)));
 
     /**
      * Read the concrete keys out of one literal chunk of a template.
@@ -316,11 +307,7 @@ export function collectScriptReferences(source, { file, roots }) {
     const prefixLiterals = new Set();
 
     const visit = (node) => {
-        if (
-            ts.isStringLiteral(node) &&
-            whole.test(node.text) &&
-            !prefixLiterals.has(node)
-        ) {
+        if (ts.isStringLiteral(node) && whole.test(node.text) && !prefixLiterals.has(node)) {
             addKey(node.text, node.getStart());
         }
 
@@ -328,20 +315,12 @@ export function collectScriptReferences(source, { file, roots }) {
         // not string-literal nodes — inline markup in a helper puts them inside
         // the literal's text — so they would otherwise be invisible.
         if (ts.isNoSubstitutionTemplateLiteral(node)) {
-            addChunkKeys(
-                node.text,
-                { openStart: false, openEnd: false },
-                node.getStart(),
-            );
+            addChunkKeys(node.text, { openStart: false, openEnd: false }, node.getStart());
         }
 
         if (ts.isTemplateExpression(node)) {
             const spans = node.templateSpans;
-            addChunkKeys(
-                node.head.text,
-                { openStart: false, openEnd: true },
-                node.getStart(),
-            );
+            addChunkKeys(node.head.text, { openStart: false, openEnd: true }, node.getStart());
             spans.forEach((span, index) => {
                 addChunkKeys(
                     span.literal.text,
@@ -366,8 +345,7 @@ export function collectScriptReferences(source, { file, roots }) {
         // it, so those leaves are never named in any source file.
         if (
             (ts.isPropertyDeclaration(node) || ts.isPropertyAssignment(node)) &&
-            node.name?.getText(sourceFile).replace(/["']/g, "") ===
-                "LOCALIZATION_PREFIXES" &&
+            node.name?.getText(sourceFile).replace(/["']/g, "") === "LOCALIZATION_PREFIXES" &&
             node.initializer &&
             ts.isArrayLiteralExpression(node.initializer)
         ) {
@@ -423,10 +401,7 @@ export function collectTemplateReferences(source, { file, roots }) {
 
         // A substitution written directly against the token completes its last
         // segment, so the namespace is one segment shorter than the token.
-        const namespace =
-            rest.startsWith("${") ?
-                token.replace(/\.[A-Za-z0-9_]*$/, "")
-            :   token;
+        const namespace = rest.startsWith("${") ? token.replace(/\.[A-Za-z0-9_]*$/, "") : token;
         result.namespaces.push(namespace);
 
         // Recover the whole literal so its shape, not merely its head, decides
@@ -436,9 +411,7 @@ export function collectTemplateReferences(source, { file, roots }) {
         const quote = source[index - 1];
         if (quote === "'" || quote === '"' || quote === "`") {
             const end = source.indexOf(quote, index);
-            const pattern = shapeOf(
-                source.slice(index, end === -1 ? undefined : end),
-            );
+            const pattern = shapeOf(source.slice(index, end === -1 ? undefined : end));
             if (pattern) result.patterns.push(pattern);
         }
     }
@@ -478,9 +451,7 @@ export function mergeReferences(sets) {
  * @returns {RegExp} The matcher.
  */
 function matcherFor(pattern) {
-    return new RegExp(
-        `^${pattern.split("*").map(escapeRegExp).join("[^.]+")}$`,
-    );
+    return new RegExp(`^${pattern.split("*").map(escapeRegExp).join("[^.]+")}$`);
 }
 
 /**
@@ -502,13 +473,7 @@ function matcherFor(pattern) {
  *   questions: one says the package is broken, the other that it carries
  *   something nobody could see a use for.
  */
-export function analyzeCoverage({
-    langSource,
-    langFile,
-    references,
-    retained = [],
-    roots,
-}) {
+export function analyzeCoverage({ langSource, langFile, references, retained = [], roots }) {
     let declared;
     try {
         declared = JSON.parse(langSource);
@@ -578,17 +543,14 @@ export function analyzeCoverage({
         });
     }
 
-    const referenced = new Set(
-        (references.keys ?? []).map((reference) => reference.key),
-    );
+    const referenced = new Set((references.keys ?? []).map((reference) => reference.key));
     const shapes = (references.patterns ?? []).map(matcherFor);
     // Foundry localizes a DataModel's field labels and hints off the declared
     // prefix, so no source names them one by one.
     const fieldShapes = [...namespaces].map(
         (namespace) =>
             new RegExp(
-                `^${escapeRegExp(namespace)}\\.FIELDS\\.` +
-                    `[A-Za-z0-9_.]+\\.(?:label|hint)$`,
+                `^${escapeRegExp(namespace)}\\.FIELDS\\.` + `[A-Za-z0-9_.]+\\.(?:label|hint)$`,
             ),
     );
 
@@ -596,13 +558,10 @@ export function analyzeCoverage({
         referenced.has(key) ||
         shapes.some((shape) => shape.test(key)) ||
         fieldShapes.some((shape) => shape.test(key));
-    const isRetained = (key) =>
-        retained.some((prefix) => key === prefix || key.startsWith(prefix));
+    const isRetained = (key) => retained.some((prefix) => key === prefix || key.startsWith(prefix));
 
     const unreferenced = declaredKeys
-        .filter((key) =>
-            known.some((root) => key === root || key.startsWith(`${root}.`)),
-        )
+        .filter((key) => known.some((root) => key === root || key.startsWith(`${root}.`)))
         .filter((key) => !isReferenced(key) && !isRetained(key))
         .map((key) => ({
             file: langFile,

package/deploy.mjs

@@ -146,9 +146,7 @@ export function resolveAgent(env, stageUpper, prefix = "SOHL") {
         env[`FOUNDRYVTT_${stageUpper}_AGENT`] ||
         env[`${prefix}_SFTP_AGENT`] ||
         env.SSH_AUTH_SOCK ||
-        (process.platform === "win32" ?
-            "\\\\.\\pipe\\openssh-ssh-agent"
-        :   undefined)
+        (process.platform === "win32" ? "\\\\.\\pipe\\openssh-ssh-agent" : undefined)
     );
 }
 
@@ -171,13 +169,8 @@ export async function buildConnection(
     remote,
     { env = process.env, prefix = "SOHL" } = {},
 ) {
-    const port = Number(
-        env[`FOUNDRYVTT_${stageUpper}_PORT`] ??
-            env[`${prefix}_SFTP_PORT`] ??
-            22,
-    );
-    const username =
-        remote.username || env[`FOUNDRYVTT_${stageUpper}_USER`] || env.USER;
+    const port = Number(env[`FOUNDRYVTT_${stageUpper}_PORT`] ?? env[`${prefix}_SFTP_PORT`] ?? 22);
+    const username = remote.username || env[`FOUNDRYVTT_${stageUpper}_USER`] || env.USER;
 
     const conn = { host: remote.host, port, username };
 
@@ -318,9 +311,7 @@ export async function deployStage({
             env,
             prefix,
         });
-        log(
-            `Deploying ${source} → ${conn.username}@${conn.host}:${remoteDir} (sftp)`,
-        );
+        log(`Deploying ${source} → ${conn.username}@${conn.host}:${remoteDir} (sftp)`);
         await deployRemote(conn, source, remoteDir, {
             onUpload: (f) => log(`  ${f}`),
         });

package/e2e.mjs

@@ -93,9 +93,7 @@ const EXACT_BUILD = /^\d+\.\d+$/;
  * @returns {string} The hex hash.
  */
 export function hashPassword(password, salt) {
-    return crypto
-        .pbkdf2Sync(password, salt, 1000, 64, "sha512")
-        .toString("hex");
+    return crypto.pbkdf2Sync(password, salt, 1000, 64, "sha512").toString("hex");
 }
 
 /**
@@ -127,23 +125,13 @@ export function resolveE2EWorld(config, env = process.env) {
     const world = config.e2eWorld ?? {};
     const gm = config.e2eGm ?? {};
     return {
-        worldId:
-            env[`${prefix}WORLD_ID`]?.trim() ||
-            world.id ||
-            `${config.packageId}-e2e`,
-        worldTitle:
-            env[`${prefix}WORLD_TITLE`]?.trim() ||
-            world.title ||
-            `${config.packageId} E2E`,
+        worldId: env[`${prefix}WORLD_ID`]?.trim() || world.id || `${config.packageId}-e2e`,
+        worldTitle: env[`${prefix}WORLD_TITLE`]?.trim() || world.title || `${config.packageId} E2E`,
         worldDescription:
-            world.description ||
-            `Disposable world for ${config.packageId} end-to-end tests.`,
+            world.description || `Disposable world for ${config.packageId} end-to-end tests.`,
         gmId: E2E_GM_ID,
         gmName: env[`${prefix}GM_NAME`]?.trim() || gm.name || "Gamemaster",
-        gmPassword:
-            env[`${prefix}GM_PASSWORD`]?.trim() ||
-            gm.password ||
-            `${config.packageId}-e2e`,
+        gmPassword: env[`${prefix}GM_PASSWORD`]?.trim() || gm.password || `${config.packageId}-e2e`,
     };
 }
 
@@ -330,8 +318,7 @@ export function parseFastArgs(argv, build) {
 
     for (let i = 0; i < own.length; i += 1) {
         const arg = /** @type {string} */ (own[i]);
-        if (arg.startsWith("--build="))
-            requested = arg.slice("--build=".length);
+        if (arg.startsWith("--build=")) requested = arg.slice("--build=".length);
         else if (arg === "--recreate") recreate = true;
         else if (arg === "--no-run") runSuite = false;
         else if (arg === "--spec") {
@@ -387,12 +374,7 @@ export function parseFastArgs(argv, build) {
  * @param {(message: string) => void} [opts.log] - Progress reporting.
  * @returns {Promise<{worldDir: string, world: E2EWorld}>} Where it landed.
  */
-export async function seedTestWorld({
-    config,
-    packageJson,
-    env = process.env,
-    log = () => {},
-}) {
+export async function seedTestWorld({ config, packageJson, env = process.env, log = () => {} }) {
     const stage = config.e2eStage;
     const dataRoot = requireIsolatedDataRoot(stage, env);
     const world = resolveE2EWorld(config, env);
@@ -530,13 +512,7 @@ const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
  * @returns {Promise<void>} Resolves once the world is active.
  * @throws {Error} On a licence failure or a timeout.
  */
-export async function waitForWorld({
-    url,
-    container,
-    stage,
-    timeoutMs = 180_000,
-    log = () => {},
-}) {
+export async function waitForWorld({ url, container, stage, timeoutMs = 180_000, log = () => {} }) {
     const join = `${url}/join`;
     const deadline = Date.now() + timeoutMs;
     log(`Waiting for the world at ${join} …`);
@@ -597,27 +573,17 @@ function captureContainerLog(container) {
  * @param {(message: string) => void} [opts.log] - Progress reporting.
  * @returns {number} The suite's exit status.
  */
-export function runSuite({
-    command,
-    args = [],
-    cwd,
-    env = process.env,
-    log = () => {},
-}) {
+export function runSuite({ command, args = [], cwd, env = process.env, log = () => {} }) {
     const [program, ...rest] = command;
     const childEnv = { ...env };
     delete childEnv.ELECTRON_RUN_AS_NODE;
     log(`▸ ${[...command, ...args].join(" ")}`);
-    const result = spawnSync(
-        /** @type {string} */ (program),
-        [...rest, ...args],
-        {
-            stdio: "inherit",
-            cwd,
-            env: childEnv,
-            shell: process.platform === "win32",
-        },
-    );
+    const result = spawnSync(/** @type {string} */ (program), [...rest, ...args], {
+        stdio: "inherit",
+        cwd,
+        env: childEnv,
+        shell: process.platform === "win32",
+    });
     if (result.error) throw result.error;
     return result.status ?? 1;
 }
@@ -756,12 +722,7 @@ export async function e2eRun({
  * @param {(message: string) => void} [opts.log] - Progress reporting.
  * @returns {Promise<number>} The suite's exit status.
  */
-export async function e2eFast({
-    config,
-    argv = [],
-    env = process.env,
-    log = () => {},
-}) {
+export async function e2eFast({ config, argv = [], env = process.env, log = () => {} }) {
     const {
         targets,
         recreate,

package/engine/address-diff.mjs

@@ -198,10 +198,7 @@ export function diffItemAddresses(baseline, current, { baseline: label }) {
 export function noteFilesById(contentBase, { skipDirectories } = {}) {
     const byId = new Map();
     const walkOpts = skipDirectories ? { skipDirectories } : undefined;
-    for (const { frontmatter: fm, absPath } of walkMarkdownTree(
-        contentBase,
-        walkOpts,
-    )) {
+    for (const { frontmatter: fm, absPath } of walkMarkdownTree(contentBase, walkOpts)) {
         if (fm?.id && !byId.has(fm.id)) byId.set(fm.id, absPath);
     }
     return byId;

package/engine/base-compiler.mjs

@@ -244,9 +244,7 @@ export class BasePackCompiler {
         routingReporter = false,
     } = {}) {
         if (!contentBase) {
-            throw new Error(
-                `${this.constructor.name} compiler requires \`contentBase\``,
-            );
+            throw new Error(`${this.constructor.name} compiler requires \`contentBase\``);
         }
         if (!fs.existsSync(contentBase)) {
             throw new Error(`Content tree not found at ${contentBase}`);
@@ -358,10 +356,7 @@ export class BasePackCompiler {
      */
     async prepare() {
         if (this.constructor.convertsWikilinks) {
-            this.linkIndex = buildContentLinkIndex(
-                this.contentBase,
-                this.router,
-            );
+            this.linkIndex = buildContentLinkIndex(this.contentBase, this.router);
             this.contentDocs = collectContentDocs(this.contentBase);
         }
         this.unresolvedLinks = 0;
@@ -457,9 +452,7 @@ export class BasePackCompiler {
      */
     // eslint-disable-next-line no-unused-vars
     buildEntry(fm, markdown) {
-        throw new Error(
-            `${this.constructor.name} must implement buildEntry(fm, markdown)`,
-        );
+        throw new Error(`${this.constructor.name} must implement buildEntry(fm, markdown)`);
     }
 
     /**
@@ -526,9 +519,7 @@ export class BasePackCompiler {
      */
     reportCompiled(stats) {
         const label = this.constructor.label;
-        log.info(
-            `Compiled ${stats.compiled} ${label}${stats.compiled === 1 ? "" : "s"}`,
-        );
+        log.info(`Compiled ${stats.compiled} ${label}${stats.compiled === 1 ? "" : "s"}`);
     }
 
     /**
@@ -538,9 +529,7 @@ export class BasePackCompiler {
      * @param {PassStats} stats - The pass's tallies.
      */
     reportDetail(stats) {
-        log.debug(
-            `Skipped ${stats.skippedOther} file(s) this pack does not claim`,
-        );
+        log.debug(`Skipped ${stats.skippedOther} file(s) this pack does not claim`);
     }
 
     /**
@@ -563,8 +552,7 @@ export class BasePackCompiler {
             // them in the skipped tally is the defect (#56). Each one has
             // already been named individually as a diagnostic.
             log.error(
-                `Declined ${stats.declined} note(s) declaring a retired ` +
-                    `frontmatter field`,
+                `Declined ${stats.declined} note(s) declaring a retired ` + `frontmatter field`,
             );
         }
         this.reportDetail(stats);
@@ -588,13 +576,9 @@ export class BasePackCompiler {
         const label = this.constructor.label;
         const Label = label.charAt(0).toUpperCase() + label.slice(1);
 
-        for (const {
-            frontmatter: fm,
-            body,
-            absPath,
-            bodyLine,
-            bodyColumn,
-        } of walkMarkdownTree(this.contentBase)) {
+        for (const { frontmatter: fm, body, absPath, bodyLine, bodyColumn } of walkMarkdownTree(
+            this.contentBase,
+        )) {
             // Which note this pass is on, so anything it calls can report a
             // position without every method having to be handed one (#17).
             this.currentNote = { absPath, bodyLine, bodyColumn };
@@ -665,9 +649,7 @@ export class BasePackCompiler {
                 continue;
             }
 
-            log.debug(
-                `Processing ${this.noteLabel(fm)}: ${resolveName(fm)} (${absPath})`,
-            );
+            log.debug(`Processing ${this.noteLabel(fm)}: ${resolveName(fm)} (${absPath})`);
             try {
                 const doc = this.compileNote(fm, this.convertBody(fm, body));
                 stats.compiled++;

package/engine/code-fences.mjs

@@ -111,9 +111,7 @@ export function codeRegions(markdown, { spans = true } = {}) {
         const fence = FENCE_LINE.exec(line);
         if (fence) {
             const marker = fence[2];
-            const closer = new RegExp(
-                `^[ \\t]*${marker[0]}{${marker.length},}[ \\t]*$`,
-            );
+            const closer = new RegExp(`^[ \\t]*${marker[0]}{${marker.length},}[ \\t]*$`);
             let close = i + 1;
             while (close < lines.length && !closer.test(lines[close])) close++;
             // An unclosed fence runs to the end of the document.
@@ -225,9 +223,7 @@ function inside(regions, offset) {
  */
 function offsetOf(args) {
     const last = args[args.length - 1];
-    return typeof last === "string" ?
-            args[args.length - 2]
-        :   args[args.length - 3];
+    return typeof last === "string" ? args[args.length - 2] : args[args.length - 3];
 }
 
 /**
@@ -263,9 +259,7 @@ export function replaceOutsideCode(markdown, pattern, replacer, options) {
 export function matchAllOutsideCode(markdown, pattern, options) {
     const src = String(markdown ?? "");
     const regions = codeRegions(src, options);
-    return [...src.matchAll(pattern)].filter(
-        (match) => !inside(regions, match.index),
-    );
+    return [...src.matchAll(pattern)].filter((match) => !inside(regions, match.index));
 }
 
 /**
@@ -304,8 +298,5 @@ export function protectCode(body, transform) {
         last = region.end;
     }
     masked += src.slice(last);
-    return transform(masked).replace(
-        /\u0000(\d+)\u0000/g,
-        (_m, i) => stash[Number(i)],
-    );
+    return transform(masked).replace(/\u0000(\d+)\u0000/g, (_m, i) => stash[Number(i)]);
 }

package/engine/compendiums.mjs

@@ -87,17 +87,13 @@ export async function compilePacks({
     stageDest = config.paths.stage,
     packName,
 } = {}) {
-    const packNames = sourcePacks.filter(
-        (name) => !packName || name === packName,
-    );
+    const packNames = sourcePacks.filter((name) => !packName || name === packName);
 
     // A prebuilt pack's JSON is checked in rather than generated, so it is
     // compiled from where it lives. Anything else comes from the build-only
     // intermediate the generation pass writes.
     const prebuiltDirs = new Map(
-        config.packs
-            .filter((pack) => pack.prebuilt)
-            .map((pack) => [pack.name, pack.prebuilt]),
+        config.packs.filter((pack) => pack.prebuilt).map((pack) => [pack.name, pack.prebuilt]),
     );
     const needsGeneration = packNames.some((name) => !prebuiltDirs.has(name));
 
@@ -185,8 +181,7 @@ function cleanPackEntry(
     }
     delete data.flags?.importSource;
     delete data.flags?.exportSource;
-    if (data._stats?.lastModifiedBy)
-        data._stats.lastModifiedBy = lastModifiedBy;
+    if (data._stats?.lastModifiedBy) data._stats.lastModifiedBy = lastModifiedBy;
 
     // Remove empty entries in flags
     if (!data.flags) data.flags = {};
@@ -194,18 +189,11 @@ function cleanPackEntry(
         if (Object.keys(contents).length === 0) delete data.flags[key];
     });
 
-    if (data.effects)
-        data.effects.forEach((i) =>
-            cleanPackEntry(i, { clearSourceId: false }),
-        );
-    if (data.items)
-        data.items.forEach((i) => cleanPackEntry(i, { clearSourceId: false }));
-    if (data.pages)
-        data.pages.forEach((i) => cleanPackEntry(i, { ownership: -1 }));
-    if (data.system?.description)
-        data.system.description = cleanString(data.system.description);
-    if (data.system?.biography)
-        data.system.biography = cleanString(data.system.biography);
+    if (data.effects) data.effects.forEach((i) => cleanPackEntry(i, { clearSourceId: false }));
+    if (data.items) data.items.forEach((i) => cleanPackEntry(i, { clearSourceId: false }));
+    if (data.pages) data.pages.forEach((i) => cleanPackEntry(i, { ownership: -1 }));
+    if (data.system?.description) data.system.description = cleanString(data.system.description);
+    if (data.system?.biography) data.system.biography = cleanString(data.system.biography);
     if (data.system?.textReference)
         data.system.textReference = cleanString(data.system.textReference);
     if (data.system?.notes) data.system.notes = cleanString(data.system.notes);
@@ -249,10 +237,7 @@ export async function cleanPacks({
 
     const folders = fs
         .readdirSync(packDest, { withFileTypes: true })
-        .filter(
-            (file) =>
-                file.isDirectory() && (!packName || packName === file.name),
-        );
+        .filter((file) => file.isDirectory() && (!packName || packName === file.name));
 
     /**
      * Walk through directories to find JSON files.
@@ -273,9 +258,7 @@ export async function cleanPacks({
             const json = JSON.parse(await readFile(src, { encoding: "utf8" }));
             if (entryName && entryName !== json.name.toLowerCase()) continue;
             if (!json._id || !json._key) {
-                log.info(
-                    `Failed to clean \x1b[31m${src}\x1b[0m, must have _id and _key.`,
-                );
+                log.info(`Failed to clean \x1b[31m${src}\x1b[0m, must have _id and _key.`);
                 continue;
             }
             cleanPackEntry(json);
@@ -351,21 +334,14 @@ export async function unpackPacks({
         await extractPack(src, dest, {
             log: true,
             transformEntry: (entry) => {
-                if (entryName && entryName !== entry.name.toLowerCase())
-                    return false;
+                if (entryName && entryName !== entry.name.toLowerCase()) return false;
                 cleanPackEntry(entry);
             },
             transformName: (entry) => {
                 if (entry._id in folders)
-                    return path.join(
-                        "folder_",
-                        folders[entry._id].path,
-                        ".json",
-                    );
+                    return path.join("folder_", folders[entry._id].path, ".json");
                 const outputName = slugify(entry.name);
-                const parent =
-                    containers[entry.system?.container] ??
-                    folders[entry.folder];
+                const parent = containers[entry.system?.container] ?? folders[entry.folder];
                 return path.join(parent?.path ?? "", `${outputName}.json`);
             },
         });

package/engine/content-address.mjs

@@ -80,9 +80,7 @@ export function contentAddress(fm, name, isReadme) {
  */
 function landingOf(fm, isReadme, landing) {
     if (landing === "readme") {
-        return isReadme ?
-                { landing: true, segment: sectionOf(fm) }
-            :   { landing: false };
+        return isReadme ? { landing: true, segment: sectionOf(fm) } : { landing: false };
     }
     // `collection`. The section is authored rather than derived: it is the
     // identity of the section being introduced, and the note's own title
@@ -127,9 +125,7 @@ export function packageAddress(fm, name, { isReadme = false, scheme } = {}) {
     const land = landingOf(fm, isReadme, landing);
     if (land.landing) {
         if (typeof land.segment !== "string" || !land.segment) {
-            throw new Error(
-                `landing note declares no section, so it lands nowhere`,
-            );
+            throw new Error(`landing note declares no section, so it lands nowhere`);
         }
         return `${prefix}${land.segment}/`;
     }