feat(node): add Bun support in runtime, CI, and docs

Author: RtlZeroMemory

.github/workflows/ci.yml

@@ -109,6 +109,49 @@ jobs:
         if: runner.os == 'Windows'
         run: npm run test:native:smoke
 
+  bun:
+    name: bun / ubuntu-latest
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout (with submodules)
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: "1.3.9"
+
+      - name: Install
+        run: bun install
+
+      - name: Lint
+        run: bun run lint
+
+      - name: Typecheck
+        run: bun run typecheck
+
+      - name: Build
+        run: bun run build
+
+      - name: Check core portability
+        run: bun run check:core-portability
+
+      - name: Check Unicode pins (submodule sync)
+        run: bun run check:unicode
+
+      - name: Tests
+        run: bun run test
+
+      - name: Terminal e2e (reduced)
+        run: bun run test:e2e:reduced
+
   docs:
     name: docs
     runs-on: ubuntu-latest

README.md

@@ -7,7 +7,7 @@
 
 > **Alpha** — under active development; APIs may change between releases.
 
-Rezi is a TypeScript/Node.js terminal UI framework with a native rendering engine (Zireael).
+Rezi is a TypeScript terminal UI framework for Node.js and Bun, with a native rendering engine (Zireael).
 You build UIs in TypeScript while Rezi emits compact drawlists and delegates terminal diff/present to native code.
 
 In our terminal benchmark suite (`120x40`, PTY mode), Rezi is consistently in the same performance class as native TUIs: slightly slower than ratatui (Rust) by a low single-digit multiplier, while remaining substantially faster than classic JS TUI stacks in the same scenarios.
@@ -69,6 +69,8 @@ await app.start();
 
 ```bash
 npm install @rezi-ui/jsx @rezi-ui/core @rezi-ui/node
+# or
+bun add @rezi-ui/jsx @rezi-ui/core @rezi-ui/node
 ```
 
 ### 2) Native `ui.*` API
@@ -100,6 +102,8 @@ await app.start();
 
 ```bash
 npm install @rezi-ui/core @rezi-ui/node
+# or
+bun add @rezi-ui/core @rezi-ui/node
 ```
 
 ## Performance overview
@@ -144,9 +148,9 @@ flowchart TB
 - Widget primitives: box/row/column, text, input, buttons, focus/keyboard handling
 - Higher-level widgets: tables, virtual lists, code editor, diff viewer, file picker, command palette
 - Protocols: ZRDL (drawlists) and ZREV (event batches)
-- Backends: Node worker/inline execution modes, native addon integration
+- Backends: Node/Bun worker/inline execution modes, native addon integration
 
-Node.js 18+ required (18.18+ recommended). Prebuilt native binaries are published for Linux, macOS, and Windows (x64/arm64).
+Node.js 18+ (18.18+ recommended) or Bun 1.3+ required. Prebuilt native binaries are published for Linux, macOS, and Windows (x64/arm64).
 
 ## Packages
 
@@ -167,6 +171,12 @@ cd my-app
 npm start
 ```
 
+```bash
+bun create rezi my-app
+cd my-app
+bun start
+```
+
 Templates: `dashboard`, `form-app`, `file-browser`, `streaming-viewer`.
 
 ## Documentation

docs/getting-started/faq.md

@@ -4,7 +4,7 @@
 
 ### What is Rezi?
 
-Rezi is a code-first terminal UI framework for Node.js. It provides a declarative widget API for building rich terminal applications with features like automatic focus management, theming, and keyboard navigation.
+Rezi is a code-first terminal UI framework for Node.js and Bun. It provides a declarative widget API for building rich terminal applications with features like automatic focus management, theming, and keyboard navigation.
 
 ### Is Rezi like React for the terminal?
 
@@ -27,9 +27,12 @@ Rezi supports:
 
 Prebuilt native binaries are included for all supported platforms.
 
-### What Node.js versions are supported?
+### What runtime versions are supported?
 
-Rezi requires Node.js 18 or later (18.18+ recommended).
+Rezi supports:
+
+- Node.js 18+ (18.18+ recommended)
+- Bun 1.3+
 
 ## Architecture
 
@@ -48,7 +51,7 @@ This architecture enables high performance while keeping the TypeScript code por
 
 `@rezi-ui/core` is runtime-agnostic by design. It contains no Node.js-specific APIs (no `Buffer`, `worker_threads`, `fs`, etc.).
 
-The Node.js integration is provided by `@rezi-ui/node`. Additional backends for other runtimes (Deno, Bun, etc.) could be implemented using the same core package.
+Node.js and Bun integration is provided by `@rezi-ui/node`. Additional backends for other runtimes (for example Deno) could be implemented using the same core package.
 
 ### What is the binary protocol?
 

docs/getting-started/install.md

@@ -4,7 +4,7 @@ Install Rezi packages from npm to start building terminal applications.
 
 ## Requirements
 
-- **Node.js**: 18.18.0 or later
+- **Runtime**: Node.js 18.18.0+ or Bun 1.3.0+
 - **Operating System**: Linux, macOS, or Windows
 - **Terminal**: Any terminal emulator with 256-color or true-color support
 
@@ -63,7 +63,7 @@ If a prebuilt binary is not available for your platform, the package will attemp
 | Package | Description | Required |
 |---------|-------------|----------|
 | `@rezi-ui/core` | Widgets, layout, themes, forms, keybindings | Yes |
-| `@rezi-ui/node` | Node.js backend with native rendering | Yes |
+| `@rezi-ui/node` | Node.js/Bun backend with native rendering | Yes |
 | `@rezi-ui/testkit` | Testing utilities and fixtures | Optional |
 
 ## Optional packages
@@ -164,6 +164,12 @@ Run with:
 npx tsx test.ts
 ```
 
+Or with Bun:
+
+```bash
+bun run test.ts
+```
+
 You should see "Rezi is working!" displayed in your terminal.
 
 ## Building from Source

docs/getting-started/quickstart.md

@@ -12,6 +12,14 @@ cd my-tui-app
 npm start
 ```
 
+With Bun:
+
+```bash
+bun create rezi my-tui-app
+cd my-tui-app
+bun start
+```
+
 Select a template when prompted (dashboard, form-app, file-browser, or streaming-viewer), or pass `--template` to choose directly:
 
 ```bash
@@ -26,6 +34,15 @@ npm init -y
 npm install @rezi-ui/core @rezi-ui/node typescript tsx
 ```
 
+With Bun:
+
+```bash
+mkdir my-tui-app && cd my-tui-app
+bun init -y
+bun add @rezi-ui/core @rezi-ui/node
+bun add -d typescript tsx
+```
+
 ## Minimal Example
 
 Create `index.ts`:
@@ -77,6 +94,12 @@ Run with:
 npx tsx index.ts
 ```
 
+Or with Bun:
+
+```bash
+bun run index.ts
+```
+
 You should see a counter UI. Use Tab to navigate between buttons, Enter to activate them, and 'q' to quit. You can also click the buttons with the mouse if your terminal supports mouse tracking.
 
 ## Understanding the Code
@@ -91,7 +114,7 @@ const app = createApp<State>({
 ```
 
 - `createApp<State>` creates a typed application instance
-- `backend` specifies the rendering backend (Node.js in this case)
+- `backend` specifies the rendering backend (`@rezi-ui/node` for Node.js and Bun)
 - `initialState` provides the initial application state
 
 ### Defining the View

docs/packages/index.md

@@ -24,7 +24,7 @@ flowchart TB
 | Package | Description | npm |
 |---------|-------------|-----|
 | [@rezi-ui/core](core.md) | Widgets, layout, themes, forms, keybindings | `npm i @rezi-ui/core` |
-| [@rezi-ui/node](node.md) | Node.js backend with worker threads | `npm i @rezi-ui/node` |
+| [@rezi-ui/node](node.md) | Node.js/Bun backend with worker threads | `npm i @rezi-ui/node` |
 | [@rezi-ui/native](native.md) | Native addon (napi-rs + Zireael) | Bundled with node |
 | [@rezi-ui/jsx](jsx.md) | JSX runtime for Rezi widgets | `npm i @rezi-ui/jsx` |
 | [@rezi-ui/testkit](testkit.md) | Testing utilities and fixtures | `npm i -D @rezi-ui/testkit` |
@@ -54,9 +54,9 @@ import { createApp, ui, rgb, darkTheme } from "@rezi-ui/core";
 
 ## @rezi-ui/node
 
-**Node.js runtime backend**
+**Node.js/Bun runtime backend**
 
-The Node.js backend provides the runtime integration:
+The `@rezi-ui/node` backend provides the runtime integration:
 
 - Worker thread management for async rendering
 - Event loop integration

docs/packages/node.md

@@ -1,6 +1,6 @@
 # `@rezi-ui/node`
 
-Node backend package:
+Node/Bun backend package:
 
 - worker-thread engine ownership
 - transfer of drawlists/events between core and native
@@ -10,6 +10,8 @@ Node backend package:
 
 ```bash
 npm i @rezi-ui/node
+# or
+bun add @rezi-ui/node
 ```
 
 ## What you get
@@ -29,7 +31,7 @@ const backend = createNodeBackend({
 });
 ```
 
-Pass the backend into `createApp` from `@rezi-ui/core`.
+Pass the backend into `createApp` from `@rezi-ui/core`. This backend is supported in Node.js and Bun runtimes.
 
 ## Native engine config passthrough
 

mkdocs.yml

@@ -58,6 +58,9 @@ markdown_extensions:
   - tables
   - def_list
   - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span

packages/node/README.md

@@ -1,6 +1,6 @@
 # @rezi-ui/node
 
-Node.js backend for Rezi. This package owns:
+Node.js/Bun backend for Rezi. This package owns:
 
 - worker-thread engine ownership (native engine is never called on the main thread)
 - frame scheduling and buffer pooling
@@ -13,5 +13,12 @@ import { createApp, ui } from "@rezi-ui/core";
 import { createNodeBackend } from "@rezi-ui/node";
 ```
 
-Docs: `https://rtlzeromemory.github.io/Rezi/`
+Install:
+
+```bash
+npm i @rezi-ui/node
+# or
+bun add @rezi-ui/node
+```
 
+Docs: `https://rtlzeromemory.github.io/Rezi/`

packages/node/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rezi-ui/node",
   "version": "0.1.0-alpha.0",
-  "description": "Node.js backend for Rezi (worker-thread engine ownership, scheduling, IO).",
+  "description": "Node.js/Bun backend for Rezi (worker-thread engine ownership, scheduling, IO).",
   "license": "Apache-2.0",
   "homepage": "https://rtlzeromemory.github.io/Rezi/",
   "repository": {
@@ -22,7 +22,8 @@
   },
   "files": ["dist/", "README.md"],
   "engines": {
-    "node": ">=18"
+    "node": ">=18",
+    "bun": ">=1.3.0"
   },
   "dependencies": {
     "@rezi-ui/core": "0.1.0-alpha.0",