@flowscripter/dynamic-cli-framework 1.0.8 → 1.0.10

package/README.md

@@ -1441,8 +1441,8 @@ classDiagram
 
 ### Debug Logging
 
-Internal framework logging can be enabled by setting the `CLI_DEBUG` environment
-variable.
+Internal framework logging can be enabled by setting the
+`DYNAMIC_CLI_FRAMEWORK_DEBUG` environment variable.
 
 The logging implementation will look for an object conforming to the `Logger`
 interface and use it if found. If not found, a simple logging implementation
@@ -1456,7 +1456,8 @@ validation that takes place is for commands or services provided by plugins
 BEFORE they are installed.
 
 When using `launcher.ts` runtime validation of all commands and services can be
-forced by defining the `CLI_VALIDATE_ALL` environment variable.
+forced by defining the `DYNAMIC_CLI_FRAMEWORK_VALIDATE_ALL` environment
+variable.
 
 Command validation includes:
 

package/package.json

@@ -1,8 +1,24 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
+  "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
+  "homepage": "https://github.com/flowscripter/dynamic-cli-framework#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flowscripter/dynamic-cli-framework.git"
+  },
+  "license": "MIT",
+  "keywords": [
+    "bun",
+    "plugin",
+    "framework",
+    "dynamic",
+    "import",
+    "executable",
+    "cli"
+  ],
   "module": "index.ts",
   "type": "module",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "publishConfig": {
     "access": "public"
   },

package/src/launcher.ts

@@ -43,7 +43,8 @@ export async function launchSingleCommandCLI(
       "configEnabled must be true if keyValueServiceEnabled is true",
     );
   }
-  const validateAllCommands = process.env.CLI_VALIDATE_ALL !== undefined;
+  const validateAllCommands =
+    process.env.DYNAMIC_CLI_FRAMEWORK_VALIDATE_ALL !== undefined;
   const cli = new DefaultRuntimeCLI(
     cliConfig,
     envVarsEnabled,
@@ -94,7 +95,8 @@ export async function launchMultiCommandCLI(
       "configEnabled must be true if keyValueServiceEnabled is true",
     );
   }
-  const validateAllCommands = process.env.CLI_VALIDATE_ALL !== undefined;
+  const validateAllCommands =
+    process.env.DYNAMIC_CLI_FRAMEWORK_VALIDATE_ALL !== undefined;
   const cli = new DefaultRuntimeCLI(
     cliConfig,
     envVarsEnabled,

package/src/util/logger.ts

@@ -1,4 +1,5 @@
 import process from "node:process";
+
 type LoggerFunction = (
   message: object | (() => string) | string,
   ...optionalParams: unknown[]
@@ -12,7 +13,19 @@ export interface Logger {
   error: LoggerFunction;
 }
 
-const debugEnabled = process.env["CLI_DEBUG"] !== undefined;
+const LEVEL_PADDINGS: Record<string, string> = {
+  TRACE: "    ",
+  DEBUG: "    ",
+  INFO: "     ",
+  WARN: "     ",
+  ERROR: "    ",
+};
+
+const debugEnabled = process.env["DYNAMIC_CLI_FRAMEWORK_DEBUG"] !== undefined;
+
+let maxLoggerNameLength = 0;
+
+const LOGGER_NAME_PADDINGS: Record<string, string> = {};
 
 function getDefaultLogger(): Logger {
   if (debugEnabled) {
@@ -45,33 +58,90 @@ function getDefaultLogger(): Logger {
 
 function wrapDefaultLogger(
   loggerName: string,
+  levelPadding: string,
   loggerFunction: LoggerFunction,
 ): LoggerFunction {
   return (message, ...optionalParams) => {
     if (message instanceof Function) {
-      loggerFunction(`${loggerName} : ${message()}`, ...optionalParams);
+      loggerFunction(
+        `${levelPadding} [${loggerName}]${
+          LOGGER_NAME_PADDINGS[loggerName]
+        } ${message()}`,
+        ...optionalParams,
+      );
       return;
     }
     if (message instanceof Object) {
-      (message as { loggerName?: string }).loggerName = loggerName;
-      loggerFunction(message, ...optionalParams);
+      loggerFunction(
+        `${levelPadding} [${loggerName}]${LOGGER_NAME_PADDINGS[loggerName]} ${
+          JSON.stringify(message)
+        }`,
+        ...optionalParams,
+      );
       return;
     }
-    loggerFunction(`${loggerName} : ${message}`, ...optionalParams);
+    loggerFunction(
+      `${levelPadding} [${loggerName}]${
+        LOGGER_NAME_PADDINGS[loggerName]
+      } ${message}`,
+      ...optionalParams,
+    );
   };
 }
 
+/**
+ * Retrieves a logger instance with the specified name. If the name length exceeds the current maximum logger name length,
+ * it updates the padding for all existing logger names to ensure consistent formatting.
+ *
+ * @param loggerName The name of the logger to retrieve.
+ * @returns A logger instance with the specified name.
+ */
 export default function getLogger(loggerName: string): Logger {
   if (globalThis.defaultLogger === undefined) {
     globalThis.defaultLogger = getDefaultLogger();
   }
+
+  if (loggerName.length > maxLoggerNameLength) {
+    maxLoggerNameLength = loggerName.length;
+
+    for (const key of Object.keys(LOGGER_NAME_PADDINGS)) {
+      LOGGER_NAME_PADDINGS[key] = " ".repeat(maxLoggerNameLength - key.length);
+    }
+
+    LOGGER_NAME_PADDINGS[loggerName] = "";
+  } else if (LOGGER_NAME_PADDINGS[loggerName] === undefined) {
+    LOGGER_NAME_PADDINGS[loggerName] = " ".repeat(
+      maxLoggerNameLength - loggerName.length,
+    );
+  }
+
   if (debugEnabled) {
     return {
-      trace: () => {},
-      debug: wrapDefaultLogger(loggerName, globalThis.defaultLogger.debug),
-      info: wrapDefaultLogger(loggerName, globalThis.defaultLogger.info),
-      warn: wrapDefaultLogger(loggerName, globalThis.defaultLogger.warn),
-      error: wrapDefaultLogger(loggerName, globalThis.defaultLogger.error),
+      trace: wrapDefaultLogger(
+        loggerName,
+        LEVEL_PADDINGS.TRACE,
+        globalThis.defaultLogger.trace,
+      ),
+      debug: wrapDefaultLogger(
+        loggerName,
+        LEVEL_PADDINGS.DEBUG,
+        globalThis.defaultLogger.debug,
+      ),
+      info: wrapDefaultLogger(
+        loggerName,
+        LEVEL_PADDINGS.INFO,
+        globalThis.defaultLogger.info,
+      ),
+      warn: wrapDefaultLogger(
+        loggerName,
+        LEVEL_PADDINGS.WARN,
+        globalThis.defaultLogger.warn,
+      ),
+      error: wrapDefaultLogger(
+        loggerName,
+        LEVEL_PADDINGS.ERROR,
+        globalThis.defaultLogger.error,
+      ),
     };
   }
   return {
@@ -79,6 +149,10 @@ export default function getLogger(loggerName: string): Logger {
     debug: () => {},
     info: () => {},
     warn: () => {},
-    error: wrapDefaultLogger(loggerName, globalThis.defaultLogger.error),
+    error: wrapDefaultLogger(
+      loggerName,
+      LEVEL_PADDINGS.ERROR,
+      globalThis.defaultLogger.error,
+    ),
   };
 }