genlayer 0.18.3 → 0.18.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.18.4 (2025-06-27)
+
+### Bug Fixes
+
+* refactor log output formatting and address spinner display ([#228](https://github.com/yeagerai/genlayer-cli/issues/228)) ([ea0ac10](https://github.com/yeagerai/genlayer-cli/commit/ea0ac100cdbed0cf184ae1eaf1d9c0fd580fc92c))
+
 ## 0.18.3 (2025-05-29)
 
 ## 0.18.2 (2025-05-29)

package/dist/index.js

@@ -17723,7 +17723,7 @@ var require_semver2 = __commonJS({
 import { program } from "commander";
 
 // package.json
-var version = "0.18.3";
+var version = "0.18.4";
 var package_default = {
   name: "genlayer",
   version,
@@ -20658,6 +20658,7 @@ function ora(options) {
 
 // src/lib/actions/BaseAction.ts
 import inquirer from "inquirer";
+import { inspect } from "util";
 
 // src/lib/accounts/KeypairManager.ts
 import { writeFileSync, existsSync, readFileSync } from "fs";
@@ -40979,18 +40980,10 @@ var BaseAction = class extends ConfigFileManager {
     }
   }
   formatOutput(data) {
-    if (data instanceof Error) {
-      const errorDetails = {
-        name: data.name,
-        message: data.message,
-        ...Object.keys(data).length ? data : {}
-      };
-      return JSON.stringify(errorDetails, null, 2);
-    }
-    if (data instanceof Map) {
-      data = Object.fromEntries(data);
+    if (typeof data === "string") {
+      return data;
     }
-    return typeof data === "object" ? JSON.stringify(data, null, 2) : String(data);
+    return inspect(data, { depth: null, colors: false });
   }
   log(message, data) {
     console.log(source_default.white(`
@@ -41023,10 +41016,12 @@ ${message}`));
   }
   succeedSpinner(message, data) {
     if (data !== void 0) this.log("Result:", data);
+    console.log("");
     this.spinner.succeed(source_default.green(message));
   }
   failSpinner(message, error) {
     if (error) this.log("Error:", error);
+    console.log("");
     this.spinner.fail(source_default.red(message));
   }
   stopSpinner() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "genlayer",
-  "version": "0.18.3",
+  "version": "0.18.4",
   "description": "GenLayer Command Line Tool",
   "main": "src/index.ts",
   "type": "module",

package/src/lib/actions/BaseAction.ts

@@ -2,6 +2,7 @@ import {ConfigFileManager} from "../../lib/config/ConfigFileManager";
 import ora, {Ora} from "ora";
 import chalk from "chalk";
 import inquirer from "inquirer";
+import { inspect } from "util";
 import {KeypairManager} from "../accounts/KeypairManager";
 import {createClient, createAccount} from "genlayer-js";
 import {localnet} from "genlayer-js/chains";
@@ -58,20 +59,10 @@ export class BaseAction extends ConfigFileManager {
   }
 
   private formatOutput(data: any): string {
-    if (data instanceof Error) {
-      const errorDetails = {
-        name: data.name,
-        message: data.message,
-        ...(Object.keys(data).length ? data : {}),
-      };
-      return JSON.stringify(errorDetails, null, 2);
+    if (typeof data === "string") {
+      return data;
     }
-
-    if (data instanceof Map) {
-      data = Object.fromEntries(data);
-    }
-
-    return typeof data === "object" ? JSON.stringify(data, null, 2) : String(data);
+    return inspect(data, { depth: null, colors: false });
   }
 
   protected log(message: string, data?: any): void {
@@ -106,11 +97,13 @@ export class BaseAction extends ConfigFileManager {
 
   protected succeedSpinner(message: string, data?: any): void {
     if (data !== undefined) this.log("Result:", data);
+    console.log('');
     this.spinner.succeed(chalk.green(message));
   }
 
-  protected failSpinner(message: string, error?: any): void {
+  protected failSpinner(message: string, error?:any): void {
     if (error) this.log("Error:", error);
+    console.log('');
     this.spinner.fail(chalk.red(message));
   }
 
@@ -121,4 +114,4 @@ export class BaseAction extends ConfigFileManager {
   protected setSpinnerText(message: string): void {
     this.spinner.text = chalk.blue(message);
   }
-}
+}

package/tests/libs/baseAction.test.ts

@@ -3,6 +3,7 @@ import {BaseAction} from "../../src/lib/actions/BaseAction";
 import inquirer from "inquirer";
 import ora, {Ora} from "ora";
 import chalk from "chalk";
+import {inspect} from "util";
 
 vi.mock("inquirer");
 vi.mock("ora");
@@ -42,11 +43,17 @@ describe("BaseAction", () => {
 
   test("should succeed the spinner with a message", () => {
     baseAction["succeedSpinner"]("Success");
+    expect(consoleSpy).toHaveBeenCalledWith("");
     expect(mockSpinner.succeed).toHaveBeenCalledWith(expect.stringContaining("Success"));
   });
 
   test("should fail the spinner with an error message", () => {
-    baseAction["failSpinner"]("Failure", new Error("Something went wrong"));
+    const error = new Error("Something went wrong");
+    baseAction["failSpinner"]("Failure", error);
+
+    expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining("Error:"));
+    expect(consoleSpy).toHaveBeenCalledWith(inspect(error, {depth: null, colors: false}));
+    expect(consoleSpy).toHaveBeenCalledWith("");
     expect(mockSpinner.fail).toHaveBeenCalledWith(expect.stringContaining("Failure"));
   });
 
@@ -108,7 +115,7 @@ describe("BaseAction", () => {
     baseAction["logSuccess"]("Success message", data);
 
     expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining("✔ Success message"));
-    expect(consoleSpy).toHaveBeenCalledWith(chalk.green(JSON.stringify(data, null, 2)));
+    expect(consoleSpy).toHaveBeenCalledWith(chalk.green(inspect(data, {depth: null, colors: false})));
   });
 
   test("should log an error message with error details", () => {
@@ -117,18 +124,7 @@ describe("BaseAction", () => {
     baseAction["logError"]("Error message", error);
 
     expect(consoleErrorSpy).toHaveBeenCalledWith(expect.stringContaining("✖ Error message"));
-    expect(consoleErrorSpy).toHaveBeenCalledWith(
-      chalk.red(
-        JSON.stringify(
-          {
-            name: error.name,
-            message: error.message,
-          },
-          null,
-          2,
-        ),
-      ),
-    );
+    expect(consoleErrorSpy).toHaveBeenCalledWith(chalk.red(inspect(error, {depth: null, colors: false})));
   });
 
   test("should log an info message with data", () => {
@@ -137,7 +133,7 @@ describe("BaseAction", () => {
     baseAction["logInfo"]("Info message", data);
 
     expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining("ℹ Info message"));
-    expect(consoleSpy).toHaveBeenCalledWith(chalk.blue(JSON.stringify(data, null, 2)));
+    expect(consoleSpy).toHaveBeenCalledWith(chalk.blue(inspect(data, {depth: null, colors: false})));
   });
 
   test("should log a warning message with data", () => {
@@ -146,7 +142,7 @@ describe("BaseAction", () => {
     baseAction["logWarning"]("Warning message", data);
 
     expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining("⚠ Warning message"));
-    expect(consoleSpy).toHaveBeenCalledWith(chalk.yellow(JSON.stringify(data, null, 2)));
+    expect(consoleSpy).toHaveBeenCalledWith(chalk.yellow(inspect(data, {depth: null, colors: false})));
   });
 
   test("should succeed the spinner with a message and log result if data is provided", () => {
@@ -155,52 +151,17 @@ describe("BaseAction", () => {
     baseAction["succeedSpinner"]("Success", mockData);
 
     expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining("Result:"));
-    expect(consoleSpy).toHaveBeenCalledWith(JSON.stringify(mockData, null, 2));
+    expect(consoleSpy).toHaveBeenCalledWith(inspect(mockData, {depth: null, colors: false}));
+    expect(consoleSpy).toHaveBeenCalledWith("");
     expect(mockSpinner.succeed).toHaveBeenCalledWith(expect.stringContaining("Success"));
   });
 
-  test("should format an Error instance with name, message, and additional properties", () => {
-    const error = new Error("Something went wrong");
-    (error as any).code = 500;
-
-    const result = (baseAction as any).formatOutput(error);
-    expect(result).toBe(JSON.stringify({name: "Error", message: "Something went wrong", code: 500}, null, 2));
-  });
-
-  test("should format an object as JSON string", () => {
-    const data = {key: "value", num: 42};
-    const result = (baseAction as any).formatOutput(data);
-
-    expect(result).toBe(JSON.stringify(data, null, 2));
-  });
-
   test("should return a string representation of a primitive", () => {
     expect((baseAction as any).formatOutput("Hello")).toBe("Hello");
     expect((baseAction as any).formatOutput(42)).toBe("42");
     expect((baseAction as any).formatOutput(true)).toBe("true");
   });
 
-  test("should format a Map object correctly", () => {
-    const testMap = new Map<string, any>([
-      ["key1", "value1"],
-      ["key2", 42],
-      ["key3", {nested: "object"}],
-    ]);
-
-    const result = (baseAction as any).formatOutput(testMap);
-    const expected = JSON.stringify(
-      {
-        key1: "value1",
-        key2: 42,
-        key3: {nested: "object"},
-      },
-      null,
-      2,
-    );
-
-    expect(result).toBe(expected);
-  });
-
   const mockPrivateKey = "mocked_private_key";
 
   beforeEach(() => {
@@ -240,4 +201,34 @@ describe("BaseAction", () => {
 
     await expect(baseAction["getPrivateKey"]()).rejects.toThrow("process exited");
   });
+
+  describe("formatOutput", () => {
+    test("should return string as is", () => {
+      expect((baseAction as any).formatOutput("Hello")).toBe("Hello");
+    });
+
+    test("should format an object", () => {
+      const data = {key: "value", num: 42};
+      const result = (baseAction as any).formatOutput(data);
+      expect(result).toBe("{ key: 'value', num: 42 }");
+    });
+
+    test("should format an error object", () => {
+      const error = new Error("Test Error");
+      const result = (baseAction as any).formatOutput(error);
+      expect(result).toContain("Error: Test Error");
+    });
+
+    test("should format a Map object", () => {
+      const testMap = new Map([["key1", "value1"]]);
+      const result = (baseAction as any).formatOutput(testMap);
+      expect(result).toBe("Map(1) { 'key1' => 'value1' }");
+    });
+
+    test("should format a BigInt object", () => {
+      const bigIntValue = BigInt(9007199254740991);
+      const result = (baseAction as any).formatOutput(bigIntValue);
+      expect(result).toBe("9007199254740991n");
+    });
+  });
 });