@zenbu-labs/pixel 0.2.0 → 0.2.2

package/dist/bin.js

@@ -95,15 +95,12 @@ async function main() {
     const tty = process.env.PIXEL_TTY ?? ownTty();
     const owner = (0, instances_1.findOwner)(tty);
     const announced = owner ? (0, instances_1.announceGuest)(owner, appName(appDir(entry))) : null;
+    let unsupported = false;
     if (!owner && !process.env.PIXEL_EMBED) {
         if (!process.stdin.isTTY || !process.stdout.isTTY) {
             fail("tty required");
         }
-        const check = await (0, terminal_1.checkTerminal)((0, terminal_1.detect)());
-        if (check.graphics === "unsupported") {
-            process.stderr.write((0, terminal_1.unsupportedGraphicsMessage)(process.stderr.isTTY === true));
-            return 1;
-        }
+        unsupported = (await (0, terminal_1.checkTerminal)((0, terminal_1.detect)())).graphics === "unsupported";
     }
     const electron = electronBinary();
     const chromiumArgs = [];
@@ -125,6 +122,10 @@ async function main() {
     const env = { ...process.env };
     delete env.ELECTRON_RUN_AS_NODE;
     env.PIXEL_TTY = tty;
+    if (unsupported)
+        env[terminal_1.UNSUPPORTED_ENV] = "1";
+    else
+        delete env[terminal_1.UNSUPPORTED_ENV];
     if (announced)
         env.PIXEL_PANE = announced.pane;
     else

package/dist/root.d.ts

@@ -1,11 +1,13 @@
 import type { ReactNode } from "react";
 import type { EngineKeyEvent, PixelRoot, RootOptions as EngineRootOptions } from "./react";
 import type { WebViewHandle, WebViewProps } from "./webview";
+import type { Terminal } from "./terminal";
 export interface RootOptions extends Omit<EngineRootOptions, "keyEventTypes" | "onKey" | "onEngineExit" | "onLayout" | "host" | "onHostClosed" | "onHandoff"> {
     name?: string;
     onKey?: (event: EngineKeyEvent) => boolean | void;
     onQuit?: (view: WebViewHandle | null) => void;
     onExit?: (code: number) => void;
+    onUnsupportedTerminal?: (terminal: Terminal | null) => string;
 }
 export type LoadOptions = Omit<WebViewProps, "src" | "style" | "hidden" | "autoFocus">;
 export interface Root extends Omit<PixelRoot, "render" | "flushSync" | "stop" | "retarget"> {

package/dist/root.js

@@ -66,6 +66,12 @@ function createRoot(options = {}) {
     }
     const env = options.sessionEnv ?? process.env;
     const terminal = (0, terminal_1.detect)(env);
+    if (env[terminal_1.UNSUPPORTED_ENV]) {
+        const message = options.onUnsupportedTerminal?.(terminal) ?? "pixel: this terminal doesn't support graphics\n";
+        node_fs_1.default.writeSync(1, message);
+        electron_1.app.exit(1);
+        throw new Error("this terminal doesn't support graphics");
+    }
     const tty = options.tty ?? env.PIXEL_TTY ?? ownTty();
     const embed = env.PIXEL_EMBED ?? null;
     let owner = tty && !embed ? (0, instances_1.findOwner)(tty) : null;

package/dist/terminal/graphics.d.ts

@@ -1,9 +1,9 @@
 import type { Terminal } from "./terminal";
 export type GraphicsSupport = "supported" | "unsupported" | "unknown";
 export declare const SKIP_ENV = "PIXEL_SKIP_GRAPHICS_CHECK";
+export declare const UNSUPPORTED_ENV = "PIXEL_UNSUPPORTED_TERMINAL";
 export declare function probeGraphics(terminal: Terminal | null): Promise<GraphicsSupport>;
 export declare function panePixels(): Promise<{
     width: number;
     height: number;
 } | null>;
-export declare function unsupportedGraphicsMessage(color?: boolean): string;

package/dist/terminal/graphics.js

@@ -3,12 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SKIP_ENV = void 0;
+exports.UNSUPPORTED_ENV = exports.SKIP_ENV = void 0;
 exports.probeGraphics = probeGraphics;
 exports.panePixels = panePixels;
-exports.unsupportedGraphicsMessage = unsupportedGraphicsMessage;
 const node_fs_1 = __importDefault(require("node:fs"));
 exports.SKIP_ENV = "PIXEL_SKIP_GRAPHICS_CHECK";
+exports.UNSUPPORTED_ENV = "PIXEL_UNSUPPORTED_TERMINAL";
 const PROBE_ID = 4207;
 const PROBE_TIMEOUT_MS = 500;
 function passthrough(seq) {
@@ -28,6 +28,14 @@ function graphicsReply(buffer) {
         return null;
     return rest.startsWith("OK");
 }
+const SAVE_CURSOR = "\x1b7";
+// Terminals without graphics support may print the probe's payload as plain text.
+function eraseEchoedProbe() {
+    try {
+        node_fs_1.default.writeSync(1, "\x1b8\x1b[J");
+    }
+    catch { }
+}
 function probeGraphics(terminal) {
     const stdin = process.stdin;
     if (!stdin.isTTY || !process.stdout.isTTY || !stdin.setRawMode) {
@@ -52,6 +60,8 @@ function probeGraphics(terminal) {
             catch { }
             if (!stdin.isPaused())
                 stdin.pause();
+            if (graphics !== "supported")
+                eraseEchoedProbe();
             resolve(graphics);
         };
         const onData = (chunk) => {
@@ -72,7 +82,7 @@ function probeGraphics(terminal) {
         stdin.on("data", onData);
         timer = setTimeout(() => finish("unknown"), PROBE_TIMEOUT_MS);
         try {
-            node_fs_1.default.writeSync(1, probeSequence(terminal?.wrapper === "tmux"));
+            node_fs_1.default.writeSync(1, `${SAVE_CURSOR}${probeSequence(terminal?.wrapper === "tmux")}`);
         }
         catch {
             finish("unknown");
@@ -127,16 +137,3 @@ function panePixels() {
         }
     });
 }
-function unsupportedGraphicsMessage(color = false) {
-    const sgr = (code, text) => (color ? `\x1b[${code}m${text}\x1b[0m` : text);
-    return [
-        "",
-        `  ${sgr("1", "Unsupported terminal: this terminal cannot display graphics")}`,
-        "",
-        `  ${sgr("2", "We recommend Ghostty:")}`,
-        `  ${sgr("4", "https://ghostty.org/download")}`,
-        "",
-        `  ${sgr("2", "Note: any terminal that supports the kitty graphics protocol is supported")}`,
-        "",
-    ].join("\n");
-}

package/dist/terminal/index.d.ts

@@ -9,4 +9,4 @@ export { cannotOpenPanes, checkTerminal, detect } from "./detect";
 export type { GraphicsSupport } from "./graphics";
 export type { Instance } from "../instances";
 export { findOwner, listInstances, PROTOCOL as EMBED_PROTOCOL } from "../instances";
-export { probeGraphics, unsupportedGraphicsMessage, SKIP_ENV as GRAPHICS_SKIP_ENV } from "./graphics";
+export { probeGraphics, SKIP_ENV as GRAPHICS_SKIP_ENV, UNSUPPORTED_ENV } from "./graphics";

package/dist/terminal/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GRAPHICS_SKIP_ENV = exports.unsupportedGraphicsMessage = exports.probeGraphics = exports.EMBED_PROTOCOL = exports.listInstances = exports.findOwner = exports.detect = exports.checkTerminal = exports.cannotOpenPanes = exports.shellLiteral = exports.PASTE_KEY = exports.callerTty = exports.bracketedPaste = exports.shellIn = exports.canSplit = void 0;
+exports.UNSUPPORTED_ENV = exports.GRAPHICS_SKIP_ENV = exports.probeGraphics = exports.EMBED_PROTOCOL = exports.listInstances = exports.findOwner = exports.detect = exports.checkTerminal = exports.cannotOpenPanes = exports.shellLiteral = exports.PASTE_KEY = exports.callerTty = exports.bracketedPaste = exports.shellIn = exports.canSplit = void 0;
 var terminal_1 = require("./terminal");
 Object.defineProperty(exports, "canSplit", { enumerable: true, get: function () { return terminal_1.canSplit; } });
 var run_1 = require("./run");
@@ -20,5 +20,5 @@ Object.defineProperty(exports, "listInstances", { enumerable: true, get: functio
 Object.defineProperty(exports, "EMBED_PROTOCOL", { enumerable: true, get: function () { return instances_1.PROTOCOL; } });
 var graphics_1 = require("./graphics");
 Object.defineProperty(exports, "probeGraphics", { enumerable: true, get: function () { return graphics_1.probeGraphics; } });
-Object.defineProperty(exports, "unsupportedGraphicsMessage", { enumerable: true, get: function () { return graphics_1.unsupportedGraphicsMessage; } });
 Object.defineProperty(exports, "GRAPHICS_SKIP_ENV", { enumerable: true, get: function () { return graphics_1.SKIP_ENV; } });
+Object.defineProperty(exports, "UNSUPPORTED_ENV", { enumerable: true, get: function () { return graphics_1.UNSUPPORTED_ENV; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenbu-labs/pixel",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Build graphical applications in the terminal",
   "license": "MIT",
   "repository": {
@@ -58,10 +58,10 @@
     "react": "^18.3.1"
   },
   "optionalDependencies": {
-    "@zenbu-labs/pixel-native-darwin-arm64": "0.2.0",
-    "@zenbu-labs/pixel-native-darwin-x64": "0.2.0",
-    "@zenbu-labs/pixel-native-linux-arm64": "0.2.0",
-    "@zenbu-labs/pixel-native-linux-x64": "0.2.0"
+    "@zenbu-labs/pixel-native-darwin-arm64": "0.2.2",
+    "@zenbu-labs/pixel-native-darwin-x64": "0.2.2",
+    "@zenbu-labs/pixel-native-linux-arm64": "0.2.2",
+    "@zenbu-labs/pixel-native-linux-x64": "0.2.2"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",