@nomicfoundation/hardhat-utils 3.0.1 → 3.0.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @nomicfoundation/hardhat-utils
 
+## 3.0.3
+
+### Patch Changes
+
+- d821a0a: Fix npm artifact cleanup on windows ([#7459](https://github.com/NomicFoundation/hardhat/issues/7459))
+- b13620a: Add compilation progress spinner to show build progress ([#7460](https://github.com/NomicFoundation/hardhat/pull/7460))
+
+## 3.0.2
+
+### Patch Changes
+
+- 8c1cb1e: Fixed peer dependencies for Hardhat so `rpc` utils can be loaded ([#7415](https://github.com/NomicFoundation/hardhat/issues/7415))
+
 ## 3.0.1
 
 ### Patch Changes

package/dist/src/spinner.d.ts

@@ -0,0 +1,46 @@
+export declare const FRAME_INTERVAL_MS = 80;
+export interface ISpinner {
+    readonly isEnabled: boolean;
+    start(): void;
+    stop(): void;
+}
+/**
+ * Optional settings when creating a spinner.
+ */
+export interface SpinnerOptions {
+    /**
+     * Text shown next to the spinner.
+     */
+    text?: string;
+    /**
+     * Stream used to write frames.
+     */
+    stream?: NodeJS.WriteStream;
+    /**
+     * Whether the spinner is enabled.
+     */
+    enabled?: boolean;
+}
+/**
+ * Create a spinner instance.
+ *
+ * @example
+ * ```typescript
+ * const spinner = createSpinner({ text: "Compiling…" });
+ * spinner.start();
+ *
+ * try {
+ *   await compileContracts();
+ *   spinner.stop();
+ *   console.log("Compiled 12 contracts");
+ * } catch (error) {
+ *   spinner.stop();
+ *   console.error("Compilation failed");
+ * }
+ * ```
+ *
+ * @param options  Optional spinner configuration.
+ * @returns {Spinner} A spinner instance.
+ */
+export declare function createSpinner(options?: SpinnerOptions): ISpinner;
+//# sourceMappingURL=spinner.d.ts.map

package/dist/src/spinner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spinner.d.ts","sourceRoot":"","sources":["../../src/spinner.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,KAAK,IAAI,IAAI,CAAC;IACd,IAAI,IAAI,IAAI,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAmED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,cAAmB,GAAG,QAAQ,CAcpE"}

package/dist/src/spinner.js

@@ -0,0 +1,91 @@
+const FRAMES = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
+export const FRAME_INTERVAL_MS = 80;
+/**
+ * Spinner that writes frames to a stream.
+ */
+class Spinner {
+    isEnabled;
+    #text;
+    #interval = null;
+    #stream;
+    constructor(options) {
+        this.isEnabled = options.enabled;
+        this.#stream = options.stream;
+        this.#text = options.text;
+    }
+    /**
+     * Begin rendering frames when enabled.
+     */
+    start() {
+        if (!this.isEnabled) {
+            return;
+        }
+        this.#stopAnimation();
+        let frameIndex = 0;
+        this.#interval = setInterval(() => {
+            this.#render(FRAMES[frameIndex]);
+            frameIndex = (frameIndex + 1) % FRAMES.length;
+        }, FRAME_INTERVAL_MS);
+    }
+    /**
+     * Stop the spinner without printing a final line.
+     */
+    stop() {
+        this.#stopAnimation();
+    }
+    #clearLine() {
+        this.#stream.clearLine(0);
+        this.#stream.cursorTo(0);
+    }
+    #render(frame) {
+        if (!this.isEnabled) {
+            return;
+        }
+        this.#clearLine();
+        this.#stream.write(`${frame} ${this.#text}`);
+    }
+    #stopAnimation() {
+        if (this.#interval === null) {
+            return;
+        }
+        clearInterval(this.#interval);
+        this.#interval = null;
+        if (this.isEnabled) {
+            this.#clearLine();
+        }
+    }
+}
+/**
+ * Create a spinner instance.
+ *
+ * @example
+ * ```typescript
+ * const spinner = createSpinner({ text: "Compiling…" });
+ * spinner.start();
+ *
+ * try {
+ *   await compileContracts();
+ *   spinner.stop();
+ *   console.log("Compiled 12 contracts");
+ * } catch (error) {
+ *   spinner.stop();
+ *   console.error("Compilation failed");
+ * }
+ * ```
+ *
+ * @param options  Optional spinner configuration.
+ * @returns {Spinner} A spinner instance.
+ */
+export function createSpinner(options = {}) {
+    const stream = options.stream ?? process.stdout;
+    const enabled = stream.isTTY === true &&
+        process.env.TERM !== "dumb" &&
+        (options.enabled ?? true);
+    const text = options.text ?? "";
+    return new Spinner({
+        enabled,
+        stream,
+        text,
+    });
+}
+//# sourceMappingURL=spinner.js.map

package/dist/src/spinner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spinner.js","sourceRoot":"","sources":["../../src/spinner.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAClE,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AA4BpC;;GAEG;AACH,MAAM,OAAO;IACK,SAAS,CAAU;IAC1B,KAAK,CAAS;IACvB,SAAS,GAA0B,IAAI,CAAC;IAC/B,OAAO,CAAqB;IAErC,YAAY,OAAiC;QAC3C,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAC5B,CAAC;IACD;;OAEG;IACI,KAAK;QACV,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,UAAU,GAAG,CAAC,CAAC;QAEnB,IAAI,CAAC,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE;YAChC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;YACjC,UAAU,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;QAChD,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,IAAI;QACT,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAED,UAAU;QACR,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED,OAAO,CAAC,KAAa;QACnB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,cAAc;QACZ,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAEtB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,aAAa,CAAC,UAA0B,EAAE;IACxD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAEhD,MAAM,OAAO,GACX,MAAM,CAAC,KAAK,KAAK,IAAI;QACrB,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM;QAC3B,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;IAE5B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;IAChC,OAAO,IAAI,OAAO,CAAC;QACjB,OAAO;QACP,MAAM;QACN,IAAI;KACL,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nomicfoundation/hardhat-utils",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "Utilities for Hardhat and its plugins",
   "homepage": "https://github.com/nomicfoundation/hardhat/tree/v-next/v-next/hardhat-utils",
   "repository": {
@@ -35,7 +35,8 @@
     "./string": "./dist/src/string.js",
     "./stream": "./dist/src/stream.js",
     "./subprocess": "./dist/src/subprocess.js",
-    "./synchronization": "./dist/src/synchronization.js"
+    "./synchronization": "./dist/src/synchronization.js",
+    "./spinner": "./dist/src/spinner.js"
   },
   "keywords": [
     "ethereum",

package/src/spinner.ts

@@ -0,0 +1,130 @@
+const FRAMES = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
+export const FRAME_INTERVAL_MS = 80;
+
+export interface ISpinner {
+  readonly isEnabled: boolean;
+  start(): void;
+  stop(): void;
+}
+
+/**
+ * Optional settings when creating a spinner.
+ */
+export interface SpinnerOptions {
+  /**
+   * Text shown next to the spinner.
+   */
+  text?: string;
+
+  /**
+   * Stream used to write frames.
+   */
+  stream?: NodeJS.WriteStream;
+
+  /**
+   * Whether the spinner is enabled.
+   */
+  enabled?: boolean;
+}
+
+/**
+ * Spinner that writes frames to a stream.
+ */
+class Spinner implements ISpinner {
+  public readonly isEnabled: boolean;
+  readonly #text: string;
+  #interval: NodeJS.Timeout | null = null;
+  readonly #stream: NodeJS.WriteStream;
+
+  constructor(options: Required<SpinnerOptions>) {
+    this.isEnabled = options.enabled;
+    this.#stream = options.stream;
+    this.#text = options.text;
+  }
+  /**
+   * Begin rendering frames when enabled.
+   */
+  public start(): void {
+    if (!this.isEnabled) {
+      return;
+    }
+
+    this.#stopAnimation();
+    let frameIndex = 0;
+
+    this.#interval = setInterval(() => {
+      this.#render(FRAMES[frameIndex]);
+      frameIndex = (frameIndex + 1) % FRAMES.length;
+    }, FRAME_INTERVAL_MS);
+  }
+
+  /**
+   * Stop the spinner without printing a final line.
+   */
+  public stop(): void {
+    this.#stopAnimation();
+  }
+
+  #clearLine(): void {
+    this.#stream.clearLine(0);
+    this.#stream.cursorTo(0);
+  }
+
+  #render(frame: string): void {
+    if (!this.isEnabled) {
+      return;
+    }
+    this.#clearLine();
+    this.#stream.write(`${frame} ${this.#text}`);
+  }
+
+  #stopAnimation(): void {
+    if (this.#interval === null) {
+      return;
+    }
+
+    clearInterval(this.#interval);
+    this.#interval = null;
+
+    if (this.isEnabled) {
+      this.#clearLine();
+    }
+  }
+}
+
+/**
+ * Create a spinner instance.
+ *
+ * @example
+ * ```typescript
+ * const spinner = createSpinner({ text: "Compiling…" });
+ * spinner.start();
+ *
+ * try {
+ *   await compileContracts();
+ *   spinner.stop();
+ *   console.log("Compiled 12 contracts");
+ * } catch (error) {
+ *   spinner.stop();
+ *   console.error("Compilation failed");
+ * }
+ * ```
+ *
+ * @param options  Optional spinner configuration.
+ * @returns {Spinner} A spinner instance.
+ */
+export function createSpinner(options: SpinnerOptions = {}): ISpinner {
+  const stream = options.stream ?? process.stdout;
+
+  const enabled =
+    stream.isTTY === true &&
+    process.env.TERM !== "dumb" &&
+    (options.enabled ?? true);
+
+  const text = options.text ?? "";
+  return new Spinner({
+    enabled,
+    stream,
+    text,
+  });
+}