@gesslar/toolkit 2.4.0 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/toolkit",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "A collection of utilities for Node.js and browser environments.",
   "main": "./src/index.js",
   "type": "module",

package/src/lib/Glog.js

@@ -33,6 +33,15 @@ export const loggerColours = {
   reset: "{/}",      // Reset
 }
 
+// Symbol alternatives for tags
+export const logSymbols = {
+  debug: "?",
+  info: "i",
+  warn: "!",
+  error: "✗",
+  success: "✓"
+}
+
 // Set up convenient aliases for common log colors
 c.alias.set("debug", "{F033}")
 c.alias.set("info", "{F036}")
@@ -50,6 +59,7 @@ class Glog {
   static colors = null
   static stackTrace = false
   static name = ""
+  static tagsAsStrings = false
 
   // Instance properties (for configured loggers)
   #logLevel = 0
@@ -57,6 +67,8 @@ class Glog {
   #colors = null
   #stackTrace = false
   #name = ""
+  #tagsAsStrings = false
+  #displayName = true
   #vscodeError = null
   #vscodeWarn = null
   #vscodeInfo = null
@@ -87,6 +99,8 @@ class Glog {
     this.#logPrefix = options.prefix ?? this.#logPrefix
     this.#colors = options.colors ?? this.#colors
     this.#stackTrace = options.stackTrace ?? this.#stackTrace
+    this.#tagsAsStrings = options.tagsAsStrings ?? this.#tagsAsStrings
+    this.#displayName = options.displayName ?? this.#displayName
 
     return this
   }
@@ -123,6 +137,12 @@ class Glog {
     return this
   }
 
+  static withTagsAsStrings(enabled = false) {
+    this.tagsAsStrings = enabled
+
+    return this
+  }
+
   // === FLUENT INSTANCE CREATION ===
 
   static create(options = {}) {
@@ -159,6 +179,18 @@ class Glog {
     return this
   }
 
+  withTagsAsStrings(enabled = false) {
+    this.#tagsAsStrings = enabled
+
+    return this
+  }
+
+  noDisplayName() {
+    this.#displayName = false
+
+    return this
+  }
+
   // === UTILITY METHODS ===
 
   get name() {
@@ -182,19 +214,28 @@ class Glog {
   #compose(level, message, debugLevel = 0) {
     const colors = this.#colors || Glog.colors || loggerColours
     const name = this.#name || Glog.name || "Log"
-    const tag = Util.capitalize(level)
+    const useStrings = this.#tagsAsStrings || Glog.tagsAsStrings
+    const showName = this.#displayName
+    const tag = useStrings ? Util.capitalize(level) : logSymbols[level]
+    const namePrefix = showName ? `[${name}] ` : ""
 
     if(!colors) {
-      return `[${name}] ${tag}: ${message}`
+      return useStrings
+        ? `${namePrefix}${tag}: ${message}`
+        : `${namePrefix}${tag} ${message}`
     }
 
     if(level === "debug") {
       const colorCode = colors[level][debugLevel] || colors[level][0]
 
-      return c`[${name}] ${colorCode}${tag}{/}: ${message}`
+      return useStrings
+        ? c`${namePrefix}${colorCode}${tag}{/}: ${message}`
+        : c`${namePrefix}${colorCode}${tag}{/} ${message}`
     }
 
-    return c`[${name}] ${colors[level]}${tag}{/}: ${message}`
+    return useStrings
+      ? c`${namePrefix}${colors[level]}${tag}{/}: ${message}`
+      : c`${namePrefix}${colors[level]}${tag}{/} ${message}`
   }
 
   // Stack trace functionality - simplified for now
@@ -342,7 +383,16 @@ class Glog {
    * @param {...unknown} args - Additional arguments
    */
   success(message, ...args) {
-    Term.log(c`[${this.#name || Glog.name || "Log"}] {success}Success{/}: ${message}`, ...args)
+    const name = this.#name || Glog.name || "Log"
+    const useStrings = this.#tagsAsStrings || Glog.tagsAsStrings
+    const showName = this.#displayName
+    const tag = useStrings ? "Success" : logSymbols.success
+    const namePrefix = showName ? `[${name}] ` : ""
+    const formatted = useStrings
+      ? c`${namePrefix}{success}${tag}{/}: ${message}`
+      : c`${namePrefix}{success}${tag}{/} ${message}`
+
+    Term.log(formatted, ...args)
   }
 
   /**
@@ -352,7 +402,143 @@ class Glog {
    * @param {...unknown} args - Additional arguments to log
    */
   static success(message, ...args) {
-    Term.log(c`[${this.name || "Log"}] {success}Success{/}: ${message}`, ...args)
+    const name = this.name || "Log"
+    const useStrings = this.tagsAsStrings
+    const tag = useStrings ? "Success" : logSymbols.success
+    const formatted = useStrings
+      ? c`[${name}] {success}${tag}{/}: ${message}`
+      : c`[${name}] {success}${tag}{/} ${message}`
+
+    Term.log(formatted, ...args)
+  }
+
+  /**
+   * Static group method - start a console group for indented output
+   *
+   * @param {...unknown} args - Optional group label
+   */
+  static group(...args) {
+    const name = this.name || "Log"
+    const label = args.length > 0 ? ` ${args.join(" ")}` : ""
+
+    Term.group(`[${name}]${label}`)
+  }
+
+  /**
+   * Static groupEnd method - end the current console group
+   */
+  static groupEnd() {
+    Term.groupEnd()
+  }
+
+  /**
+   * Static groupDebug - start a debug-tagged group
+   *
+   * @param {string} message - Group label
+   * @param {number} [level=1] - Debug level
+   */
+  static groupDebug(message, level = 1) {
+    const colors = this.colors || loggerColours
+    const name = this.name || "Log"
+    const useStrings = this.tagsAsStrings
+    const tag = useStrings ? "Debug" : logSymbols.debug
+    const colorCode = colors.debug[level] || colors.debug[0]
+    const label = useStrings
+      ? c`[${name}] ${colorCode}${tag}{/}: ${message}`
+      : c`[${name}] ${colorCode}${tag}{/} ${message}`
+
+    Term.group(label)
+  }
+
+  /**
+   * Static groupInfo - start an info-tagged group
+   *
+   * @param {string} message - Group label
+   */
+  static groupInfo(message) {
+    const colors = this.colors || loggerColours
+    const name = this.name || "Log"
+    const useStrings = this.tagsAsStrings
+    const tag = useStrings ? "Info" : logSymbols.info
+    const label = useStrings
+      ? c`[${name}] ${colors.info}${tag}{/}: ${message}`
+      : c`[${name}] ${colors.info}${tag}{/} ${message}`
+
+    Term.group(label)
+  }
+
+  /**
+   * Static groupSuccess - start a success-tagged group
+   *
+   * @param {string} message - Group label
+   */
+  static groupSuccess(message) {
+    const name = this.name || "Log"
+    const useStrings = this.tagsAsStrings
+    const tag = useStrings ? "Success" : logSymbols.success
+    const label = useStrings
+      ? c`[${name}] {success}${tag}{/}: ${message}`
+      : c`[${name}] {success}${tag}{/} ${message}`
+
+    Term.group(label)
+  }
+
+  /**
+   * Start a console group for indented output
+   *
+   * @param {...unknown} args - Optional group label
+   */
+  group(...args) {
+    const name = this.#name || Glog.name || "Log"
+    const showName = this.#displayName
+    const label = args.length > 0 ? ` ${args.join(" ")}` : ""
+    const output = showName ? `[${name}]${label}` : label.trim()
+
+    Term.group(output)
+  }
+
+  /**
+   * End the current console group
+   */
+  groupEnd() {
+    Term.groupEnd()
+  }
+
+  /**
+   * Start a debug-tagged group
+   *
+   * @param {string} message - Group label
+   * @param {number} [level=1] - Debug level
+   */
+  groupDebug(message, level = 1) {
+    Term.group(this.#compose("debug", message, level))
+  }
+
+  /**
+   * Start an info-tagged group
+   *
+   * @param {string} message - Group label
+   */
+  groupInfo(message) {
+    Term.group(this.#compose("info", message))
+  }
+
+  /**
+   * Start a success-tagged group
+   *
+   * @param {string} message - Group label
+   */
+  groupSuccess(message) {
+    const name = this.#name || Glog.name || "Log"
+    const useStrings = this.#tagsAsStrings || Glog.tagsAsStrings
+    const showName = this.#displayName
+    const tag = useStrings ? "Success" : logSymbols.success
+    const namePrefix = showName ? `[${name}] ` : ""
+    const label = useStrings
+      ? c`${namePrefix}{success}${tag}{/}: ${message}`
+      : c`${namePrefix}{success}${tag}{/} ${message}`
+
+    Term.group(label)
   }
 
   /**
@@ -434,6 +620,44 @@ class Glog {
   get colours() {
     return c
   }
+
+  /**
+   * Get a raw logger that outputs without name/tag formatting
+   *
+   * @returns {object} Raw logger interface
+   */
+  get raw() {
+    return {
+      debug: (message, ...args) => Term.debug(message, ...args),
+      info: (message, ...args) => Term.info(message, ...args),
+      warn: (message, ...args) => Term.warn(message, ...args),
+      error: (message, ...args) => Term.error(message, ...args),
+      log: (...args) => Term.log(...args),
+      success: (message, ...args) => Term.log(message, ...args),
+      table: (data, options) => Term.table(data, options || {}),
+      group: (...args) => Term.group(...args),
+      groupEnd: () => Term.groupEnd()
+    }
+  }
+
+  /**
+   * Static raw logger that outputs without name/tag formatting
+   *
+   * @returns {object} Raw logger interface
+   */
+  static get raw() {
+    return {
+      debug: (message, ...args) => Term.debug(message, ...args),
+      info: (message, ...args) => Term.info(message, ...args),
+      warn: (message, ...args) => Term.warn(message, ...args),
+      error: (message, ...args) => Term.error(message, ...args),
+      log: (...args) => Term.log(...args),
+      success: (message, ...args) => Term.log(message, ...args),
+      table: (data, options) => Term.table(data, options || {}),
+      group: (...args) => Term.group(...args),
+      groupEnd: () => Term.groupEnd()
+    }
+  }
 }
 
 // Wrap in proxy for dual usage

package/src/types/lib/Glog.d.ts

@@ -5,6 +5,17 @@ export namespace loggerColours {
     let error: string;
     let reset: string;
 }
+export namespace logSymbols {
+    let debug_1: string;
+    export { debug_1 as debug };
+    let info_1: string;
+    export { info_1 as info };
+    let warn_1: string;
+    export { warn_1 as warn };
+    let error_1: string;
+    export { error_1 as error };
+    export let success: string;
+}
 declare const _default: typeof Glog;
 export default _default;
 declare class Glog {
@@ -13,6 +24,7 @@ declare class Glog {
     static colors: any;
     static stackTrace: boolean;
     static name: string;
+    static tagsAsStrings: boolean;
     static setLogPrefix(prefix: any): typeof Glog;
     static setLogLevel(level: any): typeof Glog;
     static withName(name: any): typeof Glog;
@@ -24,6 +36,7 @@ declare class Glog {
         reset: string;
     }): typeof Glog;
     static withStackTrace(enabled?: boolean): typeof Glog;
+    static withTagsAsStrings(enabled?: boolean): typeof Glog;
     static create(options?: {}): Glog;
     static execute(...args: any[]): void;
     /**
@@ -40,6 +53,35 @@ declare class Glog {
      * @param {...unknown} args - Additional arguments to log
      */
     static success(message: string, ...args: unknown[]): void;
+    /**
+     * Static group method - start a console group for indented output
+     *
+     * @param {...unknown} args - Optional group label
+     */
+    static group(...args: unknown[]): void;
+    /**
+     * Static groupEnd method - end the current console group
+     */
+    static groupEnd(): void;
+    /**
+     * Static groupDebug - start a debug-tagged group
+     *
+     * @param {string} message - Group label
+     * @param {number} [level=1] - Debug level
+     */
+    static groupDebug(message: string, level?: number): void;
+    /**
+     * Static groupInfo - start an info-tagged group
+     *
+     * @param {string} message - Group label
+     */
+    static groupInfo(message: string): void;
+    /**
+     * Static groupSuccess - start a success-tagged group
+     *
+     * @param {string} message - Group label
+     */
+    static groupSuccess(message: string): void;
     /**
      * Static table method
      *
@@ -63,6 +105,12 @@ declare class Glog {
      * @returns {Glog} The Glog class for chaining.
      */
     static setAlias(alias: string, colorCode: string): Glog;
+    /**
+     * Static raw logger that outputs without name/tag formatting
+     *
+     * @returns {object} Raw logger interface
+     */
+    static get raw(): object;
     constructor(options?: {});
     setOptions(options: any): this;
     withName(name: any): this;
@@ -76,6 +124,8 @@ declare class Glog {
         reset: string;
     }): this;
     withStackTrace(enabled?: boolean): this;
+    withTagsAsStrings(enabled?: boolean): this;
+    noDisplayName(): this;
     get name(): string;
     get debugLevel(): number;
     get options(): {
@@ -117,6 +167,35 @@ declare class Glog {
      * @param {...unknown} args - Additional arguments
      */
     success(message: string, ...args: unknown[]): void;
+    /**
+     * Start a console group for indented output
+     *
+     * @param {...unknown} args - Optional group label
+     */
+    group(...args: unknown[]): void;
+    /**
+     * End the current console group
+     */
+    groupEnd(): void;
+    /**
+     * Start a debug-tagged group
+     *
+     * @param {string} message - Group label
+     * @param {number} [level=1] - Debug level
+     */
+    groupDebug(message: string, level?: number): void;
+    /**
+     * Start an info-tagged group
+     *
+     * @param {string} message - Group label
+     */
+    groupInfo(message: string): void;
+    /**
+     * Start a success-tagged group
+     *
+     * @param {string} message - Group label
+     */
+    groupSuccess(message: string): void;
     /**
      * Display tabular data as a table
      *
@@ -138,6 +217,12 @@ declare class Glog {
      * @returns {import('@gesslar/colours')} The colours template function from \@gesslar/colours
      */
     get colours(): typeof import("@gesslar/colours");
+    /**
+     * Get a raw logger that outputs without name/tag formatting
+     *
+     * @returns {object} Raw logger interface
+     */
+    get raw(): object;
     #private;
 }
 //# sourceMappingURL=Glog.d.ts.map

package/src/types/lib/Glog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Glog.d.ts","sourceRoot":"","sources":["../../lib/Glog.js"],"names":[],"mappings":";;;;;;;;;AA6CA;IAEE,wBAAmB;IACnB,yBAAqB;IACrB,mBAAoB;IACpB,2BAAyB;IACzB,oBAAgB;IA4ChB,8CAIC;IAED,4CAIC;IAED,wCAIC;IAED;;;;;;oBAIC;IAED,sDAIC;IAID,kCAEC;IAwJD,qCAoBC;IAuBD;;;;;OAKG;IACH,yBAHW,KAAK,CAAC,MAAM,CAAC,aACV,OAAO,EAAA,QAOpB;IAYD;;;;;OAKG;IACH,wBAHW,MAAM,WACH,OAAO,EAAA,QAIpB;IA+BD;;;;;;;;;OASG;IACH,mBAPW,MAAM,QAAQ,mBACd,MAAM,GAAG,MAAM,YAEvB;QAAgC,UAAU,GAAlC,KAAK,CAAC,MAAM,CAAC;QACK,UAAU,GAA5B,OAAO;QACW,aAAa,GAA/B,OAAO;KACjB,QAkBA;IAED;;;;;;OAMG;IACH,uBAJW,MAAM,aACN,MAAM,GACJ,IAAI,CAMhB;IA3WD,0BAgBC;IAID,+BAQC;IAwCD,0BAIC;IAED,+BAIC;IAED,8BAIC;IAED;;;;;;aAIC;IAED,wCAIC;IAID,mBAEC;IAED,yBAEC;IAED;;;;;;MAQC;IAqBD,8BAGC;IAED,wBAQC;IA8BD;;;;;;;;;OASG;IACH,eALW,MAAM,UACN,MAAM,UACH,OAAO,EAAA,QAapB;IAED,wCAGC;IAED,wCAGC;IAED,yCAGC;IA0BD,8BAEC;IAID;;;;;;OAMG;IACH,kBAJW,KAAK,CAAC,MAAM,CAAC,aACV,OAAO,EAAA,QAQpB;IAeD;;;;;OAKG;IACH,iBAHW,MAAM,WACH,OAAO,EAAA,QAIpB;IAYD;;;;;;;;;OASG;IACH,YAPW,MAAM,QAAQ,mBACd,MAAM,GAAG,MAAM,YAEvB;QAAgC,UAAU,GAAlC,KAAK,CAAC,MAAM,CAAC;QACK,UAAU,GAA5B,OAAO;QACW,aAAa,GAA/B,OAAO;KACjB,QAkBA;IA4CD;;;;OAIG;IACH,iDAEC;;CACF"}
+{"version":3,"file":"Glog.d.ts","sourceRoot":"","sources":["../../lib/Glog.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAsDA;IAEE,wBAAmB;IACnB,yBAAqB;IACrB,mBAAoB;IACpB,2BAAyB;IACzB,oBAAgB;IAChB,8BAA4B;IAgD5B,8CAIC;IAED,4CAIC;IAED,wCAIC;IAED;;;;;;oBAIC;IAED,sDAIC;IAED,yDAIC;IAID,kCAEC;IA6KD,qCAoBC;IAuBD;;;;;OAKG;IACH,yBAHW,KAAK,CAAC,MAAM,CAAC,aACV,OAAO,EAAA,QAOpB;IAqBD;;;;;OAKG;IACH,wBAHW,MAAM,WACH,OAAO,EAAA,QAWpB;IAED;;;;OAIG;IACH,sBAFc,OAAO,EAAA,QAOpB;IAED;;OAEG;IACH,wBAEC;IAED;;;;;OAKG;IACH,2BAHW,MAAM,UACN,MAAM,QAahB;IAED;;;;OAIG;IACH,0BAFW,MAAM,QAYhB;IAED;;;;OAIG;IACH,6BAFW,MAAM,QAWhB;IAyFD;;;;;;;;;OASG;IACH,mBAPW,MAAM,QAAQ,mBACd,MAAM,GAAG,MAAM,YAEvB;QAAgC,UAAU,GAAlC,KAAK,CAAC,MAAM,CAAC;QACK,UAAU,GAA5B,OAAO;QACW,aAAa,GAA/B,OAAO;KACjB,QAkBA;IAED;;;;;;OAMG;IACH,uBAJW,MAAM,aACN,MAAM,GACJ,IAAI,CAMhB;IA8BD;;;;OAIG;IACH,kBAFa,MAAM,CAclB;IAxkBD,0BAgBC;IAID,+BAUC;IA8CD,0BAIC;IAED,+BAIC;IAED,8BAIC;IAED;;;;;;aAIC;IAED,wCAIC;IAED,2CAIC;IAED,sBAIC;IAID,mBAEC;IAED,yBAEC;IAED;;;;;;MAQC;IA8BD,8BAGC;IAED,wBAQC;IA8BD;;;;;;;;;OASG;IACH,eALW,MAAM,UACN,MAAM,UACH,OAAO,EAAA,QAapB;IAED,wCAGC;IAED,wCAGC;IAED,yCAGC;IA0BD,8BAEC;IAID;;;;;;OAMG;IACH,kBAJW,KAAK,CAAC,MAAM,CAAC,aACV,OAAO,EAAA,QAQpB;IAeD;;;;;OAKG;IACH,iBAHW,MAAM,WACH,OAAO,EAAA,QAapB;IA0FD;;;;OAIG;IACH,eAFc,OAAO,EAAA,QASpB;IAED;;OAEG;IACH,iBAEC;IAED;;;;;OAKG;IACH,oBAHW,MAAM,UACN,MAAM,QAIhB;IAED;;;;OAIG;IACH,mBAFW,MAAM,QAIhB;IAED;;;;OAIG;IACH,sBAFW,MAAM,QAahB;IAED;;;;;;;;;OASG;IACH,YAPW,MAAM,QAAQ,mBACd,MAAM,GAAG,MAAM,YAEvB;QAAgC,UAAU,GAAlC,KAAK,CAAC,MAAM,CAAC;QACK,UAAU,GAA5B,OAAO;QACW,aAAa,GAA/B,OAAO;KACjB,QAkBA;IA4CD;;;;OAIG;IACH,iDAEC;IAED;;;;OAIG;IACH,WAFa,MAAM,CAclB;;CAoBF"}