@flux-lang/cli 0.1.2 → 0.1.4

package/dist/bin/flux.js

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 import fs from "node:fs/promises";
+import path from "node:path";
 import { stdin as nodeStdin } from "node:process";
-import { parseDocument, initRuntimeState, checkDocument, } from "@flux-lang/core";
+import { createRuntime, parseDocument, initRuntimeState, checkDocument } from "@flux-lang/core";
+import { runViewer } from "../view/runViewer.js";
 const VERSION = "0.1.0";
 // Entry
 void (async () => {
@@ -54,6 +56,9 @@ async function main(argv) {
     if (cmd === "check") {
         return runCheck(rest);
     }
+    if (cmd === "view") {
+        return runView(rest);
+    }
     console.error(`Unknown command '${cmd}'.`);
     printGlobalHelp();
     return 1;
@@ -68,10 +73,12 @@ function printGlobalHelp() {
         "Usage:",
         "  flux parse [options] <files...>",
         "  flux check [options] <files...>",
+        "  flux view <file>",
         "",
         "Commands:",
         "  parse   Parse Flux source files and print their IR as JSON.",
         "  check   Parse and run basic static checks.",
+        "  view    View a Flux document in a simple docstep viewer.",
         "",
         "Global options:",
         "  -h, --help      Show this help message.",
@@ -282,6 +289,31 @@ async function runCheck(args) {
     return 0;
 }
 /* -------------------------------------------------------------------------- */
+/*                                  flux view                                 */
+/* -------------------------------------------------------------------------- */
+async function runView(args) {
+    if (args.length === 0) {
+        console.error("flux view: No input file specified.");
+        return 1;
+    }
+    const docPath = path.resolve(args[0]);
+    try {
+        const source = await fs.readFile(docPath, "utf8");
+        const doc = parseDocument(source);
+        const runtime = createRuntime(doc, { clock: "manual" });
+        const labels = new Map();
+        for (const mat of doc.materials?.materials ?? []) {
+            labels.set(mat.name, mat.label ?? mat.name);
+        }
+        await runViewer(runtime, { docPath, title: doc.meta.title, materialLabels: labels });
+        return 0;
+    }
+    catch (error) {
+        console.error(`flux view: ${String(error?.message ?? error)}`);
+        return 1;
+    }
+}
+/* -------------------------------------------------------------------------- */
 /*                               I/O + errors                                 */
 /* -------------------------------------------------------------------------- */
 async function readSource(file) {

package/dist/view/runViewer.js

@@ -0,0 +1,67 @@
+import readline from "node:readline";
+import path from "node:path";
+export async function runViewer(runtime, options) {
+    const materialLabels = options.materialLabels ?? new Map();
+    let snapshot = runtime.getSnapshot();
+    const redraw = (snap) => {
+        const grid = snap.grids[0];
+        const headerTitle = options.title ? `${options.title} (${path.basename(options.docPath)})` : options.docPath;
+        process.stdout.write("\x1Bc");
+        console.log(headerTitle);
+        if (grid) {
+            console.log(`docstep ${snap.docstep} · grid ${grid.name}`);
+        }
+        else {
+            console.log(`docstep ${snap.docstep}`);
+        }
+        const paramsStr = Object.entries(snap.params)
+            .map(([k, v]) => `${k}: ${v}`)
+            .join(", ");
+        console.log(`params: { ${paramsStr} }`);
+        console.log("");
+        if (grid) {
+            for (let r = 0; r < grid.rows; r++) {
+                const rowCells = grid.cells.filter((cell) => cell.row === r);
+                const line = rowCells
+                    .map((cell) => formatCell(cell.content, materialLabels))
+                    .map((text) => text.padEnd(6, " "))
+                    .join(" ");
+                console.log(`  ${line}`);
+            }
+        }
+        console.log("");
+        console.log("[Enter/space] step · [q] quit");
+    };
+    redraw(snapshot);
+    readline.emitKeypressEvents(process.stdin);
+    if (process.stdin.isTTY) {
+        process.stdin.setRawMode(true);
+    }
+    await new Promise((resolve) => {
+        const onKeypress = (_, key) => {
+            if (key.name === "q" || (key.ctrl && key.name === "c")) {
+                cleanup();
+                resolve();
+                return;
+            }
+            if (key.name === "return" || key.name === "enter" || key.name === "space") {
+                const { snapshot: next } = runtime.stepDocstep();
+                snapshot = next;
+                redraw(snapshot);
+            }
+        };
+        const cleanup = () => {
+            process.stdin.off("keypress", onKeypress);
+            if (process.stdin.isTTY) {
+                process.stdin.setRawMode(false);
+            }
+        };
+        process.stdin.on("keypress", onKeypress);
+    });
+}
+function formatCell(content, labels) {
+    if (!content)
+        return ".";
+    const label = labels.get(content) ?? content;
+    return label.slice(0, 6);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flux-lang/cli",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "CLI tooling for the Flux score language",
   "license": "MIT",
   "author": "Sebastian Suarez-Solis",
@@ -14,8 +14,7 @@
   },
   "files": [
     "dist",
-    "README.md",
-    "LICENSE"
+    "README.md"
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
@@ -25,7 +24,7 @@
     "prepublishOnly": "npm run build && chmod +x dist/bin/flux.js"
   },
   "dependencies": {
-    "@flux-lang/core": "0.1.0"
+    "@flux-lang/core": "0.1.1"
   },
   "devDependencies": {
     "execa": "^8.0.0",