@travetto/terminal 4.0.0-rc.6 → 4.0.0-rc.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/terminal",
-  "version": "4.0.0-rc.6",
+  "version": "4.0.0-rc.7",
   "description": "General terminal support",
   "keywords": [
     "terminal",
@@ -24,7 +24,7 @@
     "directory": "module/terminal"
   },
   "dependencies": {
-    "@travetto/base": "^4.0.0-rc.6",
+    "@travetto/base": "^4.0.0-rc.7",
     "chalk": "^4.1.2"
   },
   "travetto": {

package/src/terminal.ts

@@ -19,7 +19,6 @@ export class Terminal {
 
   #interactive: boolean;
   #writer: TerminalWriter;
-  #cleanExit = 0;
   #width: number;
   #height: number;
   #output: tty.WriteStream;
@@ -34,14 +33,6 @@ export class Terminal {
     }
   }
 
-  #cleanOnExit(): () => void {
-    if (this.#cleanExit === 0) {
-      process.on('exit', TerminalWriter.reset);
-    }
-    this.#cleanExit += 1;
-    return () => (this.#cleanExit -= 1) === 0 && process.off('exit', TerminalWriter.reset);
-  }
-
   constructor(output?: tty.WriteStream, config?: { width?: number, height?: number }) {
     this.#output = output ?? process.stdout;
     this.#interactive = this.#output.isTTY && !Env.TRV_QUIET.isTrue;
@@ -77,7 +68,6 @@ export class Terminal {
   async streamToBottom(source: AsyncIterable<string | undefined>, config: TerminalStreamingConfig = {}): Promise<void> {
     const writePos = { x: 0, y: -1 };
     const minDelay = config.minDelay ?? 0;
-    const remove = this.#cleanOnExit();
 
     let prev: string | undefined;
     let stop: AbortController | undefined;
@@ -117,8 +107,7 @@ export class Terminal {
 
       await this.#writer.setPosition(writePos).clearLine().commit(true);
     } finally {
-      await this.#writer.softReset().commit();
-      remove();
+      await this.#writer.reset().commit();
     }
   }
 
@@ -137,7 +126,6 @@ export class Terminal {
       return;
     }
 
-    const remove = this.#cleanOnExit();
     let max = 0;
     try {
       await this.#writer.hideCursor().commit();
@@ -146,8 +134,7 @@ export class Terminal {
         await this.#writer.write('\n'.repeat(idx)).setPosition({ x: 0 }).write(text).clearLine(1).changePosition({ y: -idx }).commit();
       }
     } finally {
-      await this.#writer.changePosition({ y: max + 1 }).writeLine('\n').softReset().commit();
-      remove();
+      await this.#writer.changePosition({ y: max + 1 }).writeLine('\n').reset().commit();
     }
   }
 }

package/src/util.ts

@@ -17,7 +17,7 @@ export class TerminalUtil {
     }
   ): (ev: ProgressEvent<string>) => string {
     const styleBase = typeof cfg?.style !== 'function' ? {
-      complete: StyleUtil.getStyle(cfg?.style?.complete ?? { background: '#32cd32', text: '#ffffff' }),
+      complete: StyleUtil.getStyle(cfg?.style?.complete ?? { background: '#248613', text: '#ffffff' }),
       incomplete: cfg?.style?.incomplete ? StyleUtil.getStyle(cfg.style.incomplete) : undefined,
     } : undefined;
 
@@ -31,7 +31,7 @@ export class TerminalUtil {
         width ??= Math.trunc(Math.ceil(Math.log10(ev.total ?? 10000)));
       }
       const state: Record<string, string> = { total: `${ev.total}`, idx: `${ev.idx}`.padStart(width ?? 0), pct: `${Math.trunc(pct * 100)}` };
-      const line = text.replace(/[%](idx|total|pct)/g, (_, k) => state[k]);
+      const line = ` ${text.replace(/[%](idx|total|pct)/g, (_, k) => state[k])} `;
       const full = term.writer.padToWidth(line, cfg?.withWaiting ? 2 : 0);
       const mid = Math.trunc(pct * term.width);
       const [l, r] = [full.substring(0, mid), full.substring(mid)];

package/src/writer.ts

@@ -1,5 +1,7 @@
 import tty from 'node:tty';
 
+import { ShutdownManager } from '@travetto/base';
+
 type State = { output: tty.WriteStream, height: number, width: number };
 type TermCoord = { x: number, y: number };
 
@@ -31,20 +33,31 @@ const Codes = {
  * Buffered/batched writer.  Meant to be similar to readline.Readline, but with more general writing support and extensibility
  */
 export class TerminalWriter {
-
-  static reset(): void {
-    process.stdout.isTTY && process.stdout.write(Codes.SOFT_RESET);
-    process.stderr.isTTY && process.stderr.write(Codes.SOFT_RESET);
-  }
-
   #buffer: (string | number)[] = [];
   #restoreOnCommit = false;
   #term: State;
+  #cleanup: (() => undefined) | undefined;
 
   constructor(state: State) {
     this.#term = state;
   }
 
+  /** Track dirty state for the stream */
+  trackDirty(on: boolean): this {
+    const output = this.#term.output;
+    if (output.isTTY) {
+      if (on && !this.#cleanup) {
+        const exit = (): Promise<void> => this.reset().commit(false);
+        const free = ShutdownManager.onGracefulShutdown(exit);
+        process.on('exit', exit);
+        this.#cleanup = (): undefined => { free(); process.off('exit', exit); };
+      } else if (!on) {
+        this.#cleanup = this.#cleanup?.();
+      }
+    }
+    return this;
+  }
+
   /** Pad to width of terminal */
   padToWidth(text: string, offset = 0, ellipsis = '...'): string {
     if (text.length > (this.#term.width - offset)) {
@@ -132,12 +145,12 @@ export class TerminalWriter {
 
   /** Hide cursor */
   hideCursor(): this {
-    return this.write(Codes.HIDE_CURSOR);
+    return this.trackDirty(true).write(Codes.HIDE_CURSOR);
   }
 
   /** Set scrolling range */
   scrollRange({ start = 0, end = -1 }: { start?: number, end?: number }): this {
-    return this.write(Codes.SCROLL_RANGE_SET(start, end, this.#term.height));
+    return this.trackDirty(true).write(Codes.SCROLL_RANGE_SET(start, end, this.#term.height));
   }
 
   /** Clear scrolling range */
@@ -146,7 +159,7 @@ export class TerminalWriter {
   }
 
   /** Reset */
-  softReset(): this {
-    return this.write(Codes.SOFT_RESET);
+  reset(): this {
+    return this.trackDirty(false).write(Codes.SOFT_RESET).write(Codes.SHOW_CURSOR);
   }
 }