fix: improvements based on feedback

Author: CorieW

spec/logger.spec.ts

@@ -2,6 +2,7 @@ import { expect } from "chai";
 
 import * as logger from "../src/logger";
 import { setGlobalOptions } from "../src/v2";
+import { getGlobalOptions } from "../src/v2/options";
 
 describe("logger", () => {
   const stdoutWrite = process.stdout.write.bind(process.stdout);
@@ -221,24 +222,37 @@ describe("logger", () => {
   });
 
   describe("error logging stacktrace", () => {
-    it("should include stacktrace in error logs", () => {
+    const defaultOptions = getGlobalOptions();
+
+    beforeEach(() => {
+      setGlobalOptions(defaultOptions);
+    });
+
+    it("when disableErrorLoggingStacktrace is set to false, should include stacktrace in error logs", () => {
       const message = "Test error with stacktrace";
+      setGlobalOptions({
+        disableErrorLoggingStacktrace: false,
+      });
       logger.error(message);
       const messageOutput = JSON.parse(lastErr.trim()).message;
 
       expect(messageOutput).to.include(`Error: ${message}`);
     });
 
-    it("when disableErrorLoggingTraceback is set to true, should not log stacktrace", () => {
-      const message = "Test error with traceback disabled";
+    it("when disableErrorLoggingStacktrace is set to true, should not include stacktrace in error logs", () => {
+      const message = "Test error with stacktrace disabled";
       setGlobalOptions({
-        disableErrorLoggingTraceback: true,
+        disableErrorLoggingStacktrace: true,
       });
       logger.error(message);
       expectStderr({
         severity: "ERROR",
         message: message,
       });
     });
+
+    afterEach(() => {
+      setGlobalOptions(defaultOptions);
+    });
   });
 });

src/logger/index.ts

@@ -161,7 +161,7 @@ function entryFromArgs(severity: LogSeverity, args: any[]): LogEntry {
   let message = format(...args);
   if (
     severity === "ERROR" &&
-    !getGlobalOptions().disableErrorLoggingTraceback &&
+    !getGlobalOptions().disableErrorLoggingStacktrace &&
     !args.find((arg) => arg instanceof Error)
   ) {
     message = new Error(message).stack || message;

src/v2/options.ts

@@ -234,13 +234,13 @@ export interface GlobalOptions {
   preserveExternalChanges?: boolean;
 
   /**
-   * Controls whether error logging should include the traceback of the error automatically.
+   * Controls whether error logging should include the stacktrace of the error automatically.
    * Defaults to false.
    *
    * @remarks
-   * When true, the error message will include not include the traceback of the error.
+   * When true, the error message will not include the stacktrace of the error.
    */
-  disableErrorLoggingTraceback?: boolean;
+  disableErrorLoggingStacktrace?: boolean;
 }
 
 let globalOptions: GlobalOptions | undefined;