@flowscripter/dynamic-cli-framework 5.4.10 → 5.4.12

package/dist/src/service/printer/terminal/Progress.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Progress.d.ts","sourceRoot":"","sources":["../../../../../src/service/printer/terminal/Progress.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAM1D,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAkBxE,MAAM,CAAC,OAAO,OAAO,QAAQ;;IAe3B,YAAmB,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAGpD;IAEM,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CA4BjF;IA4BM,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAyBrE;IAEY,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAe/C;IAEY,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAKpC;IAEY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAqBlC;IAEM,MAAM,IAAI,IAAI,CAapB;IA0JD,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,EAE9B;IAED,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAE/B;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED,IAAI,aAAa,CAAC,KAAK,EAAE,aAAa,EAErC;CAmDF"}
+{"version":3,"file":"Progress.d.ts","sourceRoot":"","sources":["../../../../../src/service/printer/terminal/Progress.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAU1D,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AACxE,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAkBxE,MAAM,CAAC,OAAO,OAAO,QAAQ;;IAe3B,YAAmB,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAGpD;IAEM,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CA4BjF;IA4BM,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAyBrE;IAEY,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAe/C;IAEY,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAKpC;IAEY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAqBlC;IAEM,MAAM,IAAI,IAAI,CAapB;IAgKD,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,EAE9B;IAED,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,EAE/B;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED,IAAI,aAAa,CAAC,KAAK,EAAE,aAAa,EAErC;CAmDF"}

package/dist/src/service/printer/terminal/Progress.js

@@ -1,6 +1,9 @@
 // Weight given to each new rate sample in the exponential moving average - time constant is
 // roughly 1/RATE_SMOOTHING_FACTOR * 100ms (the render interval).
 const RATE_SMOOTHING_FACTOR = 0.3;
+// A rate this close to zero (units/s) produces a meaningless (and, past a certain point,
+// non-finite) "time remaining" estimate - treat it the same as no rate at all.
+const MAX_REMAINING_MILLIS = 999 * 24 * 60 * 60 * 1000;
 export { ProgressStyle } from "@flowscripter/dynamic-cli-framework-api";
 import { ProgressStyle } from "@flowscripter/dynamic-cli-framework-api";
 const STYLE_CHARS = {
@@ -187,9 +190,14 @@ export default class Progress {
                         Bun.stripANSI(taken).length;
             }
             else {
-                const remaining = bar.rate === undefined || bar.rate === 0
+                const remainingMillis = bar.rate === undefined || bar.rate === 0
+                    ? undefined
+                    : ((bar.total - bar.current) / bar.rate) * 1000;
+                const remaining = remainingMillis === undefined ||
+                    !Number.isFinite(remainingMillis) ||
+                    remainingMillis > MAX_REMAINING_MILLIS
                     ? "-"
-                    : this.#formatTime(((bar.total - bar.current) / bar.rate) * 1000);
+                    : this.#formatTime(remainingMillis);
                 const currentString = bar.current + "";
                 const totalString = bar.total + "";
                 suffix += `${this.#styler.colorText(currentString, this.#valColor)}${this.#styler.colorText("/", this.#labColor)}${this.#styler.colorText(totalString, this.#valColor)}${this.#styler.colorText(bar.units + ", rate:", this.#labColor)} ${rate}${this.#styler.colorText(bar.units + "/s, time remaining:", this.#labColor)} ${remaining}`;

package/dist/src/service/printer/terminal/Spinner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Spinner.d.ts","sourceRoot":"","sources":["../../../../../src/service/printer/terminal/Spinner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAM1D,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAEvE,MAAM,CAAC,OAAO,OAAO,OAAO;;IAY1B,YAAmB,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAGpD;IAuCY,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASjD;IAEY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAajC;IAEY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAUlC;IAEM,MAAM,IAAI,IAAI,CAKpB;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,YAAY,EAEnC;CACF"}
+{"version":3,"file":"Spinner.d.ts","sourceRoot":"","sources":["../../../../../src/service/printer/terminal/Spinner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAQ1D,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAEvE,MAAM,CAAC,OAAO,OAAO,OAAO;;IAc1B,YAAmB,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAGpD;IAoDY,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASjD;IAEY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAmBjC;IAEY,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAelC;IAEM,MAAM,IAAI,IAAI,CASpB;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,YAAY,EAEnC;CACF"}

package/dist/src/service/printer/terminal/Spinner.js

@@ -1,12 +1,15 @@
 const BOX_FRAMES = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
 const STAR_FRAMES = ["★", "✶", "✷", "✹", "✷", "✶", "★", "✦"];
+const SHOW_DELAY_MILLIS = 100;
 export { SpinnerStyle } from "@flowscripter/dynamic-cli-framework-api";
 import { SpinnerStyle } from "@flowscripter/dynamic-cli-framework-api";
 export default class Spinner {
     #isShown = false;
+    #isRendering = false;
     #message;
     #frameIndex = 0;
     #timer;
+    #showDelayTimer;
     #renderInFlight;
     #spinColor = 0x8a8a8a;
     #msgColor = 0x808080;
@@ -45,6 +48,17 @@ export default class Spinner {
             });
         }, 100);
     }
+    async #beginRendering() {
+        this.#isRendering = true;
+        this.#startTimer();
+        await this.#terminal.hideCursor();
+    }
+    #scheduleShow() {
+        this.#showDelayTimer = setTimeout(() => {
+            this.#showDelayTimer = undefined;
+            void this.#beginRendering();
+        }, SHOW_DELAY_MILLIS);
+    }
     async show(message) {
         this.#message = message;
         if (this.#isShown) {
@@ -52,14 +66,21 @@ export default class Spinner {
         }
         this.#isShown = true;
         this.#frameIndex = 0;
-        this.#startTimer();
-        await this.#terminal.hideCursor();
+        this.#scheduleShow();
+        return Promise.resolve();
     }
     async hide() {
         if (!this.#isShown) {
             return Promise.resolve();
         }
         this.#isShown = false;
+        this.#message = undefined;
+        if (this.#showDelayTimer) {
+            clearTimeout(this.#showDelayTimer);
+            this.#showDelayTimer = undefined;
+            return;
+        }
+        this.#isRendering = false;
         clearInterval(this.#timer);
         this.#timer = undefined;
         if (this.#renderInFlight) {
@@ -67,12 +88,16 @@ export default class Spinner {
         }
         await this.#terminal.clearLine();
         await this.#terminal.showCursor();
-        this.#message = undefined;
     }
     async pause() {
         if (!this.#isShown) {
             return Promise.resolve();
         }
+        if (this.#showDelayTimer) {
+            clearTimeout(this.#showDelayTimer);
+            this.#showDelayTimer = undefined;
+            return;
+        }
         clearInterval(this.#timer);
         this.#timer = undefined;
         if (this.#renderInFlight) {
@@ -81,10 +106,15 @@ export default class Spinner {
         await this.#terminal.clearLine();
     }
     resume() {
-        if (!this.#isShown || this.#timer !== undefined) {
+        if (!this.#isShown || this.#timer !== undefined || this.#showDelayTimer !== undefined) {
             return;
         }
-        this.#startTimer();
+        if (this.#isRendering) {
+            this.#startTimer();
+        }
+        else {
+            this.#scheduleShow();
+        }
     }
     set spinnerColor(color) {
         this.#spinColor = color;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
-  "version": "5.4.10",
+  "version": "5.4.12",
   "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
   "keywords": [
     "bun",

package/src/service/printer/terminal/Progress.ts

@@ -5,6 +5,10 @@ import type Terminal from "../../../terminal/Terminal.ts";
 // roughly 1/RATE_SMOOTHING_FACTOR * 100ms (the render interval).
 const RATE_SMOOTHING_FACTOR = 0.3;
 
+// A rate this close to zero (units/s) produces a meaningless (and, past a certain point,
+// non-finite) "time remaining" estimate - treat it the same as no rate at all.
+const MAX_REMAINING_MILLIS = 999 * 24 * 60 * 60 * 1000;
+
 export { ProgressStyle } from "@flowscripter/dynamic-cli-framework-api";
 import { ProgressStyle } from "@flowscripter/dynamic-cli-framework-api";
 
@@ -255,10 +259,16 @@ export default class Progress {
           1 +
           Bun.stripANSI(taken).length;
       } else {
-        const remaining =
+        const remainingMillis =
           bar.rate === undefined || bar.rate === 0
+            ? undefined
+            : ((bar.total - bar.current) / bar.rate) * 1000;
+        const remaining =
+          remainingMillis === undefined ||
+          !Number.isFinite(remainingMillis) ||
+          remainingMillis > MAX_REMAINING_MILLIS
             ? "-"
-            : this.#formatTime(((bar.total - bar.current) / bar.rate) * 1000);
+            : this.#formatTime(remainingMillis);
         const currentString = bar.current + "";
         const totalString = bar.total + "";
         suffix += `${this.#styler.colorText(currentString, this.#valColor)}${this.#styler.colorText(

package/src/service/printer/terminal/Spinner.ts

@@ -5,14 +5,18 @@ const BOX_FRAMES = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇
 
 const STAR_FRAMES = ["★", "✶", "✷", "✹", "✷", "✶", "★", "✦"];
 
+const SHOW_DELAY_MILLIS = 100;
+
 export { SpinnerStyle } from "@flowscripter/dynamic-cli-framework-api";
 import { SpinnerStyle } from "@flowscripter/dynamic-cli-framework-api";
 
 export default class Spinner {
   #isShown = false;
+  #isRendering = false;
   #message: string | undefined;
   #frameIndex = 0;
   #timer: Timer | undefined;
+  #showDelayTimer: Timer | undefined;
   #renderInFlight: Promise<void> | undefined;
   #spinColor = 0x8a8a8a;
   #msgColor = 0x808080;
@@ -62,6 +66,19 @@ export default class Spinner {
     }, 100);
   }
 
+  async #beginRendering(): Promise<void> {
+    this.#isRendering = true;
+    this.#startTimer();
+    await this.#terminal.hideCursor();
+  }
+
+  #scheduleShow(): void {
+    this.#showDelayTimer = setTimeout(() => {
+      this.#showDelayTimer = undefined;
+      void this.#beginRendering();
+    }, SHOW_DELAY_MILLIS);
+  }
+
   public async show(message?: string): Promise<void> {
     this.#message = message;
     if (this.#isShown) {
@@ -69,8 +86,8 @@ export default class Spinner {
     }
     this.#isShown = true;
     this.#frameIndex = 0;
-    this.#startTimer();
-    await this.#terminal.hideCursor();
+    this.#scheduleShow();
+    return Promise.resolve();
   }
 
   public async hide(): Promise<void> {
@@ -78,6 +95,13 @@ export default class Spinner {
       return Promise.resolve();
     }
     this.#isShown = false;
+    this.#message = undefined;
+    if (this.#showDelayTimer) {
+      clearTimeout(this.#showDelayTimer);
+      this.#showDelayTimer = undefined;
+      return;
+    }
+    this.#isRendering = false;
     clearInterval(this.#timer);
     this.#timer = undefined;
     if (this.#renderInFlight) {
@@ -85,13 +109,17 @@ export default class Spinner {
     }
     await this.#terminal.clearLine();
     await this.#terminal.showCursor();
-    this.#message = undefined;
   }
 
   public async pause(): Promise<void> {
     if (!this.#isShown) {
       return Promise.resolve();
     }
+    if (this.#showDelayTimer) {
+      clearTimeout(this.#showDelayTimer);
+      this.#showDelayTimer = undefined;
+      return;
+    }
     clearInterval(this.#timer);
     this.#timer = undefined;
     if (this.#renderInFlight) {
@@ -101,10 +129,14 @@ export default class Spinner {
   }
 
   public resume(): void {
-    if (!this.#isShown || this.#timer !== undefined) {
+    if (!this.#isShown || this.#timer !== undefined || this.#showDelayTimer !== undefined) {
       return;
     }
-    this.#startTimer();
+    if (this.#isRendering) {
+      this.#startTimer();
+    } else {
+      this.#scheduleShow();
+    }
   }
 
   set spinnerColor(color: number) {