fix: Improve logger

Author: ServerlessLife

package-lock.json

@@ -91,6 +91,7 @@
     "@aws-sdk/client-s3": "^3.577.0",
     "@aws-sdk/credential-providers": "^3.577.0",
     "aws-iot-device-sdk": "^2.2.13",
+    "chalk": "^5.3.0",
     "chokidar": "^3.6.0",
     "commander": "^12.0.0",
     "esbuild": "^0.20.1",
@@ -117,7 +118,8 @@
     "yaml",
     "typescript",
     "inquirer",
-    "jsonc-parser"
+    "jsonc-parser",
+    "chalk"
   ],
   "workspaces": [
     "src/extension/*",

package.json

@@ -347,18 +347,31 @@ async function saveConfiguration(config: LldConfigCliArgs) {
 import { type LldConfigTs } from "lambda-live-debugger";
 
 export default {
+  // Framework to use
   framework: "${config.framework}",
+  // AWS CDK context
   context: ${config.context ? JSON.stringify(config.context) : undefined},
+  // Serverless Framework stage
   stage: "${config.stage}",
+  // Monorepo subfolder
   subfolder: "${config.subfolder}",
+  // Filter by function name. You can use * as a wildcard
   function: "${config.function}",
+  // AWS profile
   profile: "${config.profile}",
+  // AWS region
   region: "${config.region}",
+  // AWS role
   role: "${config.role}",
+  // SAM environment
   configEnv: "${config.configEnv}",
+  // Observable mode
   observable: ${config.observable},
+  // Observable mode interval
   interval: ${config.interval === defaultObservableInterval ? undefined : config.interval},
+  // Verbose logs
   verbose: ${config.verbose},
+  // Modify Lambda function list or support custom framework
   //getLambdas: async (foundLambdas) => {
   //  you can customize the list of lambdas here or create your own
   //  return foundLambdas;

src/configuration/getConfigFromWizard.ts

@@ -68,7 +68,7 @@ async function onMessageFromLambda(message: IoTMessage) {
     }
 
     if (Configuration.config.verbose) {
-      Logger.verbose(
+      Logger.log(
         `[Function ${message.data.functionId}] Response: `,
         JSON.stringify(message.data, null, 2),
       );
@@ -85,7 +85,7 @@ async function onMessageFromLambda(message: IoTMessage) {
     const response = await NodeHandler.invokeLambda(message.data);
 
     if (Configuration.config.verbose) {
-      Logger.verbose(
+      Logger.log(
         `[Function ${message.data.functionId}] Response: `,
         JSON.stringify(response, null, 2),
       );

src/lambdaConnection.ts

@@ -24,7 +24,7 @@ async function run() {
   const version = await getVersion();
 
   Logger.log(`Welcome to Lambda Live Debugger 🐞 version ${version}.`);
-  Logger.log(
+  Logger.important(
     'To keep the project moving forward, please fill out the feedback form at https://forms.gle/v6ekZtuB45Rv3EyW9. Your input is greatly appreciated!',
   );
 
@@ -57,8 +57,7 @@ async function run() {
       Configuration.config.observable
         ? 'in observable mode'
         : `(ID ${Configuration.config.debuggerId})`
-    }
-    ...`,
+    }...`,
   );
 
   if (Configuration.config.subfolder) {

src/lldebugger.ts

@@ -1,24 +1,63 @@
+// @ts-nocheck
+import chalk from 'chalk';
+const orange = '#D24E01';
 let verboseEnabled = false;
 /**
- * Log verbose message in verbose logging is enabled
- * @param args
+ * Log a message
+ * @param args The arguments to log
+ */
+function log(...args) {
+  args = args.map((arg) => {
+    if (typeof arg === 'string') {
+      // Regular expression to find text within square brackets
+      return arg.replace(/\[(.*?)\]/g, (match) => chalk.gray(match)); // Colorizes the entire bracketed content
+    }
+    return arg;
+  });
+  console.log(...args);
+}
+/**
+ * Log an important message
+ * @param args The arguments to log
+ */
+function important(...args) {
+  console.log(chalk.hex(orange)(...args));
+}
+/**
+ * Log an error message in red
+ * @param args The arguments to log
+ */
+function error(...args) {
+  console.error(chalk.red(...args));
+}
+/**
+ * Log a warning message in orange
+ * @param args The arguments to log
+ */
+function warn(...args) {
+  console.warn(chalk.hex(orange)(...args));
+}
+/**
+ * Log a verbose message if verbose is enabled. Log the message in grey.
+ * @param args The arguments to log
  */
 function verbose(...args) {
   if (verboseEnabled) {
-    console.info(...args);
+    console.info(chalk.grey(...args));
   }
 }
 /**
- *
- * @param enabled
+ * Set the verbosity of logging
+ * @param enabled Whether verbose logging should be enabled
  */
 function setVerbose(enabled) {
   verboseEnabled = enabled;
 }
 export const Logger = {
-  log: console.log,
-  error: console.error,
-  warn: console.warn,
+  log,
+  error,
+  warn,
+  important,
   verbose,
   setVerbose,
 };

src/logger.mjs

@@ -1,27 +1,70 @@
+import chalk from 'chalk';
+
+const orange = '#D24E01';
 let verboseEnabled = false;
 
 /**
- * Log verbose message in verbose logging is enabled
- * @param args
+ * Log a message
+ * @param args The arguments to log
+ */
+function log(...args: any[]) {
+  args = args.map((arg) => {
+    if (typeof arg === 'string') {
+      // Regular expression to find text within square brackets
+      return arg.replace(/\[(.*?)\]/g, (match) => chalk.gray(match)); // Colorizes the entire bracketed content
+    }
+    return arg;
+  });
+  console.log(...args);
+}
+
+/**
+ * Log an important message
+ * @param args The arguments to log
+ */
+function important(...args: any[]) {
+  console.log(chalk.hex(orange)(...args));
+}
+
+/**
+ * Log an error message in red
+ * @param args The arguments to log
+ */
+function error(...args: any[]) {
+  console.error(chalk.red(...args));
+}
+
+/**
+ * Log a warning message in orange
+ * @param args The arguments to log
+ */
+function warn(...args: any[]) {
+  console.warn(chalk.hex(orange)(...args));
+}
+
+/**
+ * Log a verbose message if verbose is enabled. Log the message in grey.
+ * @param args The arguments to log
  */
 function verbose(...args: any[]) {
   if (verboseEnabled) {
-    console.info(...args);
+    console.info(chalk.grey(...args));
   }
 }
 
 /**
- *
- * @param enabled
+ * Set the verbosity of logging
+ * @param enabled Whether verbose logging should be enabled
  */
 function setVerbose(enabled: boolean) {
   verboseEnabled = enabled;
 }
 
 export const Logger = {
-  log: console.log,
-  error: console.error,
-  warn: console.warn,
+  log,
+  error,
+  warn,
+  important,
   verbose,
   setVerbose,
 };