@rivetjs/nx 0.1.0-alpha.1 → 0.1.0-alpha.2

package/README.md

@@ -47,6 +47,8 @@ All generators write through the Nx tree: `--dry-run` shows the files without wr
 | `@rivetjs/nx:typecheck` | `rivet sync` + `tsc --noEmit`. |
 | `@rivetjs/nx:package` | Publishable library: `.js` / `.jsx` (JSX preserved) + `.d.ts`, mapped `package.json`. |
 
+The `check` executor also accepts `format: "json"`, `quiet: true` and `verbose: true`. JSON mode hides successful sync output and executor headings; Nx can still add its own task summary. Use `rivet-check --json` directly for a pipe consumed by a JSON parser. Step headings, durations and failure hints use stderr.
+
 ## Inferred targets
 
 ```json

package/executors/check/executor.js

@@ -7,8 +7,17 @@ export function syncStep(root, bin) {
 export function checkSteps(options, root, facts, bin) {
     const routed = facts?.kind === "app";
     const steps = [];
-    if (options.sync ?? routed)
-        steps.push(syncStep(root, bin));
+    if (options.sync ?? routed) {
+        const step = syncStep(root, bin);
+        if (options.format === "json")
+            step.args.push("--json", "--quiet");
+        else if (options.quiet)
+            step.args.push("--quiet");
+        // Capture successful sync JSON so stdout contains only the check result.
+        if (options.format === "json")
+            step.quietSuccess = true;
+        steps.push(step);
+    }
     const configs = options.tsConfig === undefined ? ["tsconfig.json"] : Array.isArray(options.tsConfig) ? options.tsConfig : [options.tsConfig];
     steps.push({
         label: "rivet-check",
@@ -19,6 +28,8 @@ export function checkSteps(options, root, facts, bin) {
                 ["--no-types", options.types === false],
                 ["--no-manifest", !(options.manifest ?? routed)],
                 ["--format", options.format],
+                ["--quiet", options.quiet],
+                ["--verbose", options.verbose],
             ]),
         ],
         cwd: root,
@@ -27,5 +38,5 @@ export function checkSteps(options, root, facts, bin) {
 }
 export default async function checkExecutor(options, context) {
     const root = projectRoot(context);
-    return runSteps(checkSteps(options, root, projectFacts(root), resolverFrom(root)));
+    return runSteps(checkSteps(options, root, projectFacts(root), resolverFrom(root)), { verbose: !options.quiet && options.format !== "json" });
 }

package/executors/check/schema.d.ts

@@ -1,12 +1,16 @@
 export interface CheckExecutorSchema {
   /** tsconfig file(s) to check, relative to the project. Default `tsconfig.json`. */
   tsConfig?: string | string[];
-  /** Type-aware checks (RV2101 serializability, RV3101 route links). Default true. */
+  /** Type-aware checks (RV3101 route links). Default true. */
   types?: boolean;
   /** Check `.rivet/editor.json` (RV7101 / RV7102). Default: routed apps only. */
   manifest?: boolean;
   /** Run `rivet sync` first (regenerates `.rivet/`). Default: routed apps only. */
   sync?: boolean;
   /** Output format. */
+  /** Errors only. */
+  quiet?: boolean;
+  /** Include error stacks. */
+  verbose?: boolean;
   format?: "text" | "json";
 }

package/executors/check/schema.json

@@ -6,13 +6,45 @@
   "type": "object",
   "properties": {
     "tsConfig": {
-      "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }],
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ],
       "description": "tsconfig file(s) to check, relative to the project. Default tsconfig.json."
     },
-    "types": { "type": "boolean", "default": true, "description": "Type-aware checks (RV2101 serializability, RV3101 route links)." },
-    "manifest": { "type": "boolean", "description": "Check .rivet/editor.json (RV7101 / RV7102). Default: routed apps only." },
-    "sync": { "type": "boolean", "description": "Run rivet sync first. Default: routed apps only." },
-    "format": { "type": "string", "enum": ["text", "json"], "description": "Output format." }
+    "types": {
+      "type": "boolean",
+      "default": true,
+      "description": "Type-aware checks (RV3101 route links)."
+    },
+    "manifest": {
+      "type": "boolean",
+      "description": "Check .rivet/editor.json (RV7101 / RV7102). Default: routed apps only."
+    },
+    "sync": {
+      "type": "boolean",
+      "description": "Run rivet sync first. Default: routed apps only."
+    },
+    "format": {
+      "type": "string",
+      "enum": ["text", "json"],
+      "description": "Output format."
+    },
+    "quiet": {
+      "type": "boolean",
+      "description": "Errors only; suppress warnings, progress and summaries."
+    },
+    "verbose": {
+      "type": "boolean",
+      "description": "Include error stacks from rivet-check (also DEBUG=rivet)."
+    }
   },
   "additionalProperties": false
 }

package/executors/run.d.ts

@@ -4,6 +4,8 @@ import type { ExecutorContext } from "@nx/devkit";
 export interface Step {
     /** Shown before the step runs. */
     label: string;
+    /** Buffer stdout and replay it only on failure (JSON prerequisite steps). */
+    quietSuccess?: boolean;
     /** Arguments after the Node binary (`[bin, …args]` or `["--input-type=module", "-e", code]`). */
     args: string[];
     cwd: string;

package/executors/run.js

@@ -62,14 +62,25 @@ function hookSignals() {
 /** Starts a step; `exit` resolves with its status (signals count as failure). */
 export function start(step) {
     hookSignals();
-    const child = spawn(process.execPath, step.args, { cwd: step.cwd, env: { ...process.env, ...step.env }, stdio: "inherit" });
+    const child = spawn(process.execPath, step.args, {
+        cwd: step.cwd,
+        env: { ...process.env, ...step.env },
+        stdio: step.quietSuccess ? ["inherit", "pipe", "inherit"] : "inherit",
+    });
     children.add(child);
+    const output = [];
+    if (step.quietSuccess)
+        child.stdout?.on("data", (chunk) => output.push(chunk));
     const exit = new Promise((done) => {
         child.on("error", (error) => {
-            console.error(error);
+            children.delete(child);
+            console.error(`[rivet:nx] error: ${step.label} could not start in ${step.cwd}: ${error.message}\n  fix: Check the working directory and tool installation.${process.env.DEBUG === "rivet" ? "\n" + error.stack : ""}`);
             done(1);
         });
-        child.on("exit", (code) => {
+        child.on("close", (code) => {
+            if (step.quietSuccess && code !== 0)
+                for (const chunk of output)
+                    process.stdout.write(chunk);
             children.delete(child);
             done(code ?? 1);
         });
@@ -79,10 +90,17 @@ export function start(step) {
 /** Runs steps in order; stops at the first failure. */
 export async function runSteps(steps, { verbose = true } = {}) {
     for (const step of steps) {
+        const started = performance.now();
         if (verbose)
-            console.log(`> ${step.label}`);
-        if ((await start(step).exit) !== 0)
+            console.error(`[rivet:nx] ${step.label} (${step.cwd})`);
+        const status = await start(step).exit;
+        if (status !== 0) {
+            if (verbose)
+                console.error(`[rivet:nx] error: ${step.label} exited ${status}. Fix the diagnostic above and rerun the target.`);
             return { success: false };
+        }
+        if (verbose)
+            console.error(`[rivet:nx] ${step.label} finished in ${((performance.now() - started) / 1000).toFixed(1)} s`);
     }
     return { success: true };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivetjs/nx",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "license": "MIT",
   "type": "module",
   "description": "Nx plugin for Rivet: generators, executors and inferred tasks for Rivet apps and libraries.",
@@ -38,7 +38,7 @@
   },
   "dependencies": {
     "@nx/devkit": "23.2.1",
-    "create-rivet": "0.1.0-alpha.1"
+    "create-rivet": "0.1.0-alpha.2"
   },
   "peerDependencies": {
     "nx": ">=23 <24"