@textui/terminal 0.3.0 → 0.5.0

package/dist/writer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../src/writer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAO,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AA8BzD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB,CAAC,YAAY,CAAC,GAAG,MAAM,CAU3F;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB,CAAC,YAAY,CAAC,GAAG,MAAM,CAU3F;AAED,eAAO,MAAM,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EASrC,CAAC;AAMF,qBAAa,MAAM;IAGL,OAAO,CAAC,YAAY;IAFhC,OAAO,CAAC,KAAK,CAAgB;gBAET,YAAY,EAAE,oBAAoB;IAEtD,eAAe,CAAC,YAAY,EAAE,oBAAoB,GAAG,IAAI;IAKzD,yEAAyE;IACzE,UAAU,IAAI,IAAI;IAIlB,oEAAoE;IACpE,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM;IA8B3B,OAAO,CAAC,SAAS;IA0BjB,OAAO,CAAC,WAAW;CA6CpB;AAYD,wBAAgB,YAAY,CAAC,YAAY,EAAE,oBAAoB,GAAG,MAAM,CAEvE"}
+{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../src/writer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAO,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AA0CzD,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB,CAAC,YAAY,CAAC,GAAG,MAAM,CAU3F;AAED,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB,CAAC,YAAY,CAAC,GAAG,MAAM,CAU3F;AAED,eAAO,MAAM,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EASrC,CAAC;AAMF,qBAAa,MAAM;IAGL,OAAO,CAAC,YAAY;IAFhC,OAAO,CAAC,KAAK,CAAgB;gBAET,YAAY,EAAE,oBAAoB;IAEtD,eAAe,CAAC,YAAY,EAAE,oBAAoB,GAAG,IAAI;IAKzD,yEAAyE;IACzE,UAAU,IAAI,IAAI;IAIlB,oEAAoE;IACpE,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM;IAuC3B,OAAO,CAAC,SAAS;IA0BjB,OAAO,CAAC,WAAW;CA6CpB;AAYD,wBAAgB,YAAY,CAAC,YAAY,EAAE,oBAAoB,GAAG,MAAM,CAEvE"}

package/dist/writer.js

@@ -2,7 +2,10 @@ import { COLOR_DEFAULT, downsample, isRgb, unpackRgb } from '@textui/core';
 import { ATTR_BLINK, ATTR_BOLD, ATTR_DIM, ATTR_HIDDEN, ATTR_INVERSE, ATTR_ITALIC, ATTR_STRIKE, ATTR_UNDERLINE, } from '@textui/core';
 import * as ansi from './ansi.js';
 function freshState() {
-    return { fg: COLOR_DEFAULT, bg: COLOR_DEFAULT, attrs: 0, link: undefined, x: -1, y: -1, valid: false };
+    return {
+        fg: COLOR_DEFAULT, bg: COLOR_DEFAULT, attrs: 0, link: undefined,
+        x: -1, y: -1, valid: false, cursorShown: false,
+    };
 }
 export function fgSequence(color, depth) {
     const c = downsample(color, depth);
@@ -61,7 +64,9 @@ export class Writer {
     }
     /** Encode a frame. Returns an empty string when nothing changed. */
     write(frame) {
-        if (frame.runs.length === 0 && !frame.cursor)
+        // Nothing to paint, nowhere to put the caret, and none on screen to take
+        // away. A frame that has to *hide* one still has work to do.
+        if (frame.runs.length === 0 && !frame.cursor && !this.state.cursorShown)
             return '';
         const out = [];
         const sync = this.capabilities.synchronizedOutput;
@@ -69,9 +74,12 @@ export class Writer {
             out.push(ansi.syncStart);
         // A frame is painted with the cursor hidden; showing it once at the end
         // is the difference between a steady caret and one that streaks.
-        const hideForPaint = this.capabilities.cursor && frame.runs.length > 0;
-        if (hideForPaint)
+        const hideForPaint = this.capabilities.cursor
+            && (frame.runs.length > 0 || (this.state.cursorShown && !frame.cursor));
+        if (hideForPaint) {
             out.push(ansi.cursorHide);
+            this.state.cursorShown = false;
+        }
         for (const run of frame.runs)
             out.push(this.encodeRun(run));
         if (this.state.link !== undefined) {
@@ -82,8 +90,10 @@ export class Writer {
             out.push(ansi.cursorTo(frame.cursor.x, frame.cursor.y));
             this.state.x = frame.cursor.x;
             this.state.y = frame.cursor.y;
-            if (frame.cursor.visible)
+            if (frame.cursor.visible) {
                 out.push(ansi.cursorShow);
+                this.state.cursorShown = true;
+            }
         }
         if (sync)
             out.push(ansi.syncEnd);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@textui/terminal",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Terminal adapters, capability detection, ANSI writing and input decoding for TextUI",
   "keywords": [
     "terminal",
@@ -54,7 +54,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@textui/core": "^0.3.0"
+    "@textui/core": "^0.5.0"
   },
   "publishConfig": {
     "access": "public"

package/src/writer.ts

@@ -23,10 +23,22 @@ interface WriterState {
   x: number;
   y: number;
   valid: boolean;
+  /**
+   * Whether the terminal is currently showing its cursor.
+   *
+   * Tracked because a frame can need the cursor *taken away* without painting
+   * anything: focus moving from a text field to a control that has no caret
+   * changes no cell the field did not already own, and the cursor was left
+   * sitting in the field somebody had just tabbed out of.
+   */
+  cursorShown: boolean;
 }
 
 function freshState(): WriterState {
-  return { fg: COLOR_DEFAULT, bg: COLOR_DEFAULT, attrs: 0, link: undefined, x: -1, y: -1, valid: false };
+  return {
+    fg: COLOR_DEFAULT, bg: COLOR_DEFAULT, attrs: 0, link: undefined,
+    x: -1, y: -1, valid: false, cursorShown: false,
+  };
 }
 
 export function fgSequence(color: number, depth: TerminalCapabilities['colorDepth']): string {
@@ -85,7 +97,9 @@ export class Writer {
 
   /** Encode a frame. Returns an empty string when nothing changed. */
   write(frame: Frame): string {
-    if (frame.runs.length === 0 && !frame.cursor) return '';
+    // Nothing to paint, nowhere to put the caret, and none on screen to take
+    // away. A frame that has to *hide* one still has work to do.
+    if (frame.runs.length === 0 && !frame.cursor && !this.state.cursorShown) return '';
 
     const out: string[] = [];
     const sync = this.capabilities.synchronizedOutput;
@@ -93,8 +107,12 @@ export class Writer {
 
     // A frame is painted with the cursor hidden; showing it once at the end
     // is the difference between a steady caret and one that streaks.
-    const hideForPaint = this.capabilities.cursor && frame.runs.length > 0;
-    if (hideForPaint) out.push(ansi.cursorHide);
+    const hideForPaint = this.capabilities.cursor
+      && (frame.runs.length > 0 || (this.state.cursorShown && !frame.cursor));
+    if (hideForPaint) {
+      out.push(ansi.cursorHide);
+      this.state.cursorShown = false;
+    }
 
     for (const run of frame.runs) out.push(this.encodeRun(run));
 
@@ -107,7 +125,10 @@ export class Writer {
       out.push(ansi.cursorTo(frame.cursor.x, frame.cursor.y));
       this.state.x = frame.cursor.x;
       this.state.y = frame.cursor.y;
-      if (frame.cursor.visible) out.push(ansi.cursorShow);
+      if (frame.cursor.visible) {
+        out.push(ansi.cursorShow);
+        this.state.cursorShown = true;
+      }
     }
 
     if (sync) out.push(ansi.syncEnd);