Add rich colorful logging

Signed-off-by: Rahul Krishna <[email protected]>

Author: rahlk

src/analysis/java/JavaAnalysis.ts

@@ -26,6 +26,9 @@ import os from "os";
 import JSONStream from "JSONStream";
 declare module "JSONStream";
 import crypto from "crypto";
+import { createLogger } from "src/utils";
+
+const logger = createLogger("JavaAnalysis");
 
 enum AnalysisLevel {
   SYMBOL_TABLE = "1",
@@ -56,10 +59,10 @@ export class JavaAnalysis {
     const jarPath = matches[0];
 
     if (!jarPath) {
-      console.log("Default codeanalyzer jar not found.");
+      logger.error("Default codeanalyzer jar not found.");
       throw new Error("Default codeanalyzer jar not found.");
     }
-    log.info("Codeanalyzer jar found at:", jarPath);
+    logger.info("Codeanalyzer jar found at:", jarPath);
     return ["java", "-jar", jarPath];
   }
 
@@ -91,7 +94,7 @@ export class JavaAnalysis {
       if (!command[0]) {
         return reject(new Error("Codeanalyzer command not found"));
       }
-      log.debug(command.join(" "));
+      logger.debug(command.join(" "));
       const result = spawnSync(command[0], command.slice(1), {
         stdio: ["ignore", "pipe", "inherit"],
       });
@@ -115,8 +118,9 @@ export class JavaAnalysis {
 
         stream.on("end", () => {
           // Clean up the temporary file
+          logger.debug(`Deleting temporary file: ${tmpFilePath}`);
           fs.rm(tmpFilePath, { recursive: true, force: true }, (err) => {
-            if (err) log.warn(`Failed to delete temporary file: ${tmpFilePath}`, err);
+            if (err) logger.warn(`Failed to delete temporary file: ${tmpFilePath}`, err);
           });
           resolve(result as types.JApplicationType);
         });

src/types/signale.d.ts

@@ -0,0 +1 @@
+declare module 'signale';

src/utils/index.ts

@@ -0,0 +1 @@
+export * from './logger';

src/utils/logger.ts

@@ -0,0 +1,49 @@
+// logger.ts
+import Signale from 'signale';
+import chalk from 'chalk';
+
+class Logger {
+    /**
+     * Instance of Signale for logging messages.
+     */
+
+    /** 
+     * @note Instead of using `private signale: Signale;`, I am using `InstanceType<typeof Signale>` to tell
+     * typescript, "Hey, signale is an instance of the {@link Signale} class."
+     */
+    private signale: InstanceType<typeof Signale>;
+
+    constructor(scope?: string) {
+        this.signale = new Signale({ scope });
+    }
+
+    info(...messages: unknown[]) {
+        this.signale.info(...messages.map(m => typeof m === 'string' ? chalk.cyan(m) : m));
+    }
+
+    success(...messages: unknown[]) {
+        this.signale.success(...messages.map(m => typeof m === 'string' ? chalk.greenBright(m) : m));
+    }
+
+    warn(...messages: unknown[]) {
+        this.signale.warn(...messages.map(m => typeof m === 'string' ? chalk.yellowBright(m) : m));
+    }
+
+    error(...messages: unknown[]) {
+        this.signale.error(...messages.map(m => typeof m === 'string' ? chalk.redBright.bold(m) : m));
+    }
+
+    debug(...messages: unknown[]) {
+        this.signale.debug(...messages.map(m => typeof m === 'string' ? chalk.magentaBright(m) : m));
+    }
+
+    prettyJson(title: string, obj: any) {
+        this.signale.info(chalk.blue.bold(title));
+        this.signale.info(chalk.gray(JSON.stringify(obj, null, 2)));
+    }
+}
+
+export const logger = new Logger();
+export function createLogger(scope: string) {
+    return new Logger(scope);
+}

test/conftest.ts

@@ -23,6 +23,7 @@ import * as path from 'path';
 import extract from 'extract-zip';
 import { beforeAll, afterAll } from "bun:test";
 import { CLDK } from "../src/CLDK";
+import { JavaAnalysis } from "../src/analysis/java/JavaAnalysis";
 
 /*
  * Set up sample applications for testing

test/unit/analysis/java/JavaAnalysis.test.ts

@@ -1,10 +1,7 @@
 import { JCallable, JCallableParameter, JType } from "../../../../src/models/java/";
 import { daytraderJavaAnalysis } from "../../../conftest";
 import { expect, test } from "bun:test";
-import chalk from "chalk";
-import { Signale } from "signale";
-
-const logger = new Signale();
+import { logger } from "../../../../src/utils";
 
 test("Must get analysis object from JavaAnalysis object", () => {
   expect(daytraderJavaAnalysis).toBeDefined();
@@ -64,27 +61,27 @@ test("Must get parameters of a specific method in a specific class in the applic
     "com.ibm.websphere.samples.daytrader.impl.direct.TradeDirect", "publishQuotePriceChange(QuoteDataBean, BigDecimal, BigDecimal, double)");
 
   expect(parameters).toBeDefined();
-  logger.success(chalk.green("parameters are defined"));
+  logger.success("parameters are defined");
   expect(parameters.length).toBe(4);
-  logger.success(chalk.green("there are 4 parameters"));
+  logger.success("there are 4 parameters");
   parameters.forEach(param => {
     expect(async () => JCallableParameter.parse(param)).not.toThrow();
   });
-  logger.success(chalk.green("All parameters are valid JCallableParameter instances"));
+  logger.success("All parameters are valid JCallableParameter instances");
 });
 
 test("Must get parameters of a specific method in a specific class in the application given the callable object", async () => {
   const method = await daytraderJavaAnalysis.getMethodByQualifiedName(
     "com.ibm.websphere.samples.daytrader.impl.direct.TradeDirect", "publishQuotePriceChange(QuoteDataBean, BigDecimal, BigDecimal, double)");
   const parameters = await daytraderJavaAnalysis.getMethodParametersFromCallable(method);
   expect(parameters).toBeDefined();
-  logger.success(chalk.green("parameters are defined"));
+  logger.success("parameters are defined");
   expect(parameters.length).toBe(4);
-  logger.success(chalk.green("there are 4 parameters"));
+  logger.success("there are 4 parameters");
   parameters.forEach(param => {
     expect(async () => JCallableParameter.parse(param)).not.toThrow();
   }
   );
-  logger.success(chalk.green("All parameters are valid JCallableParameter instances"));
+  logger.success("All parameters are valid JCallableParameter instances");
 });
 

tsconfig.json

@@ -28,10 +28,16 @@
     "noPropertyAccessFromIndexSignature": false,
     "baseUrl": ".",
     "paths": {
-      "cldk": ["node_modules/@cldk/cldk"]
-    }
+      "cldk": [
+        "node_modules/@cldk/cldk"
+      ]
+    },
+    "typeRoots": [
+      "./src/ypes",
+      "./node_modules/@types"
+    ]
   },
   "include": [
     "src"
   ]
-}
+}