@moku-labs/game 0.11.0 → 0.13.0

package/README.md

@@ -165,8 +165,9 @@ The engine bin `moku-game` serves, builds and packs a game folder. A game writes
 | `moku-game native build <target> [--simulator]` | Builds the native app: `ios`, `macos`, `android` |
 | `moku-game native dev <target>` | Runs the native shell on the dev server |
 | `moku-game native doctor`, `native clean` | Checks or removes the native project |
-| `moku-game keys [--check]` | Writes `generated/assets.ts`, the strings and `manifest.json` |
+| `moku-game keys [--check]` | Writes `generated/assets.ts`, the strings and `generated/manifest.json` |
 | `moku-game pack [--no-cache]` | Packs the assets into `dist/assets` |
+| `moku-game visual [--update] [--only <name>] [--no-pixels]` | Runs the visual tests of `tests/visual/index.ts` against `tests/visual/baselines/`. The pixel leg runs on a Mac, on a page served for the run. Exit 1 when a checkpoint differs |
 
 Every command takes `--root <dir>`, `--preload <path>` and `--serve-plugin <path>`.
 

package/dist/app/page.d.mts

@@ -1,4 +1,4 @@
-import { m as StartedPage, r as GameConfig, t as AnyGameApp, u as PageOptions } from "../types-Ca_z_4tQ.mjs";
+import { m as StartedPage, r as GameConfig, t as AnyGameApp, u as PageOptions } from "../types-DLghaGEy.mjs";
 
 //#region src/app/page.d.ts
 /**

package/dist/app/system.d.mts

@@ -1,6 +1,6 @@
 import { tn as PlayerStateProvider } from "../types-ZQLYXo5X.mjs";
-import { ot as PlatformProvider } from "../index-8TiJQjQA.mjs";
-import { _ as SystemShellFactory, g as SystemName, h as SystemModules } from "../types-Ca_z_4tQ.mjs";
+import { ct as PlatformProvider } from "../index-rnOYAriI.mjs";
+import { _ as SystemShellFactory, g as SystemName, h as SystemModules } from "../types-DLghaGEy.mjs";
 import { Back, Haptics, KeepAwake, Lifecycle, Store } from "@moku-labs/system";
 
 //#region src/app/system.d.ts

package/dist/app.d.mts

@@ -1,5 +1,5 @@
 import { Xt as Json } from "./types-ZQLYXo5X.mjs";
-import { a as GameHandle, c as MemoryProvider, d as SaveKind, f as Scenario, g as SystemName, i as GameDefinition, l as PageAgent, n as GameApp, o as GamePluginConfigs, p as ScreenSeams, r as GameConfig, s as HeadlessSeams } from "./types-Ca_z_4tQ.mjs";
+import { a as GameHandle, c as MemoryProvider, d as SaveKind, f as Scenario, g as SystemName, i as GameDefinition, l as PageAgent, n as GameApp, o as GamePluginConfigs, p as ScreenSeams, r as GameConfig, s as HeadlessSeams } from "./types-DLghaGEy.mjs";
 import { AnyPluginInstance } from "@moku-labs/core";
 
 //#region src/app/define.d.ts

package/dist/app.mjs

@@ -1,4 +1,4 @@
-import { H as platformPlugin, i as screen, jt as audioPlugin, t as createApp, xt as effectsPlugin } from "./src-BSbtHZWk.mjs";
+import { Ct as effectsPlugin, H as platformPlugin, Nt as audioPlugin, i as screen, t as createApp } from "./src-SmT-XxVf.mjs";
 import { t as memory } from "./memory-CWlqhS7l.mjs";
 import { t as fakeClock } from "./fake-MpzwZhIZ.mjs";
 //#region src/app/define.ts

package/dist/{assets-BHwTLVta.mjs → assets-DYiKxPBX.mjs}

@@ -1059,21 +1059,30 @@ function copyLoose(bundle, file, bytes) {
 const LOOSE_SIDE = 512;
 /** The last segment of a key that names a particle texture starts with this. */
 const FX_PREFIX = "fx-";
+/** A folder of particle textures: every texture below it is one. */
+const FX_FOLDER = "fx";
 /** The groups in the order a bundle packs them. */
 const GROUP_ORDER = ["fx", "main"];
 /**
-* Picks the atlas group of one texture. A key whose last segment starts with `fx-` goes to `fx`
-* whatever its size; any other texture goes to `main` when no side is above 512 px.
+* Picks the atlas group of one texture. A key whose last segment starts with `fx-`, or with a
+* folder segment `fx` between the bundle name and the stem, goes to `fx` whatever its size: the
+* frames of an animation in `fx/` too. Any other texture goes to `main` when no side is above
+* 512 px.
 *
 * @param texture - The key and the size of the texture.
 * @returns The group, or `undefined` when the texture stays loose by its size.
 * @example
 * ```ts
 * groupOf({ key: "ui.fx-rays", width: 504, height: 512 }); // "fx"
+* groupOf({ key: "ui.fx.leaf", width: 64, height: 64 }); // "fx", from assets/fx/leaf.webp of ui
+* groupOf({ key: "ui.fx", width: 64, height: 64 }); // "main": a stem, no folder
 * ```
 */
 function groupOf(texture) {
-	if (texture.key.slice(texture.key.lastIndexOf(".") + 1).startsWith(FX_PREFIX)) return "fx";
+	const segments = texture.key.split(".");
+	const name = segments.at(-1) ?? "";
+	const folders = segments.slice(1, -1);
+	if (name.startsWith(FX_PREFIX) || folders.includes(FX_FOLDER)) return "fx";
 	return texture.width <= LOOSE_SIDE && texture.height <= LOOSE_SIDE ? "main" : void 0;
 }
 /**
@@ -3080,65 +3089,23 @@ async function runCli(argv, strings, ui = createBrandConsole()) {
 */
 /** How every generated file starts. */
 const HEADER = "// generated by @moku-labs/game/assets, do not edit";
-/** The TypeScript cast keyword, kept apart so this file writes one and holds none. */
-const CAST$1 = "as";
+/** The engine root a generated module imports its types and helpers from, quoted. */
+const ENGINE = "\"@moku-labs/game\"";
 /** How a key with no parameters is typed, so `tr` takes it with no second argument. */
 const NO_PARAMS = "Record<string, never>";
 /** The name of the union a plain argument is typed by. */
 const ARGUMENT = "Argument";
 /**
-* The helper a compiled message calls for a plain argument: an element node keeps its place, a
-* list and a number go through `Intl`, everything else is read as text.
+* The import of the helpers the messages of a module call, by the names the message bodies use:
+* `messageArgument` as `argument` for a plain argument, `messageDuration` as `duration` for a
+* duration. None when no message calls one.
 *
-* @returns The helper as source.
+* @param entries - The keys of the locale.
+* @returns The import line, or `undefined`.
 */
-function argumentHelper() {
-	return [
-		"/** One plain argument: an element stays an element, a list and a number go through Intl. */",
-		"function argument(value: unknown, intl: I18n.IntlKit): I18n.Part {",
-		"  if (Array.isArray(value)) {",
-		`    return { kind: "text", text: intl.list().format(value ${CAST$1} readonly string[]) };`,
-		"  }",
-		"",
-		"  if (typeof value === \"number\") return { kind: \"text\", text: intl.number().format(value) };",
-		"",
-		"  if (",
-		"    typeof value === \"object\" &&",
-		"    value !== null &&",
-		"    \"type\" in value &&",
-		"    \"props\" in value &&",
-		"    \"children\" in value",
-		"  ) {",
-		`    return { kind: "element", node: value ${CAST$1} I18n.ElementNode };`,
-		"  }",
-		"",
-		"  return { kind: \"text\", text: String(value) };",
-		"}"
-	].join("\n");
-}
-/**
-* The helper a compiled `duration` calls: milliseconds into the record `Intl.DurationFormat`
-* reads. The same split as `durationInput` of the plugin: whole seconds rounded up, a negative or
-* non-finite value as zero, hours and minutes when above zero, seconds always.
-*
-* @returns The helper as source.
-*/
-function durationHelper() {
-	return [
-		"/** Milliseconds as Intl.DurationFormat reads them: whole seconds rounded up, seconds always. */",
-		"function duration(ms: number): Partial<Record<Intl.DurationFormatUnit, number>> {",
-		"  const total = Number.isFinite(ms) ? Math.max(0, Math.ceil(ms / 1000)) : 0;",
-		"  const hours = Math.floor(total / 3600);",
-		"  const minutes = Math.floor((total % 3600) / 60);",
-		"  const input: Partial<Record<Intl.DurationFormatUnit, number>> = {};",
-		"",
-		"  if (hours > 0) input.hours = hours;",
-		"  if (minutes > 0) input.minutes = minutes;",
-		"  input.seconds = total % 60;",
-		"",
-		"  return input;",
-		"}"
-	].join("\n");
+function helperImport(entries) {
+	const helpers = [...entries.some((entry) => entry.compiled.usesArgument) ? ["messageArgument as argument"] : [], ...entries.some((entry) => entry.compiled.usesDuration) ? ["messageDuration as duration"] : []];
+	return helpers.length === 0 ? void 0 : `import { ${helpers.join(", ")} } from ${ENGINE};`;
 }
 /**
 * Compares two keys, so every list the compiler writes has one order.
@@ -3152,8 +3119,8 @@ function byName(left, right) {
 	return left < right ? -1 : 1;
 }
 /**
-* Writes `generated/strings.<locale>.ts`: one arrow per key, keys sorted, each helper only when a
-* message needs it.
+* Writes `generated/strings.<locale>.ts`: one arrow per key, keys sorted, and the import of each
+* engine helper only when a message calls it.
 *
 * @param entries - The keys of the locale, in any order.
 * @returns The text of the module.
@@ -3166,11 +3133,8 @@ function byName(left, right) {
 function emitLocale(entries) {
 	const sorted = [...entries].toSorted((left, right) => byName(left.key, right.key));
 	const rows = sorted.map((entry) => `  ${JSON.stringify(entry.key)}: ${entry.compiled.source}`);
-	const blocks = [`${HEADER}\nimport type { I18n } from "@moku-labs/game";`];
-	if (sorted.some((entry) => entry.compiled.usesArgument)) blocks.push(argumentHelper());
-	if (sorted.some((entry) => entry.compiled.usesDuration)) blocks.push(durationHelper());
-	blocks.push(`export default {\n${rows.join(",\n")}\n} satisfies I18n.CompiledMessages;`);
-	return `${blocks.join("\n\n")}\n`;
+	const imports = [`import type { I18n } from ${ENGINE};`, helperImport(sorted)].filter((line) => line !== void 0);
+	return [`${HEADER}\n${imports.join("\n")}`, `export default {\n${rows.join(",\n")}\n} satisfies I18n.CompiledMessages;\n`].join("\n\n");
 }
 /**
 * Writes the type of one parameter.
@@ -3230,7 +3194,7 @@ function paramsOf(params) {
 function emitTypes(entries) {
 	const sorted = [...entries].toSorted((left, right) => byName(left.key, right.key));
 	const rows = sorted.map((entry) => `  ${JSON.stringify(entry.key)}: ${paramsOf(entry.params)};`);
-	const blocks = sorted.some((entry) => Object.values(entry.params).some((entry) => entry.kind === "argument")) ? [`${HEADER}\nimport type { DescriptionNode } from "@moku-labs/game";`, `type ${ARGUMENT} = string | number | readonly string[] | DescriptionNode;`] : [HEADER];
+	const blocks = sorted.some((entry) => Object.values(entry.params).some((entry) => entry.kind === "argument")) ? [`${HEADER}\nimport type { DescriptionNode } from ${ENGINE};`, `type ${ARGUMENT} = string | number | readonly string[] | DescriptionNode;`] : [HEADER];
 	blocks.push(`export type Strings = {\n${rows.join("\n")}\n};`, "export type StringKey = keyof Strings;");
 	return `${blocks.join("\n\n")}\n`;
 }

package/dist/assets.mjs

@@ -1,2 +1,2 @@
-import { a as runCli, c as emitKeys, i as compileStrings, l as emitManifest, n as importStrings, o as scanAssets, r as checkStrings, s as packAssets, t as exportStrings } from "./assets-BHwTLVta.mjs";
+import { a as runCli, c as emitKeys, i as compileStrings, l as emitManifest, n as importStrings, o as scanAssets, r as checkStrings, s as packAssets, t as exportStrings } from "./assets-DYiKxPBX.mjs";
 export { checkStrings, compileStrings, emitKeys, emitManifest, exportStrings, importStrings, packAssets, runCli, scanAssets };

package/dist/cli.d.mts

@@ -33,8 +33,8 @@ type PreparedPage = {
 };
 /**
  * Runs one `moku-game` command line in this process: `dev`, `build`, `native <verb>`, `keys`,
- * `pack` or `help`, with `--root`, `--preload` and `--serve-plugin` before or after the command
- * word. Every line goes through the branded console; nothing exits the process.
+ * `pack`, `visual` or `help`, with `--root`, `--preload` and `--serve-plugin` before or after the
+ * command word. Every line goes through the branded console; nothing exits the process.
  *
  * @param argv - The arguments after the bin.
  * @returns The exit code.
@@ -42,6 +42,7 @@ type PreparedPage = {
  * ```ts
  * // bin/moku-game.mjs in a game folder:
  * await runCli(["dev", "--port", "0"]); // 0 after Ctrl+C; stdout had "http://localhost:<port>/"
+ * await runCli(["visual", "--no-pixels"]); // 0 when every checkpoint of tests/visual/index.ts is the same
  * await runCli(["help"]); // 0
  * ```
  */