Merge pull request #18 from deno-library/ISSUE_15_loglevel

[#15] add debug and log as loglevel

Author: UrielCh

README.md

@@ -18,7 +18,9 @@ import { Logger } from "jsr:@deno-library/logger";
 
 const logger = new Logger();
 
+logger.debug("i am from consoleLogger", "debug");
 logger.info("i am from consoleLogger", { name: "zfx" });
+logger.log("i am from consoleLogger", "hello");
 logger.warn("i am from consoleLogger", 1, "any");
 logger.error("i am from consoleLogger", new Error("test"));
 ```
@@ -33,14 +35,18 @@ import { Logger } from "jsr:@deno-library/logger";
 const logger = new Logger();
 
 // console only
+logger.debug("i am from consoleLogger", "debug");
 logger.info("i am from consoleLogger", { name: "zfx" });
+logger.log("i am from consoleLogger", "hello");
 logger.warn("i am from consoleLogger", 1, "any");
 logger.error("i am from consoleLogger", new Error("test"));
 
 await logger.initFileLogger("../log");
 
 // file and console
+logger.debug("i am from consoleLogger", "debug");
 logger.info("i am from fileLogger", { name: "zfx" });
+logger.log("i am from consoleLogger", "hello");
 logger.warn("i am from fileLogger", 1, "any");
 logger.error("i am from fileLogger", new Error("test"));
 ```

deno.lock

@@ -1,4 +1,34 @@
-export { green, red, stripAnsiCode, yellow } from "jsr:@std/fmt@1.0.3/colors";
-// UNSTABLE
-export { writeAll } from "jsr:@std/io@0.225.0/write-all";
-export { exists } from "jsr:@std/fs@1.0.5";
+export {
+  cyan,
+  gray,
+  green,
+  red,
+  stripAnsiCode,
+  yellow,
+} from "jsr:@std/fmt@1.0.3/colors";
+
+/**
+ * use a local copy of UNSTABLE { type Writer, writeAll } from "jsr:@std/io@0.225.0/write-all";
+ */
+export interface Writer {
+  /** Writes `p.byteLength` bytes from `p` to the underlying data stream. It
+   * resolves to the number of bytes written from `p` (`0` <= `n` <=
+   * `p.byteLength`) or reject with the error encountered that caused the
+   * write to stop early. `write()` must reject with a non-null error if
+   * would resolve to `n` < `p.byteLength`. `write()` must not modify the
+   * slice data, even temporarily.
+   *
+   * Implementations should not retain a reference to `p`.
+   */
+  write(p: Uint8Array): Promise<number>;
+}
+
+export async function writeAll(writer: Writer, data: Uint8Array) {
+  let nwritten = 0;
+  while (nwritten < data.length) {
+    nwritten += await writer.write(data.subarray(nwritten));
+  }
+}
+export { exists } from "jsr:@std/fs@^1.0.6";
+
+export { stat } from "node:fs/promises";

deps.ts

@@ -1,15 +1,17 @@
 import stdout from "./stdout.ts";
 import Writer from "./writer.ts";
 import eol from "./eol.ts";
-import { exists } from "./deps.ts";
 import Dater from "./date.ts";
-import { green, red, stripAnsiCode, yellow } from "./deps.ts";
+import { cyan, exists, green, red, stripAnsiCode, yellow } from "./deps.ts";
 import type { fileLoggerOptions, LoggerWriteOptions } from "./interface.ts";
 import Types from "./types.ts";
+
 const { inspect } = Deno;
 
 const noop = async () => {};
 
+export type LoggerType = "debug" | "info" | "log" | "warn" | "error";
+
 /**
  * Logger class
  */
@@ -20,7 +22,9 @@ export default class Logger {
   private rotate = false;
   private dir?: string;
 
+  #debug = this.debug;
   #info = this.info;
+  #log = this.log;
   #warn = this.warn;
   #error = this.error;
   #write = this.write;
@@ -38,6 +42,21 @@ export default class Logger {
     return this.encoder.encode(stripAnsiCode(msg) + eol);
   }
 
+  /**
+   * Log message with debug level
+   * @param args data to log
+   */
+  async debug(...args: unknown[]): Promise<void> {
+    args = [this.getDebug(), ...args];
+    this.stdout(...args);
+    if (this.dir) {
+      await this.write({
+        dir: this.dir,
+        type: Types.DEBUG,
+        args,
+      });
+    }
+  }
   /**
    * Log message with info level
    * @param args data to log
@@ -54,6 +73,22 @@ export default class Logger {
     }
   }
 
+  /**
+   * Log message with info level
+   * @param args data to log
+   */
+  async log(...args: unknown[]): Promise<void> {
+    args = [this.getLog(), ...args];
+    this.stdout(...args);
+    if (this.dir) {
+      await this.write({
+        dir: this.dir,
+        type: Types.LOG,
+        args,
+      });
+    }
+  }
+
   /**
    * Log message with warning level
    * @param args data to log
@@ -126,17 +161,27 @@ export default class Logger {
    * disable a specific type of logger
    * @param type Level of logger to disable
    */
-  disable(type?: "info" | "warn" | "error"): void {
+  disable(type?: LoggerType): void {
     if (!type) {
+      this.debug = noop;
       this.info = noop;
+      this.log = noop;
       this.warn = noop;
       this.error = noop;
       return;
     }
+    if (type === "debug") {
+      this.debug = noop;
+      return;
+    }
     if (type === "info") {
       this.info = noop;
       return;
     }
+    if (type === "log") {
+      this.log = noop;
+      return;
+    }
     if (type === "warn") {
       this.warn = noop;
       return;
@@ -151,16 +196,26 @@ export default class Logger {
    * Enable a specific type of logger
    * @param type Level of logger to enable
    */
-  enable(type?: "info" | "warn" | "error"): void {
+  enable(type?: LoggerType): void {
     if (!type) {
+      this.debug = this.#debug;
       this.info = this.#info;
+      this.log = this.#log;
       this.warn = this.#warn;
       this.error = this.#error;
     }
+    if (type === "debug") {
+      this.debug = this.#debug;
+      return;
+    }
     if (type === "info") {
       this.info = this.#info;
       return;
     }
+    if (type === "log") {
+      this.log = this.#log;
+      return;
+    }
     if (type === "warn") {
       this.warn = this.#warn;
       return;
@@ -199,8 +254,16 @@ export default class Logger {
     this.write = this.#write;
   }
 
+  private getDebug(): string {
+    return green(this.getNow() + cyan(` Debug:`));
+  }
+
   private getInfo(): string {
-    return green(`${this.getNow()} Info:`);
+    return green(this.getNow() + green(` Info:`));
+  }
+
+  private getLog(): string {
+    return green(`${this.getNow()} Log:`);
   }
 
   private getWarn(): string {

logger.ts

@@ -17,7 +17,9 @@ import { Logger } from "jsr:@deno-library/logger";
 
 const logger = new Logger();
 
+logger.debug("i am from consoleLogger", "debug");
 logger.info("i am from consoleLogger", { name: "zfx" });
+logger.log("i am from consoleLogger", "hello");
 logger.warn("i am from consoleLogger", 1, "any");
 logger.error("i am from consoleLogger", new Error("test"));
 ```
@@ -30,14 +32,18 @@ import { Logger } from "jsr:@deno-library/logger";
 const logger = new Logger();
 
 // console only
+logger.debug("i am from consoleLogger", "debug");
 logger.info("i am from consoleLogger", { name: "zfx" });
+logger.log("i am from consoleLogger", "hello");
 logger.warn("i am from consoleLogger", 1, "any");
 logger.error("i am from consoleLogger", new Error("test"));
 
 await logger.initFileLogger("../log");
 
 // file and console
+logger.debug("i am from consoleLogger", "debug");
 logger.info("i am from fileLogger", { name: "zfx" });
+logger.log("i am from consoleLogger", "hello");
 logger.warn("i am from fileLogger", 1, "any");
 logger.error("i am from fileLogger", new Error("test"));
 ```
@@ -307,7 +313,7 @@ interface LoggerInerface {
 /**
  * The Logger class
  */
-export { default as Logger } from "./logger.ts";
+export { default as Logger, type LoggerType } from "./logger.ts";
 /**
  * The Logger class default instance
  */

mod.ts

@@ -2,7 +2,9 @@
  * Types of messages that can be logged.
  */
 export const enum Types {
+  DEBUG = "debug",
   INFO = "info",
+  LOG = "log",
   WARN = "warn",
   ERROR = "error",
 }

types.ts

@@ -11,7 +11,9 @@ export default class Writer {
   private maxBackupCount?: number;
   private pathWriterMap = new Map();
 
+  private [Types.DEBUG]: string = "";
   private [Types.INFO]: string = "";
+  private [Types.LOG]: string = "";
   private [Types.WARN]: string = "";
   private [Types.ERROR]: string = "";