@loadmap/cli 0.8.0 → 0.10.0

package/dist/bin.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { n as main } from "./src-KVw61wOu.js";
+import { n as main } from "./src-0Gq92LO7.js";
 // src/bin.ts
 main(process.argv.slice(2)).then((code) => process.exit(code), (err) => {
 	console.error(err instanceof Error ? err.message : err);

package/dist/index.d.ts

@@ -40,7 +40,7 @@ interface FmtOptions {
  * file has a syntax error, cannot be read, or (with --check) needs formatting; 2 for a usage mistake.
  */
 export declare function fmt(argv: string[], o?: FmtOptions): Promise<number>;
-export declare const USAGE = "loadmap check <file.loadmap>… [--format text|github]\nloadmap fmt <file.loadmap>… [--check] | loadmap fmt -\nloadmap record <url | file.loadmap> --out <file.gif|.webm|.mp4|.png|.svg> [options]\n\ncheck compiles each definition and tests its expect lines on the pessimistic edge (every capacity at its low\nbound). It exits 1 when a definition has an error or an expectation fails, 0 when everything holds.\n\n  --format <f>          text, or github to add annotations on the lines (the default under GitHub Actions)\n\nfmt lays each definition out the one way, in place: two spaces a block, a statement a line, one space around\noperators; numbers, texts and formulas stay as written. A file with a syntax error is left alone (exit 1).\n\n  --check               change nothing; exit 1 when a file is not laid out so (for CI)\n  -                     read standard input, write standard output\n\nrecord opens the page in headless Chromium, finds the loadmap it exposes (expose() from @loadmap/export) and\nrecords it on a fixed clock, so the same options give the same file. A .loadmap file is drawn by the viewer that\ncomes with the command. It needs Playwright next to the command: npm i -D playwright, then npx playwright install\nchromium (check and fmt run without it).\n\n  --out <file>          the extension picks the format: gif, webm, mp4, png or svg\n  --script <file.json>  [{ \"at\": 0, \"set\": { \"load\": 5 } }, { \"at\": 3, \"scenario\": \"Proposed\" }, …]\n                        or { \"seconds\", \"fps\", \"script\": […] }\n  --scenario <label>    start from a scenario's values (--set goes on top)\n  --set <key=value>     a value before recording starts; repeatable (--set load=30 --set pods=6)\n  --caption             the title, scenario and load above the board, the verdict below it\n  --story               play the definition's story, a step at a time (with --caption, its text below the board)\n  --poster              with .png: the board, the verdict, the limits and the scenarios compared\n  --seconds <n>         length of a video or GIF (default 8, or the script's)\n  --fps <n>             frames per second (default 30; GIF 15, at most 50)\n  --scale <n>           pixels per diagram unit (default 1, PNG 2)\n  --seed <n>            the sim's seed (default 1)\n  --name <name>         which exposed loadmap, when the page has several (default \"default\")\n  --width <px>          the browser window (default 1280; below 640 the diagram runs top to bottom)\n  --color-scheme <s>    light or dark, for a page that follows the system theme (default light)";
+export declare const USAGE = "loadmap check <file.loadmap>… [--format text|github]\nloadmap fmt <file.loadmap>… [--check] | loadmap fmt -\nloadmap record <url | file.loadmap> --out <file.gif|.webm|.mp4|.png|.svg> [options]\n\ncheck compiles each definition and tests its expect lines on the pessimistic edge (every capacity at its low\nbound). It exits 1 when a definition has an error or an expectation fails, 0 when everything holds.\n\n  --format <f>          text, or github to add annotations on the lines (the default under GitHub Actions)\n\nfmt lays each definition out the one way, in place: two spaces a block, a statement a line, one space around\noperators; numbers, texts and formulas stay as written. A file with a syntax error is left alone (exit 1).\n\n  --check               change nothing; exit 1 when a file is not laid out so (for CI)\n  -                     read standard input, write standard output\n\nrecord opens the page in headless Chromium, finds the loadmap it exposes (expose() from @loadmap/export) and\nrecords it on a fixed clock, so the same options give the same file. A .loadmap file is drawn by the viewer that\ncomes with the command. It needs Playwright next to the command: npm i -D playwright, then npx playwright install\nchromium (check and fmt run without it).\n\n  --out <file>          the extension picks the format: gif, webm, mp4, png or svg\n  --script <file.json>  [{ \"at\": 0, \"set\": { \"load\": 5 } }, { \"at\": 3, \"scenario\": \"Proposed\" }, …]\n                        or { \"seconds\", \"fps\", \"script\": […] }\n  --scenario <label>    start from a scenario's values (--set goes on top)\n  --set <key=value>     a value before recording starts; repeatable (--set load=30 --set pods=6)\n  --caption             the title, scenario and load above the board, the verdict below it\n  --story               play the definition's story as the page's Play does: close on each change, then the whole\n                        diagram (with --caption, each step's text below the board)\n  --poster              with .png: the board, the verdict, the limits and the scenarios compared\n  --seconds <n>         length of a video or GIF (default 8, or the script's)\n  --fps <n>             frames per second (default 30; GIF 15, at most 50)\n  --scale <n>           pixels per diagram unit (default 1, PNG 2)\n  --seed <n>            the sim's seed (default 1)\n  --name <name>         which exposed loadmap, when the page has several (default \"default\")\n  --width <px>          the browser window (default 1280; below 640 the diagram runs top to bottom)\n  --color-scheme <s>    light or dark, for a page that follows the system theme (default light)";
 export interface RecordArgs {
   /** A page that calls expose(); empty with `file`. */
   url: string;

package/dist/index.js

@@ -1 +1 @@
-export { t as USAGE, o as check, a as fmt, s as github, n as main, r as parseRecord, i as record } from "./src-KVw61wOu.js";
+export { t as USAGE, o as check, a as fmt, s as github, n as main, r as parseRecord, i as record } from "./src-0Gq92LO7.js";

package/dist/{src-KVw61wOu.js → src-0Gq92LO7.js}

@@ -459,8 +459,10 @@ function defineModel(def) {
 		if (st.focus != null && !componentIds.includes(st.focus)) throw new Error(`loadmap: ${name} points at unknown component "${st.focus}"`);
 		if (st.seconds != null && !(st.seconds > 0 && Number.isFinite(st.seconds))) throw new Error(`loadmap: ${name} needs seconds above 0, not ${st.seconds}`);
 		takes(name, st.set ?? {}, true);
+		if (st.title != null && !st.title.trim()) throw new Error(`loadmap: ${name} has an empty title`);
 		return {
 			text: st.text,
+			...st.title != null ? { title: st.title } : {},
 			values: {
 				...defaults(),
 				...from?.values,
@@ -1792,8 +1794,8 @@ const SCHEMA = {
 		children: []
 	},
 	step: {
-		doc: "A step of the story the page walks through, in order: its text, and the values to show it at. `loadmap record --story` plays it.",
-		example: "step \"At 30×, the workers run out first.\" { load: 30; focus: workers }",
+		doc: "A step of the story the page walks through, in order: its text, and the values to show it at. Play (and `loadmap record --story`) shows the whole diagram, closes in on what the step changes, changes it, and steps back.",
+		example: "step \"At 30×, the workers run out first.\" { load: 30; focus: workers; title: \"Users to 30×\" }",
 		args: [{
 			name: "label",
 			kind: "text"
@@ -1804,6 +1806,11 @@ const SCHEMA = {
 				scope: "const",
 				doc: "Start from this scenario's values; without one, from the defaults."
 			},
+			title: {
+				value: "string",
+				scope: "const",
+				doc: "The few words the diagram shows while Play shows the step. Default: what the step changes."
+			},
 			focus: {
 				value: "component",
 				scope: "const",
@@ -1812,7 +1819,7 @@ const SCHEMA = {
 			seconds: {
 				value: "number",
 				scope: "const",
-				doc: "How long a recording holds the step. Default 4."
+				doc: "How long Play holds the whole diagram after the step changes it: the time to read it. Default 4."
 			}
 		},
 		children: [],
@@ -4291,6 +4298,8 @@ var Compiler = class {
 		}
 		const scenario = this.named(b, "scenario", Object.keys(scenarios), "scenario");
 		const focus = this.named(b, "focus", [...components.keys()], "component");
+		const title = this.constProp(b, "title");
+		if (title != null && !title.trim()) this.report.error(this.prop(b, "title").value, "a title needs a few words");
 		const seconds = this.constProp(b, "seconds");
 		if (seconds != null && !(seconds > 0 && Number.isFinite(seconds))) this.report.error(this.prop(b, "seconds").value, "seconds is a duration above 0");
 		const set = this.preset(b, params);
@@ -4299,6 +4308,7 @@ var Compiler = class {
 		if (text == null || scenario === null || focus === null) return void 0;
 		return {
 			text,
+			...title?.trim() ? { title } : {},
 			...scenario != null ? { scenario } : {},
 			...focus != null ? { focus } : {},
 			...seconds != null && seconds > 0 ? { seconds } : {},
@@ -5048,7 +5058,8 @@ chromium (check and fmt run without it).
   --scenario <label>    start from a scenario's values (--set goes on top)
   --set <key=value>     a value before recording starts; repeatable (--set load=30 --set pods=6)
   --caption             the title, scenario and load above the board, the verdict below it
-  --story               play the definition's story, a step at a time (with --caption, its text below the board)
+  --story               play the definition's story as the page's Play does: close on each change, then the whole
+                        diagram (with --caption, each step's text below the board)
   --poster              with .png: the board, the verdict, the limits and the scenarios compared
   --seconds <n>         length of a video or GIF (default 8, or the script's)
   --fps <n>             frames per second (default 30; GIF 15, at most 50)