@solid-tui/testing 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yunfei He
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+# @solid-tui/testing
+
+Test utilities for Solid terminal components built with `@solid-tui/runtime`.
+
+## Install
+
+```sh
+npm install -D @solid-tui/testing
+```
+
+## Usage
+
+Use the helpers in this package to render terminal components against fake
+streams and assert on the resulting terminal output.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,43 @@
+import { Component } from "@solid-tui/runtime";
+
+//#region src/streams.d.ts
+interface RawModeState {
+  readonly current: boolean;
+  readonly history: readonly boolean[];
+}
+//#endregion
+//#region src/render.d.ts
+interface RenderOptions {
+  columns?: number;
+  rows?: number;
+  props?: Record<string, unknown>;
+  exitOnCtrlC?: boolean;
+  interactive?: boolean;
+}
+interface Terminal {
+  readonly columns: number;
+  readonly rows: number;
+  resize(columns: number, rows: number): Promise<void>;
+  rawMode: RawModeState;
+}
+interface LastFrameOptions {
+  raw?: boolean;
+  trimLines?: boolean;
+}
+interface RenderResult {
+  lastFrame(this: void, opts?: LastFrameOptions): string | undefined;
+  frames: string[];
+  stdin: {
+    write(data: string): Promise<void>;
+  };
+  terminal: Terminal;
+  unmount(this: void): void;
+  waitUntilExit(this: void): Promise<unknown>;
+  waitUntilRenderFlush(this: void): Promise<void>;
+}
+declare function render(component: Component<Record<string, unknown>>, options?: RenderOptions): Promise<RenderResult>;
+//#endregion
+//#region src/cleanup.d.ts
+declare function cleanup(): void;
+//#endregion
+export { type RawModeState, type RenderOptions, type RenderResult, type Terminal, cleanup, render };

package/dist/index.mjs

@@ -0,0 +1,118 @@
+import { createApp } from "@solid-tui/runtime";
+import { INTERNAL_FRAME_SINK } from "@solid-tui/runtime/internal";
+import { PassThrough } from "node:stream";
+//#region src/streams.ts
+function makeFakeWritable(options = {}) {
+	const s = new PassThrough();
+	Object.assign(s, {
+		columns: options.columns ?? 100,
+		rows: options.rows ?? 100,
+		isTTY: true
+	});
+	return s;
+}
+function makeFakeStdin() {
+	const rawMode = {
+		current: false,
+		history: []
+	};
+	const s = new PassThrough();
+	Object.assign(s, {
+		isTTY: true,
+		setRawMode(mode) {
+			rawMode.current = mode;
+			rawMode.history.push(mode);
+			return this;
+		},
+		setEncoding() {
+			return this;
+		}
+	});
+	s.ref = () => {};
+	s.unref = () => {};
+	return {
+		stream: s,
+		rawMode
+	};
+}
+//#endregion
+//#region src/cleanup.ts
+const activeApps = [];
+function trackApp(app) {
+	activeApps.push(app);
+}
+function cleanup() {
+	for (const app of activeApps) app.unmount();
+	activeApps.length = 0;
+}
+if (typeof afterEach === "function") afterEach(() => cleanup());
+//#endregion
+//#region src/render.ts
+function trimFrame(raw) {
+	return raw.split("\n").map((line) => line.trimEnd()).join("\n").trimEnd();
+}
+async function render(component, options = {}) {
+	const stdout = makeFakeWritable({
+		columns: options.columns ?? 100,
+		rows: options.rows ?? 100
+	});
+	const stderr = makeFakeWritable({
+		columns: options.columns ?? 100,
+		rows: options.rows ?? 100
+	});
+	const { stream: stdin, rawMode } = makeFakeStdin();
+	const frames = [];
+	const frameSink = (chunk) => {
+		frames.push(chunk);
+	};
+	const app = createApp(component, options.props ?? void 0);
+	app.mount({
+		stdout,
+		stdin,
+		stderr,
+		debug: true,
+		interactive: options.interactive ?? true,
+		exitOnCtrlC: options.exitOnCtrlC ?? false,
+		[INTERNAL_FRAME_SINK]: frameSink
+	});
+	trackApp(app);
+	await app.waitUntilRenderFlush();
+	await Promise.resolve();
+	await new Promise((resolve) => setImmediate(resolve));
+	return {
+		lastFrame: (opts) => {
+			const f = frames.at(-1) ?? "";
+			if (opts?.raw) return f;
+			if (opts?.trimLines) return f.split("\n").map((l) => l.trimEnd()).join("\n");
+			return trimFrame(f);
+		},
+		frames,
+		stdin: { async write(data) {
+			stdin.emit("data", data);
+			await new Promise((r) => setTimeout(r, 30));
+			await app.waitUntilRenderFlush();
+		} },
+		terminal: {
+			get columns() {
+				return stdout.columns;
+			},
+			get rows() {
+				return stdout.rows;
+			},
+			async resize(columns, rows) {
+				stdout.columns = columns;
+				stdout.rows = rows;
+				stderr.columns = columns;
+				stderr.rows = rows;
+				stdout.emit("resize");
+				await app.waitUntilRenderFlush();
+			},
+			rawMode
+		},
+		unmount: app.unmount.bind(app),
+		waitUntilExit: app.waitUntilExit.bind(app),
+		waitUntilRenderFlush: app.waitUntilRenderFlush.bind(app)
+	};
+}
+//#endregion
+export { cleanup, render };

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@solid-tui/testing",
+  "version": "0.1.0",
+  "description": "Test utilities for Solid terminal components.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/solidjs-ai/solid-tui.git",
+    "directory": "packages/testing"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@solid-tui/runtime": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.12.4",
+    "solid-js": "^1.9.14",
+    "typescript": "^5",
+    "vite-plus": "^0.1.22"
+  },
+  "peerDependencies": {
+    "solid-js": "^1.9.0"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "dev": "vp pack --watch",
+    "test": "vp test --passWithNoTests",
+    "check:type": "tsc --noEmit"
+  }
+}