@lwrjs/diagnostics 0.11.4 → 0.11.6

package/build/cjs/logger.cjs

@@ -34,6 +34,7 @@ __export(exports, {
   stringifyError: () => stringifyError
 });
 var import_errors = __toModule(require("./errors.cjs"));
+var import_util = __toModule(require("util"));
 var SILENT = "silent";
 var VERBOSE = "verbose";
 var DEBUG = "debug";
@@ -76,7 +77,7 @@ function log(level, message, additionalInfo) {
     }
   }
   const logMessage = `[${level}]${gap(message)}${message}`;
-  const additionalMessage = additionalInfo ? `Additional Info: ${JSON.stringify(additionalInfo)}` : void 0;
+  const additionalMessage = additionalInfo ? `Additional Info: ${(0, import_util.inspect)(additionalInfo)}` : void 0;
   if (level == ERROR) {
     console.error("%s", logMessage);
     if (additionalInfo) {
@@ -117,7 +118,7 @@ var stringifyError = (error) => {
       const descriptor = Object.getOwnPropertyDescriptor(error, property);
       retObj[property] = descriptor?.value;
     }
-    return JSON.stringify(retObj);
+    return (0, import_util.inspect)(retObj);
   }
 };
 function gap(message) {
@@ -133,10 +134,34 @@ function logError(err, additionalInfo) {
   }
 }
 var logger = {
-  verbose: (message, additionalInfo) => log(VERBOSE, message, additionalInfo),
-  debug: (message, additionalInfo) => log(DEBUG, message, additionalInfo),
-  info: (message, additionalInfo) => log(INFO, message, additionalInfo),
-  warn: (message, additionalInfo) => log(WARN, message, additionalInfo),
+  verbose: (info, additionalInfo) => {
+    if (typeof info === "string") {
+      log(VERBOSE, info, additionalInfo);
+    } else {
+      log(VERBOSE, `[${info.label}] ${info.message}`, info.additionalInfo || additionalInfo);
+    }
+  },
+  debug: (info, additionalInfo) => {
+    if (typeof info === "string") {
+      log(DEBUG, info, additionalInfo);
+    } else {
+      log(DEBUG, `[${info.label}] ${info.message}`, info.additionalInfo || additionalInfo);
+    }
+  },
+  info: (info, additionalInfo) => {
+    if (typeof info === "string") {
+      log(INFO, info, additionalInfo);
+    } else {
+      log(INFO, `[${info.label}] ${info.message}`, info.additionalInfo || additionalInfo);
+    }
+  },
+  warn: (info, additionalInfo) => {
+    if (typeof info === "string") {
+      log(WARN, info, additionalInfo);
+    } else {
+      log(WARN, `[${info.label}] ${info.message}`, info.additionalInfo || additionalInfo);
+    }
+  },
   error: (error, additionalInfo) => logError(error, additionalInfo),
   log,
   setOptions: (opts) => {

package/build/es/logger.d.ts

@@ -11,11 +11,16 @@ type LoggerOptions = {
 declare function getLogLevel(): string;
 declare function log(level: LEVEL, message: string, additionalInfo?: any): void;
 export declare const stringifyError: (error: any) => string;
+export type LogMetadata = {
+    message: string;
+    label: string;
+    additionalInfo?: any;
+};
 export declare const logger: {
-    verbose: (message: string, additionalInfo?: any) => void;
-    debug: (message: string, additionalInfo?: any) => void;
-    info: (message: string, additionalInfo?: any) => void;
-    warn: (message: string, additionalInfo?: any) => void;
+    verbose: (info: string | LogMetadata, additionalInfo?: any) => void;
+    debug: (info: string | LogMetadata, additionalInfo?: any) => void;
+    info: (info: string | LogMetadata, additionalInfo?: any) => void;
+    warn: (info: string | LogMetadata, additionalInfo?: any) => void;
     error: (error: any, additionalInfo?: any) => void;
     log: typeof log;
     setOptions: (opts: LoggerOptions) => void;

package/build/es/logger.js

@@ -1,4 +1,5 @@
 import { DiagnosticsError } from './errors.js';
+import { inspect } from 'util';
 export const SILENT = 'silent';
 export const VERBOSE = 'verbose';
 export const DEBUG = 'debug';
@@ -44,9 +45,7 @@ function log(level, message, additionalInfo) {
         }
     }
     const logMessage = `[${level}]${gap(message)}${message}`;
-    const additionalMessage = additionalInfo
-        ? `Additional Info: ${JSON.stringify(additionalInfo)}`
-        : undefined;
+    const additionalMessage = additionalInfo ? `Additional Info: ${inspect(additionalInfo)}` : undefined;
     if (level == ERROR) {
         console.error('\x1b[31m%s\x1b[0m', logMessage); // red
         if (additionalInfo) {
@@ -91,7 +90,7 @@ export const stringifyError = (error) => {
             const descriptor = Object.getOwnPropertyDescriptor(error, property);
             retObj[property] = descriptor?.value;
         }
-        return JSON.stringify(retObj);
+        return inspect(retObj);
     }
 };
 // Return a space if there should be a space between the message and the level
@@ -109,10 +108,39 @@ function logError(err, additionalInfo) {
     }
 }
 export const logger = {
-    verbose: (message, additionalInfo) => log(VERBOSE, message, additionalInfo),
-    debug: (message, additionalInfo) => log(DEBUG, message, additionalInfo),
-    info: (message, additionalInfo) => log(INFO, message, additionalInfo),
-    warn: (message, additionalInfo) => log(WARN, message, additionalInfo),
+    verbose: (info, additionalInfo) => {
+        if (typeof info === 'string') {
+            log(VERBOSE, info, additionalInfo);
+        }
+        else {
+            log(VERBOSE, `[${info.label}] ${info.message}`, info.additionalInfo || additionalInfo);
+        }
+    },
+    debug: (info, additionalInfo) => {
+        if (typeof info === 'string') {
+            log(DEBUG, info, additionalInfo);
+        }
+        else {
+            log(DEBUG, `[${info.label}] ${info.message}`, info.additionalInfo || additionalInfo);
+        }
+    },
+    info: (info, additionalInfo) => {
+        if (typeof info === 'string') {
+            log(INFO, info, additionalInfo);
+        }
+        else {
+            log(INFO, `[${info.label}] ${info.message}`, info.additionalInfo || additionalInfo);
+        }
+    },
+    warn: (info, additionalInfo) => {
+        if (typeof info === 'string') {
+            log(WARN, info, additionalInfo);
+        }
+        else {
+            log(WARN, `[${info.label}] ${info.message}`, info.additionalInfo || additionalInfo);
+        }
+    },
+    // TODO should logger.error accept a label or is that overkill
     error: (error, additionalInfo) => logError(error, additionalInfo),
     log,
     setOptions: (opts) => {

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.11.4",
+    "version": "0.11.6",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -35,7 +35,7 @@
         "test": "jest"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.11.4",
+        "@lwrjs/types": "0.11.6",
         "jest": "^26.6.3",
         "ts-jest": "^26.5.6",
         "typescript": "^4.9.5"
@@ -43,5 +43,5 @@
     "engines": {
         "node": ">=16.0.0"
     },
-    "gitHead": "5528cfc12174d4800ff42db1691d14c5d194f7d6"
+    "gitHead": "415e25c05b4b1a0356fb89801f1242e8f73143e3"
 }