@loadmap/cli 0.2.0 → 0.3.0

package/README.md

@@ -2,12 +2,15 @@
 
 ```bash
 npx @loadmap/cli check shop.loadmap          # exit 1 when an expect line fails; GitHub annotations under Actions
+npx @loadmap/cli fmt shop.loadmap            # lays it out the one way; --check exits 1 instead (for CI)
 npx @loadmap/cli record shop.loadmap --out shop.gif --caption
 npx @loadmap/cli record http://localhost:5173/ --out poster.png --poster
 ```
 
 `loadmap check` compiles each `.loadmap` and tests its `expect` lines on the pessimistic edge (every capacity at its
-low bound). `loadmap record` draws a `.loadmap` (or opens a page that calls `expose()` from `@loadmap/export`) in
+low bound). `loadmap fmt` rewrites each file laid out the one way (two spaces a block, a statement a line, one space
+around operators; numbers, texts and formulas as written), `--check` only names the ones that are not, `-` reads
+standard input. `loadmap record` draws a `.loadmap` (or opens a page that calls `expose()` from `@loadmap/export`) in
 headless Chromium and records it on a fixed clock: the same options give the same file. Recording needs Chromium
 once: `npx playwright install chromium`. `loadmap --help` lists every option.
 Docs: https://jaim3r0jas.github.io/loadmap/ · MIT

package/dist/bin.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { n as main } from "./src-IlCf12IX.js";
+import { n as main } from "./src-CCAswkjM.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

@@ -27,7 +27,20 @@ export declare function check(argv: string[], o?: CheckOptions): Promise<number>
  * https://docs.github.com/actions/reference/workflow-commands-for-github-actions
  */
 export declare function github(d: Diagnostic, file: string, source: string): string;
-export declare const USAGE = "loadmap check <file.loadmap>… [--format text|github]\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\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.\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)";
+interface FmtOptions {
+  log?: (s: string) => void;
+  /** Where `-` reads the definition from. Default: standard input. */
+  read?: () => Promise<string>;
+  /** Where `-` writes it to. Default: standard output. */
+  write?: (s: string) => void;
+}
+/**
+ * `loadmap fmt`: lays each definition out the one way (`format()` of @loadmap/dsl), in place. With `--check` it only
+ * names the files that are not laid out so. `-` reads standard input and writes standard output. Resolves to 1 when a
+ * 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.\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 interface RecordArgs {
   /** A page that calls expose(); empty with `file`. */
   url: string;
@@ -63,4 +76,4 @@ export declare function parseRecord(argv: string[]): Promise<RecordArgs>;
 export declare function record(a: RecordArgs, o?: {
   viewer?: string;
 }): Promise<Buffer>;
-export type { CheckOptions };
+export type { CheckOptions, FmtOptions };

package/dist/index.js

@@ -1 +1 @@
-export { t as USAGE, a as check, o as github, n as main, r as parseRecord, i as record } from "./src-IlCf12IX.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-CCAswkjM.js";