@travetto/terminal 7.0.0-rc.1 → 7.0.0-rc.2

package/package.json

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

package/src/style.ts

@@ -43,7 +43,7 @@ export class StyleUtil {
    * Read foreground/background color if env var is set
    */
   static isBackgroundDark(): boolean {
-    const key = Env.COLORFGBG.val ?? '';
+    const key = Env.COLORFGBG.value ?? '';
 
     if (this.#scheme.key === key) {
       return this.#scheme.dark;
@@ -74,9 +74,9 @@ export class StyleUtil {
   /**
    * Build style palette, with support for background theme awareness
    */
-  static getPalette<K extends string>(inp: Record<K, TermStylePairInput>): Record<K, TermStyleFn> {
+  static getPalette<K extends string>(input: Record<K, TermStylePairInput>): Record<K, TermStyleFn> {
     return TypedObject.fromEntries(
-      TypedObject.entries(inp).map(([k, v]) => [k, this.getThemedStyle(v)]));
+      TypedObject.entries(input).map(([key, value]) => [key, this.getThemedStyle(value)]));
   }
 
   /**
@@ -89,16 +89,16 @@ export class StyleUtil {
       if (keys.length === 0) {
         return values[0];
       } else {
-        const out = keys.map((el, i) => {
-          let final = el;
-          if (typeof el !== 'string') {
-            const subKeys = TypedObject.keys(el);
+        const out = keys.map((item, i) => {
+          let final = item;
+          if (typeof item !== 'string') {
+            const subKeys = TypedObject.keys(item);
             if (subKeys.length !== 1) {
               throw new Error('Invalid template variable, one and only one key should be specified');
             }
-            const [k] = subKeys;
-            const v = el[k]!;
-            final = v === undefined ? '' : palette[k](v)!;
+            const [key] = subKeys;
+            const value = item[key]!;
+            final = value === undefined ? '' : palette[key](value)!;
           }
           return `${values[i] ?? ''}${final ?? ''}`;
         });

package/src/terminal.ts

@@ -10,8 +10,8 @@ type Coord = { x: number, y: number };
 export const WAIT_TOKEN = '%WAIT%';
 const STD_WAIT_STATES = '⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏'.split('');
 
-const lineStatus = (l: string): string => l.replace(WAIT_TOKEN, ' ');
-const lineMain = (l: string): string => l.replace(WAIT_TOKEN, '').trim();
+const lineStatus = (line: string): string => line.replace(WAIT_TOKEN, ' ');
+const lineMain = (line: string): string => line.replace(WAIT_TOKEN, '').trim();
 
 /** An basic tty wrapper */
 export class Terminal {
@@ -22,12 +22,12 @@ export class Terminal {
   #height: number;
   #output: tty.WriteStream;
 
-  async #showWaitingIndicator(pos: Coord, signal: AbortSignal): Promise<void> {
+  async #showWaitingIndicator(position: Coord, signal: AbortSignal): Promise<void> {
     let done = false;
     signal.addEventListener('abort', () => done = true);
     let i = 0;
     while (!done) {
-      await this.#writer.setPosition(pos).write(STD_WAIT_STATES[i++ % STD_WAIT_STATES.length]).commit(true);
+      await this.#writer.setPosition(position).write(STD_WAIT_STATES[i++ % STD_WAIT_STATES.length]).commit(true);
       await Util.blockingTimeout(100);
     }
   }
@@ -57,7 +57,7 @@ export class Terminal {
         }
       }
     } else {
-      await this.streamToBottom(Util.mapAsyncItr(source, x => `%WAIT% ${x}`), { outputStreamToMain: true });
+      await this.streamToBottom(Util.mapAsyncIterable(source, line => `%WAIT% ${line}`), { outputStreamToMain: true });
     }
   }
 
@@ -65,10 +65,10 @@ export class Terminal {
    * Allows for writing at bottom of screen with scrolling support for main content
    */
   async streamToBottom(source: AsyncIterable<string | undefined>, config: TerminalStreamingConfig = {}): Promise<void> {
-    const writePos = { x: 0, y: -1 };
+    const writePosition = { x: 0, y: -1 };
     const minDelay = config.minDelay ?? 0;
 
-    let prev: string | undefined;
+    let previous: string | undefined;
     let stop: AbortController | undefined;
     let start = Date.now();
 
@@ -80,31 +80,31 @@ export class Terminal {
 
       for await (const line of source) {
         // Previous line
-        if (prev && config.outputStreamToMain) {
-          await this.writer.writeLine(lineMain(prev)).commit();
+        if (previous && config.outputStreamToMain) {
+          await this.writer.writeLine(lineMain(previous)).commit();
         }
 
         if (line && (Date.now() - start) >= minDelay) {
           start = Date.now();
           stop?.abort();
-          this.writer.setPosition(writePos).write(lineStatus(line)).clearLine(1).commit(true);
+          this.writer.setPosition(writePosition).write(lineStatus(line)).clearLine(1).commit(true);
 
           const idx = line.indexOf(WAIT_TOKEN);
           if (idx >= 0) {
             stop = new AbortController();
-            this.#showWaitingIndicator({ y: writePos.y, x: idx }, stop.signal);
+            this.#showWaitingIndicator({ y: writePosition.y, x: idx }, stop.signal);
           }
         }
 
-        prev = line;
+        previous = line;
       }
 
       stop?.abort();
-      if (prev !== undefined && config.outputStreamToMain) {
-        await this.writer.writeLine(lineMain(prev)).commit();
+      if (previous !== undefined && config.outputStreamToMain) {
+        await this.writer.writeLine(lineMain(previous)).commit();
       }
 
-      await this.#writer.setPosition(writePos).clearLine().commit(true);
+      await this.#writer.setPosition(writePosition).clearLine().commit(true);
     } finally {
       await this.#writer.reset().commit();
     }
@@ -116,9 +116,9 @@ export class Terminal {
   async streamList(source: AsyncIterable<{ idx: number, text: string, done?: boolean }>): Promise<void> {
     if (!this.#interactive) {
       const collected = [];
-      for await (const ev of source) {
-        if (ev.done) {
-          collected[ev.idx] = ev.text;
+      for await (const event of source) {
+        if (event.done) {
+          collected[event.idx] = event.text;
         }
       }
       await this.#writer.writeLines(collected).commit();

package/src/util.ts

@@ -11,33 +11,33 @@ export class TerminalUtil {
    */
   static progressBarUpdater(
     term: Terminal,
-    cfg?: {
+    config?: {
       withWaiting?: boolean;
       style?: { complete: TermStyleInput, incomplete?: TermStyleInput } | (() => ProgressStyle);
     }
-  ): (ev: ProgressEvent<string>) => string {
-    const styleBase = typeof cfg?.style !== 'function' ? {
-      complete: StyleUtil.getStyle(cfg?.style?.complete ?? { background: '#248613', text: '#ffffff' }),
-      incomplete: cfg?.style?.incomplete ? StyleUtil.getStyle(cfg.style.incomplete) : undefined,
+  ): (event: ProgressEvent<string>) => string {
+    const styleBase = typeof config?.style !== 'function' ? {
+      complete: StyleUtil.getStyle(config?.style?.complete ?? { background: '#248613', text: '#ffffff' }),
+      incomplete: config?.style?.incomplete ? StyleUtil.getStyle(config.style.incomplete) : undefined,
     } : undefined;
 
-    const style = typeof cfg?.style === 'function' ? cfg.style : (): ProgressStyle => styleBase!;
+    const style = typeof config?.style === 'function' ? config.style : (): ProgressStyle => styleBase!;
 
     let width: number;
-    return ev => {
-      const text = ev.value ?? (ev.total ? '%idx/%total' : '%idx');
-      const pct = ev.total === undefined ? 0 : (ev.idx / ev.total);
-      if (ev.total) {
-        width ??= Math.trunc(Math.ceil(Math.log10(ev.total ?? 10000)));
+    return event => {
+      const text = event.value ?? (event.total ? '%idx/%total' : '%idx');
+      const progress = event.total === undefined ? 0 : (event.idx / event.total);
+      if (event.total) {
+        width ??= Math.trunc(Math.ceil(Math.log10(event.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 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)];
+      const state: Record<string, string> = { total: `${event.total}`, idx: `${event.idx}`.padStart(width ?? 0), progress: `${Math.trunc(progress * 100)}` };
+      const line = ` ${text.replace(/[%](idx|total|progress)/g, (_, key) => state[key])} `;
+      const full = term.writer.padToWidth(line, config?.withWaiting ? 2 : 0);
+      const mid = Math.trunc(progress * term.width);
+      const [left, right] = [full.substring(0, mid), full.substring(mid)];
 
       const { complete, incomplete } = style();
-      return `${cfg?.withWaiting ? `${WAIT_TOKEN} ` : ''}${complete(l)}${incomplete?.(r) ?? r}`;
+      return `${config?.withWaiting ? `${WAIT_TOKEN} ` : ''}${complete(left)}${incomplete?.(right) ?? right}`;
     };
   }
 }

package/src/writer.ts

@@ -6,9 +6,9 @@ type State = { output: tty.WriteStream, height: number, width: number };
 type TermCoord = { x: number, y: number };
 
 const ESC = '\x1b[';
-const clamp = (v: number, size: number): number => Math.max(Math.min(v + (v < 0 ? size : 0), size - 1), 0);
-const delta = (v: number | undefined, pos: string, neg: string): string =>
-  !v ? '' : `${ESC}${Math.abs(v)}${v < 0 ? neg : pos}`;
+const clamp = (input: number, size: number): number => Math.max(Math.min(input + (input < 0 ? size : 0), size - 1), 0);
+const delta = (input: number | undefined, position: string, negative: string): string =>
+  !input ? '' : `${ESC}${Math.abs(input)}${input < 0 ? negative : position}`;
 
 const Codes = {
   SHOW_CURSOR: `${ESC}?25h`,
@@ -73,14 +73,14 @@ export class TerminalWriter {
   }
 
   commit(restorePosition: boolean = this.#restoreOnCommit): Promise<void> {
-    const q = this.#buffer.filter(x => x !== undefined);
+    const queue = this.#buffer.filter(line => line !== undefined);
     this.#buffer = [];
-    if (q.length && restorePosition) {
-      q.unshift(Codes.POSITION_SAVE);
-      q.push(Codes.POSITION_RESTORE);
+    if (queue.length && restorePosition) {
+      queue.unshift(Codes.POSITION_SAVE);
+      queue.push(Codes.POSITION_RESTORE);
     }
-    if (q.length && !this.#term.output.write(q.join(''))) {
-      return new Promise<void>(r => this.#term.output.once('drain', r));
+    if (queue.length && !this.#term.output.write(queue.join(''))) {
+      return new Promise<void>(resolve => this.#term.output.once('drain', resolve));
     } else {
       return Promise.resolve();
     }
@@ -127,7 +127,7 @@ export class TerminalWriter {
 
   /** Write multiple lines */
   writeLines(lines: (string | undefined)[], clear = false): this {
-    lines = lines.filter(x => x !== undefined);
+    lines = lines.filter(line => line !== undefined);
     let text = lines.join('\n');
     if (text.length > 0) {
       if (clear) {