add debug part

src/lib/alternatives/log/debug.ts

@@ -0,0 +1,86 @@
+import debug from 'debug';
+
+let preLogHook: ((...args: any[]) => void) | undefined;
+let postLogHook: ((...args: any[]) => void) | undefined;
+
+/**
+ * Process and handle the logging of messages through custom hooks and the given logger.
+ * This function checks if the logger's namespace is enabled, executes any preLogHook functions, logs the message using the provided logger, and then executes any postLogHook functions.
+ *
+ * @param logger - The debug logger instance to be used for logging.
+ * @param args - The arguments to be passed to the logger and any hook functions.
+ */
+function theFunctionThroughWhichAllLogsPass(logger: any, ...args: any[]) {
+  if (!debug.enabled(logger.namespace)) {
+    return;
+  }
+  if (preLogHook) {
+    preLogHook(logger.namespace, ...args);
+  }
+  logger(...args);
+  if (postLogHook) {
+    postLogHook(logger.namespace, ...args);
+  }
+}
+
+/**
+ * A debug logger.
+ */
+export type DebugLogger = (...args: any[]) => void;
+
+/**
+ * Return a logger, meant to be silent by default and verbose during debugging.
+ * @param name - The module name of the logger.
+ * @returns A callable log function.
+ */
+export function createDebugLogger(name: string): DebugLogger {
+  const logger = debug(name);
+  return (...args: any[]) => theFunctionThroughWhichAllLogsPass(logger, ...args);
+}
+
+/**
+ * Set a function to be called before each log message is handled by the debug logger.
+ * The hook function will receive the logger namespace and any arguments passed to the logger.
+ * This can be useful for adding additional context, filtering logs, or performing side-effects
+ * based on logged messages.
+ *
+ * @param fn - The function to be called before each log message.
+ */
+export function setPreDebugLogHook(fn: (...args: any[]) => void) {
+  preLogHook = fn;
+}
+
+/**
+ * Set a callback function to be executed after each log is written by the debug logger.
+ * This allows additional behavior or side effects to occur after a log has been written,
+ * such as sending logs to external services, formatting output, or triggering events.
+ *
+ * @param fn - The callback function to be executed after each log. It receives the same arguments as the original log function call.
+ */
+export function setPostDebugLogHook(fn: (...args: any[]) => void) {
+  postLogHook = fn;
+}
+
+/**
+ * Enable logs for the specified namespace(s) or wildcard pattern(s).
+ * This function activates the logging functionality for the given
+ * namespace(s) or pattern(s), allowing developers to selectively display
+ * debug logs that match the provided string(s).
+ *
+ * @param str - The namespace(s) or wildcard pattern(s) for which logs should be enabled.
+ */
+export function enableLogs(str: string) {
+  debug.enable(str);
+}
+
+/**
+ * Check if the logging is enabled for a given namespace.
+ * The input 'str' represents the namespace for which the log status is being checked.
+ * Returns true if the logging is enabled, otherwise false.
+ *
+ * @param str - The namespace string used to determine if logging is enabled.
+ * @returns A boolean indicating whether logging is enabled for the given namespace.
+ */
+export function isLogEnabled(str: string) {
+  return debug.enabled(str);
+}