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

package/README.md

@@ -1,6 +1,6 @@
 # @rivetjs/nx
 
-[Nx](https://nx.dev) plugin for [Rivet](https://github.com/rivetjs/rivet): a workspace preset, generators for apps,
+[Nx](https://nx.dev) plugin for [Rivet](https://github.com/N1XUS/rivetjs): a workspace preset, generators for apps,
 libraries, routes and components, executors, and inferred `build` / `dev` / `preview` / `test` / `check` /
 `typecheck` targets with Nx caching.
 
@@ -26,7 +26,7 @@ Node.js 24 or newer, Nx 23.
 | `component` | `c` | A resumable component + test: `--kind=basic\|overlay` (render-function children), `--story` (a `/stories/<name>` page), `--directory`, `--export`. |
 | `route` | `r`, `page` | A file route: `blog/[slug]`, `docs/[[lang]]/[...path]`, `(group)/page`; `--loader`, `--action`, `--guard`, `--layout`. |
 | `layout` | | `src/routes/<dir>/_layout.tsx`, `--guard`. |
-| `api-route` | `endpoint` | An endpoint route with `onGet` / `onPost` / … (`--methods=get,post`). |
+| `api-route` | `endpoint` | An endpoint route with `onGet(…)` / `onPost(…)` / … exports (`--methods=get,post`). |
 | `ui-setup` | | `@rivetjs/ui` + Tailwind v4 + its styles (Rivet theme; other looks = `@rivetjs/ui/theme` presets). |
 | `i18n-setup` | | `@rivetjs/i18n`: `i18n.config.ts`, catalogs, the Vite plugin (`--locales=en,de`, `--prefix`). |
 | `init` | | Plugin in `nx.json`, shared tooling dependencies, `.rivet` in `.gitignore`. |
@@ -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
@@ -61,4 +63,4 @@ Every folder with a `package.json` or `project.json` and a Rivet Vite config (`r
 make `preview` run `wrangler dev` / Bun / Deno. `build`, `test`, `check`, `typecheck` are cached; `.rivet/`,
 `dist/` and `coverage/` are never inputs; `build` outputs `{projectRoot}/dist`.
 
-Docs: [Nx guide](https://github.com/rivetjs/rivet/blob/main/apps/docs/content/guides/tooling/nx.md).
+Docs: [Nx guide](https://github.com/N1XUS/rivetjs/blob/main/apps/docs/content/guides/tooling/nx.md).

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/generators/api-route/files/__fileName__.ts.template

@@ -1,11 +1,11 @@
-import type { RequestEvent } from "@rivetjs/router";
+import { <%- methods.map((method) => "on" + method[0].toUpperCase() + method.slice(1)).join(", ") %>, type RequestEvent } from "@rivetjs/router";
 <% for (const method of methods) { %>
 /** `<%= method.toUpperCase() %> <%= url %>`. Runs only on the server; must return a `Response`. */
-export const on<%= method[0].toUpperCase() + method.slice(1) %> = async (<% if (method === "get" || method === "delete") { %>{ params }<% } else { %>{ request, params }<% } %>: RequestEvent) => {<% if (method === "get") { %>
+export const <%= method.toUpperCase() %> = on<%= method[0].toUpperCase() + method.slice(1) %>(async (<% if (method === "get" || method === "delete") { %>{ params }<% } else { %>{ request, params }<% } %>: RequestEvent) => {<% if (method === "get") { %>
   return Response.json({ ok: true, params }, { headers: { "cache-control": "no-store" } });<% } else if (method === "delete") { %>
   console.log("delete", params);
   return new Response(null, { status: 204 });<% } else { %>
   const body: unknown = await request.json().catch(() => null);
   return Response.json({ ok: true, params, body }<% if (method === "post") { %>, { status: 201 }<% } %>);<% } %>
-};
+});
 <% } %>

package/generators/api-route/schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/schema",
   "$id": "RivetApiRoute",
   "title": "Rivet API route",
-  "description": "Adds an endpoint route (a plain .ts file in src/routes with onGet / onPost / … request handlers) to a server-rendered Rivet app.",
+  "description": "Adds an endpoint route (a plain .ts file in src/routes with onGet(…) / onPost(…) / … request handler exports) to a server-rendered Rivet app.",
   "type": "object",
   "properties": {
     "path": {

package/generators/layout/files/_layout.tsx.template

@@ -1,9 +1,9 @@
-<% if (guard) { %>import { redirect, type LayoutProps, type RequestEvent } from "@rivetjs/router";
+<% if (guard) { %>import { guard, redirect, type LayoutProps, type RequestEvent } from "@rivetjs/router";
 
 /** Runs for every page and endpoint in this folder, before their loaders. */
-export const serverGuard = ({ cookies, url }: RequestEvent) => {
+export const access = guard(({ cookies, url }: RequestEvent) => {
   if (!cookies.get("session")) return redirect("/login?next=" + encodeURIComponent(url.pathname));
-};
+});
 <% } else { %>import type { LayoutProps } from "@rivetjs/router";
 <% } %>
 /** Wraps every page in <%= where %>. Stays mounted across client navigation between them. */

package/generators/layout/schema.d.ts

@@ -3,7 +3,7 @@ export interface LayoutGeneratorSchema {
   directory?: string;
   /** The Rivet app. */
   project: string;
-  /** `serverGuard` for the whole folder (redirects to /login without a `session` cookie). */
+  /** A `guard(…)` export for the whole folder (redirects to /login without a `session` cookie). */
   guard?: boolean;
   skipFormat?: boolean;
 }

package/generators/layout/schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/schema",
   "$id": "RivetLayout",
   "title": "Rivet layout",
-  "description": "Adds a _layout.tsx to a folder of a Rivet app's routes (the root layout without a directory), optionally with a serverGuard for everything below it.",
+  "description": "Adds a _layout.tsx to a folder of a Rivet app's routes (the root layout without a directory), optionally with a guard(…) export for everything below it.",
   "type": "object",
   "properties": {
     "directory": {
@@ -18,7 +18,7 @@
       "x-dropdown": "projects",
       "x-prompt": "Which project?"
     },
-    "guard": { "type": "boolean", "default": false, "description": "Add a serverGuard for the whole folder." },
+    "guard": { "type": "boolean", "default": false, "description": "Add a guard(…) export for the whole folder." },
     "skipFormat": { "type": "boolean", "default": false, "x-priority": "internal", "description": "Skip formatting files." }
   },
   "required": ["project"],

package/generators/route/files/__fileName__.tsx.template

@@ -1,19 +1,19 @@
 <% if (routerImports.length) { %>import { <%- routerImports.join(", ") %> } from "@rivetjs/router";
 <% } %><% if (guard) { %>
 /** Runs on the server before the loader. Return `redirect()`, `deny()` or `notFound()` to stop the request. */
-export const serverGuard = ({ url }: RequestEvent) => {
+export const access = guard(({ url }: RequestEvent) => {
   if (url.searchParams.has("deny")) return deny();
-};
+});
 <% } %><% if (entries) { %>
 /** Parameter values to prerender (static mode): one page per entry. */
-export const serverEntries = () => [<%- entries %>];
+export const paths = entries(() => [<%- entries %>]);
 <% } %><% if (loader) { %>
 /** Data for the page, loaded on the server; removed from the browser build with everything only it uses. */
-export const serverLoad = (<% if (params.length) { %>{ params }<% } else { %>_event<% } %>: RequestEvent) => ({
+export const loader = load((<% if (params.length) { %>{ params }<% } else { %>_event<% } %>: RequestEvent) => ({
   title: <%- loaderTitle %>,
-});
+}));
 <% } %><% if (action) { %>
-export const serverActions = {
+export const forms = actions({
   /** Handles `<form method="post" action="?/save">`. Works without JavaScript. */
   save: async ({ request, url }: RequestEvent) => {
     const text = String((await request.formData()).get("text") ?? "").trim();
@@ -21,7 +21,7 @@ export const serverActions = {
     // Post/redirect/get: reloading the page does not submit the form again.
     return redirect(url.pathname, 303);
   },
-};
+});
 <% } %>
 export const head = { title: "<%= title %>" };
 

package/generators/route/generator.d.ts

@@ -2,7 +2,7 @@ import { type Tree } from "@nx/devkit";
 import { routeParams } from "../../utils/project.js";
 import type { RouteGeneratorSchema } from "./schema.js";
 export type { RouteGeneratorSchema } from "./schema.js";
-/** Sample `serverEntries` value of a route's params (`{ slug: "example" }`), or undefined without required params. */
+/** Sample `entries(…)` value of a route's params (`{ slug: "example" }`), or undefined without required params. */
 export declare function sampleEntry(params: ReturnType<typeof routeParams>): string | undefined;
 /** The URL pattern of route segments (`/blog/:slug`). */
 export declare function routeUrl(segments: string[]): string;

package/generators/route/generator.js

@@ -4,7 +4,7 @@ import { formatFiles, generateFiles, joinPathFragments } from "@nx/devkit";
 import { routeComponentName, routedApp, routeParams, routeSegments } from "../../utils/project.js";
 import { layoutGenerator } from "../layout/generator.js";
 const FILES = fileURLToPath(new URL("./files", import.meta.url));
-/** Sample `serverEntries` value of a route's params (`{ slug: "example" }`), or undefined without required params. */
+/** Sample `entries(…)` value of a route's params (`{ slug: "example" }`), or undefined without required params. */
 export function sampleEntry(params) {
     const required = params.filter((param) => param.kind !== "optional");
     if (!required.length)
@@ -26,7 +26,7 @@ export async function routeGenerator(tree, options) {
     const segments = routeSegments(options.path);
     const params = routeParams(segments);
     if (options.action && project.facts?.static)
-        throw new Error('route: serverActions need a server; this app is prerendered (rivetRouter({ mode: "static" }))');
+        throw new Error('route: actions(…) need a server; this app is prerendered (rivetRouter({ mode: "static" }))');
     const index = !segments.length || /^\(.*\)$/.test(segments.at(-1)) || /(^|\/)index(\.\w+)?\/?$/.test(options.path) || options.path.endsWith("/");
     const folder = joinPathFragments(project.routes, ...(index ? segments : segments.slice(0, -1)));
     const fileName = index ? "index" : segments.at(-1);
@@ -37,7 +37,12 @@ export async function routeGenerator(tree, options) {
     const name = routeComponentName(segments.filter((segment) => !/^\(.*\)$/.test(segment)));
     const title = name.replace(/([a-z0-9])([A-Z])/g, "$1 $2");
     const first = params[0];
+    const entries = project.facts?.static ? (sampleEntry(params) ?? "") : "";
     const routerImports = [
+        ...(options.guard ? ["guard"] : []),
+        ...(entries ? ["entries"] : []),
+        ...(options.loader ? ["load"] : []),
+        ...(options.action ? ["actions"] : []),
         ...(options.guard ? ["deny"] : []),
         ...(options.action ? ["redirect"] : []),
         ...(options.loader || params.length ? ["type PageProps"] : []),
@@ -54,9 +59,9 @@ export async function routeGenerator(tree, options) {
         loader: Boolean(options.loader),
         action: Boolean(options.action),
         params,
-        entries: project.facts?.static ? (sampleEntry(params) ?? "") : "",
+        entries,
         loaderTitle: first ? `\`${title}: \${params.${first.name} ?? ""}\`` : JSON.stringify(title),
-        props: props.length ? `{ ${props.join(", ")} }: PageProps${options.loader ? "<typeof serverLoad>" : ""}` : "",
+        props: props.length ? `{ ${props.join(", ")} }: PageProps${options.loader ? "<typeof loader>" : ""}` : "",
     });
     if (options.layout && !tree.exists(joinPathFragments(folder, "_layout.tsx"))) {
         await layoutGenerator(tree, { project: options.project, directory: folder.slice(project.routes.length + 1), skipFormat: true });

package/generators/route/schema.d.ts

@@ -3,11 +3,11 @@ export interface RouteGeneratorSchema {
   path: string;
   /** The Rivet app. */
   project: string;
-  /** `serverLoad` + typed `data` prop. */
+  /** A `load(…)` export (`loader`) + typed `data` prop. */
   loader?: boolean;
-  /** `serverActions` + a progressive-enhancement form (node adapter only). */
+  /** An `actions(…)` export (`forms`) + a progressive-enhancement form (node adapter only). */
   action?: boolean;
-  /** `serverGuard`. */
+  /** A `guard(…)` export (`access`). */
   guard?: boolean;
   /** Also create a `_layout.tsx` in the route's folder (when it has none). */
   layout?: boolean;

package/generators/route/schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/schema",
   "$id": "RivetRoute",
   "title": "Rivet route",
-  "description": "Adds a file route (page) to a Rivet app: dynamic segments ([param], [[optional]], [...rest]), groups ((name)), optional serverLoad / serverActions / serverGuard and a folder layout.",
+  "description": "Adds a file route (page) to a Rivet app: dynamic segments ([param], [[optional]], [...rest]), groups ((name)), optional load(…) / actions(…) / guard(…) exports and a folder layout.",
   "type": "object",
   "properties": {
     "path": {
@@ -18,9 +18,9 @@
       "x-dropdown": "projects",
       "x-prompt": "Which project?"
     },
-    "loader": { "type": "boolean", "default": false, "description": "Add serverLoad and a typed data prop." },
-    "action": { "type": "boolean", "default": false, "description": "Add serverActions and a form that posts to it (node adapter only)." },
-    "guard": { "type": "boolean", "default": false, "description": "Add serverGuard." },
+    "loader": { "type": "boolean", "default": false, "description": "Add a load(…) export and a typed data prop." },
+    "action": { "type": "boolean", "default": false, "description": "Add an actions(…) export and a form that posts to it (node adapter only)." },
+    "guard": { "type": "boolean", "default": false, "description": "Add a guard(…) export." },
     "layout": { "type": "boolean", "default": false, "description": "Also create _layout.tsx in the route's folder (when it has none)." },
     "skipFormat": { "type": "boolean", "default": false, "x-priority": "internal", "description": "Skip formatting files." }
   },

package/generators.json

@@ -39,18 +39,18 @@
       "factory": "./generators/route/generator",
       "schema": "./generators/route/schema.json",
       "aliases": ["r", "page"],
-      "description": "Add a file route: dynamic segments, serverLoad, serverActions, serverGuard, folder layout."
+      "description": "Add a file route: dynamic segments, load(…) / actions(…) / guard(…) exports, folder layout."
     },
     "layout": {
       "factory": "./generators/layout/generator",
       "schema": "./generators/layout/schema.json",
-      "description": "Add a _layout.tsx to a routes folder (optional serverGuard)."
+      "description": "Add a _layout.tsx to a routes folder (optional guard(…) export)."
     },
     "api-route": {
       "factory": "./generators/api-route/generator",
       "schema": "./generators/api-route/schema.json",
       "aliases": ["endpoint"],
-      "description": "Add an endpoint route (onGet / onPost / … request handlers)."
+      "description": "Add an endpoint route (onGet(…) / onPost(…) / … request handler exports)."
     },
     "ui-setup": {
       "factory": "./generators/ui-setup/generator",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivetjs/nx",
-  "version": "0.1.0-alpha.0",
+  "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.0"
+    "create-rivet": "0.1.0-alpha.2"
   },
   "peerDependencies": {
     "nx": ">=23 <24"