@travetto/terminal 3.0.3 → 3.1.0-rc.1

package/README.md

@@ -38,12 +38,12 @@ const tplFn = GlobalTerminal.templateFunction({
   path: 'teal',
   success: 'green',
   failure: 'red',
-  param: 'yellow',
+  param: ['yellow', 'goldenrod'],
   type: 'cyan',
-  description: 'white',
-  title: 'brightWhite',
+  description: ['white', 'gray'],
+  title: ['brightWhite', 'black'],
   identifier: 'dodgerBlue',
-  subtitle: 'lightGray',
+  subtitle: ['lightGray', 'darkGray'],
   subsubtitle: 'darkGray'
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/terminal",
-  "version": "3.0.3",
+  "version": "3.1.0-rc.1",
   "description": "General terminal support",
   "keywords": [
     "terminal",

package/src/color-output.ts

@@ -9,7 +9,7 @@ export type TermStyle =
 
 export type TermStyleInput = TermStyle | RGBInput;
 export type Prim = string | number | boolean | Date | RegExp;
-export type TermColorPaletteInput = Record<string, TermStyleInput | [TermStyleInput, TermStyleInput]>;
+export type TermColorPaletteInput = Record<string, TermStyleInput | [dark: TermStyleInput, light: TermStyleInput]>;
 export type TermColorFn = (text: Prim) => string;
 export type TermColorPalette<T> = Record<keyof T, TermColorFn>;
 
@@ -92,7 +92,7 @@ export class ColorOutputUtil {
   /**
    * Make a simple primitive colorer
    */
-  static colorer(term: TermState, style: TermStyleInput | [light: TermStyleInput, dark: TermStyleInput]): TermColorFn {
+  static colorer(term: TermState, style: TermStyleInput | [dark: TermStyleInput, light: TermStyleInput]): TermColorFn {
     const schemes = {
       light: this.getStyledLevels(Array.isArray(style) ? style[1] ?? style[0] : style),
       dark: this.getStyledLevels(Array.isArray(style) ? style[0] : style),

package/src/operation.ts

@@ -5,8 +5,18 @@ import { ColorOutputUtil, TermStyleInput } from './color-output';
 
 const STD_WAIT_STATES = '⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏'.split('');
 
+/**
+ * Standard Terminal Operations
+ */
 export class TerminalOperation {
 
+  static truncateIfNeeded(term: TermState, text: string, suffix = '...'): string {
+    if (text.length > term.width) {
+      return `${text.substring(0, term.width - suffix.length)}${suffix}`;
+    }
+    return text;
+  }
+
   /**
    * Allows for writing at top, bottom, or current position while new text is added
    */
@@ -32,9 +42,23 @@ export class TerminalOperation {
       }
       await batch.commit();
 
+      let start = Date.now();
+      const minDelay = config.minDelay ?? 0;
+
+      let line: string = '';
       for await (const text of source) {
-        await TerminalWriter.for(term).setPosition(writePos).write(text).clearLine(1).commit(true);
+        line = text;
+        if ((Date.now() - start) >= minDelay) {
+          start = Date.now();
+          await TerminalWriter.for(term).setPosition(writePos).write(line).clearLine(1).commit(true);
+          line = '';
+        }
       }
+
+      if (line) {
+        await TerminalWriter.for(term).setPosition(writePos).write(line).clearLine(1).commit(true);
+      }
+
       if (config.clearOnFinish ?? true) {
         await TerminalWriter.for(term).setPosition(writePos).clearLine().commit(true);
       }
@@ -90,7 +114,7 @@ export class TerminalOperation {
         .replace(/%idx/, idxStr)
         .replace(/%total/, totalStr)
         .replace(/%pct/, `${Math.trunc(pct * 100)}`);
-      const full = ` ${line}`.padEnd(term.width);
+      const full = this.truncateIfNeeded(term, ` ${line}`.padEnd(term.width));
       const mid = Math.trunc(pct * term.width);
       const [l, r] = [full.substring(0, mid), full.substring(mid)];
       return `${color(l)}${r}`;
@@ -125,7 +149,7 @@ export class TerminalOperation {
       if (msg !== undefined) {
         msg = msg.replace(/\n$/, '');
         pos = await term.getCursorPosition();
-        writer = this.streamWaiting(term, msg, { ...cfg, at: pos, clearOnFinish: false });
+        writer = this.streamWaiting(term, this.truncateIfNeeded(term, msg), { ...cfg, at: pos, clearOnFinish: false });
         line = msg;
       }
     }

package/src/query.ts

@@ -1,4 +1,5 @@
-import tty from 'tty';
+import type tty from 'tty';
+import { spawn } from 'child_process';
 
 import { ANSICodes } from './codes';
 import { IterableUtil } from './iterable';
@@ -7,6 +8,31 @@ import { RGB, TermCoord, TermQuery } from './types';
 const to256 = (x: string): number => Math.trunc(parseInt(x, 16) / (16 ** (x.length - 2)));
 const COLOR_RESPONSE = /(?<r>][0-9a-f]+)[/](?<g>[0-9a-f]+)[/](?<b>[0-9a-f]+)[/]?(?<a>[0-9a-f]+)?/i;
 
+// @ts-expect-error
+const queryScript = (function (...bytes) {
+  const i = process.stdin;
+  i.setRawMode(true);
+  i.resume();
+  i.once('readable', function () {
+    const inp = i.read();
+    /* @ts-expect-error */
+    process.send(Buffer.isBuffer(inp) ? inp.toString('utf8') : inp);
+    i.setRawMode(false);
+  });
+  process.stdout.write(String.fromCharCode(...bytes));
+});
+
+const runQuery = async (input: tty.ReadStream, output: tty.WriteStream, code: string): Promise<Buffer> => {
+  const script = queryScript.toString().replaceAll('\'', '"').replaceAll('\n', '');
+  const fullScript = `(${script})(${code.split('').map(x => x.charCodeAt(0))})`
+  const proc = spawn(process.argv0, ['-e', fullScript], { stdio: [input, output, 2, 'ipc'], detached: true });
+  const text = await new Promise<string>((res, rej) => {
+    proc.once('message', res);
+    proc.on('error', rej);
+  });
+  return Buffer.from(text, 'utf8');
+};
+
 const ANSIQueries = {
   /** Parse xterm color response */
   color: (field: 'background' | 'foreground'): TermQuery<RGB | undefined> => ({
@@ -43,43 +69,15 @@ export class TerminalQuerier {
   #queue = IterableUtil.simpleQueue();
   #output: tty.WriteStream;
   #input: tty.ReadStream;
+  #restore?: () => void;
 
   constructor(input: tty.ReadStream, output: tty.WriteStream) {
     this.#input = input;
     this.#output = output;
   }
 
-  async #readInput(query: string): Promise<Buffer> {
-    const isRaw = this.#input.isRaw;
-    const isPaused = this.#input.isPaused();
-    const data = this.#input.listeners('data');
-    try {
-      this.#input.removeAllListeners('data');
-
-      if (isPaused) {
-        this.#input.resume();
-      }
-
-      this.#input.setRawMode(true);
-      // Send data, but do not wait on it
-      this.#output.write(query);
-      await new Promise(res => this.#input.once('readable', res));
-      const val: Buffer | string = this.#input.read();
-      return typeof val === 'string' ? Buffer.from(val, 'utf8') : val;
-    } finally {
-      if (isPaused) {
-        this.#input.pause();
-      }
-      this.#input.setRawMode(isRaw);
-      for (const fn of data) {
-        // @ts-ignore
-        this.#input.on('data', fn);
-      }
-    }
-  }
-
   query<T>(q: TermQuery<T>): Promise<T> {
-    return this.#queue.add(() => this.#readInput(q.query()).then(q.response));
+    return this.#queue.add(() => runQuery(this.#input, this.#output, q.query()).then(q.response));
   }
 
   cursorPosition(): Promise<TermCoord> {
@@ -90,7 +88,8 @@ export class TerminalQuerier {
     return this.query(ANSIQueries.color('background'));
   }
 
-  close(): Promise<void> {
-    return this.#queue.close();
+  close(): void {
+    this.#restore?.();
+    this.#queue.close();
   }
 }

package/src/terminal.ts

@@ -13,6 +13,7 @@ import { ColorOutputUtil, Prim, TermColorFn, TermColorPalette, TermColorPaletteI
 type TerminalStreamPositionConfig = {
   position?: TermLinePosition;
   staticMessage?: string;
+  minDelay?: number;
 };
 
 type TerminalProgressConfig = TerminalStreamPositionConfig & {
@@ -98,12 +99,11 @@ export class Terminal implements TermState {
     return this.#init;
   }
 
-  async reset(): Promise<void> {
-    await this.#query.close();
+  reset(): void {
+    this.#query.close();
     if (this.interactive) {
-      await this.writer().reset().commit();
+      this.#output.write(this.writer().resetCommands());
     }
-    return;
   }
 
   getCursorPosition(): Promise<TermCoord> {

package/src/types.ts

@@ -13,7 +13,7 @@ export type TerminalTableEvent = { idx: number, text: string, done?: boolean };
 export type TerminalTableConfig = { header?: string[], forceNonInteractiveOrder?: boolean };
 export type TerminalProgressEvent = { idx: number, total?: number, text?: string };
 export type TerminalProgressRender = (ev: TerminalProgressEvent) => string;
-export type TerminalStreamingConfig = { position?: TermLinePosition, clearOnFinish?: boolean, at?: TermCoord };
+export type TerminalStreamingConfig = { position?: TermLinePosition, clearOnFinish?: boolean, at?: TermCoord, minDelay?: number };
 export type TerminalWaitingConfig = { end?: boolean, committedPrefix?: string } & TerminalStreamingConfig & DelayedConfig;
 
 export type TermColorLevel = 0 | 1 | 2 | 3;

package/src/writer.ts

@@ -137,10 +137,16 @@ export class TerminalWriter {
 
   /** Reset */
   reset(): this {
-    return this
-      .write(ANSICodes.POSITION_SAVE())
-      .write(ANSICodes.SHOW_CURSOR())
-      .write(ANSICodes.SCROLL_RANGE_CLEAR())
-      .write(ANSICodes.POSITION_RESTORE());
+    return this.write(this.resetCommands());
+  }
+
+  /** Reset Commands */
+  resetCommands(): string {
+    return [
+      ANSICodes.POSITION_SAVE(),
+      ANSICodes.SHOW_CURSOR(),
+      ANSICodes.SCROLL_RANGE_CLEAR(),
+      ANSICodes.POSITION_RESTORE()
+    ].join('');
   }
 }