feat(logs@3): allow json logging; be colorless by default

Author: egasimus

logs/README.md

@@ -4,6 +4,28 @@
 
 Exports a `Console` class in ESM and CJS formats.
 
+Usage:
+
+```js
+import { Console } from '@hackbg/logs'
+// or
+const { Console } = require('@hackbg/logs')
+
+const console = new Console("label", {
+  color: true, // or false
+  json:  true, // or false
+})
+console("asdf")
+console.log("asdf")
+console.warn("asdf")
+console.error("asdf")
+console.debug("asdf")
+console.trace("asdf")
+console.table([["asdf","qwer"],["zxcv","uiop"]])
+console.table([{asdf:"qwer"},{zxcv:"uiop"}])
+console.table({foo:{asdf:"qwer"},bar:{zxcv:"uiop"}})
+```
+
 ## TODO:
 
 * [ ] Honor `NO_COLOR`

logs/logs.cjs

@@ -10,13 +10,35 @@ const timestamp = module.exports.timestamp = function timestamp (d = new Date())
     .replace(/[T]/g, '_')
     .slice(0, -3)
 }
+const serializer = (k, v) => (typeof v === 'bigint') ? String(v) : v
+const toJSON = data => JSON.stringify(data, serializer)
 const Console = module.exports.Console = class Console extends defineCallable(function log(...args){
   this.log(...args)
 }) {
   constructor (label, options = {}) {
     super()
     this.label  = options.label  ?? label ?? ''
     this.parent = options.parent ?? console
+    this._print = options.json
+      ? (method, tag, message) => {
+          this.parent[method](toJSON({ logTag: tag, logMethod: method, logMessage: message }))
+          return this
+        }
+      : (method, tag, ...args) => {
+          this.parent[method](tag, ...args)
+          return this
+        }
+    this._tag = (!options.noColor || options.color)
+      ? (color, string) => {
+         const tag1 = (string ? (chalk.inverse(color(bold(string))) + (this.label ? ' ' : '')) : '')
+         const tag2 = (this.label ? color(this.label) : '')
+         return tag1 + tag2
+       }
+     : (color, string) => {
+         const tag1 = string
+         const tag2 = this.label
+         return tag1 + tag2
+       }
     hideProperties(this,
       'label', 'tags', 'tag', '_tag', 'parent', 'sub',
       'br', 'log', 'info', 'warn', 'error', 'debug', 'trace', 'table', 
@@ -37,13 +59,6 @@ const Console = module.exports.Console = class Console extends defineCallable(fu
     this._print('log', this._tag(chalk.white,   'TABLE '));
     this._print('table', ...args)
   }
-  _print = (method, tag, ...args) => {
-    this.parent[method](tag, ...args);
-    return this
-  }
-  _tag = (color, string) => {
-    return (string ? (chalk.inverse(color(bold(string))) + ' ') : '') + color(this.label)
-  }
   get [Symbol.toStringTag]() {
     return this.label
   }

logs/logs.mjs

@@ -14,24 +14,48 @@ export function timestamp (d = new Date()) {
     .slice(0, -3)
 }
 
+const serializer = (k, v) => (typeof v === 'bigint') ? String(v) : v
+const toJSON = data => JSON.stringify(data, serializer)
+
 export class Console extends defineCallable(function log(...args){
   this.log(...args)
 }) {
 
   constructor (label, options = {}) {
     super()
-    this.label = options.label ?? label ?? this.label ?? ''
+    this.label  = options.label ?? label ?? this.label ?? ''
     this.parent = options.parent ?? console
+    this._print = options.json
+      ? (method, tag, message) => {
+          this.parent[method](toJSON({ logTag: tag, logMethod: method, logMessage: message }))
+          return this
+        }
+      : (method, tag, ...args) => {
+          this.parent[method](tag, ...args)
+          return this
+        }
+    this._tag = (options.color && !options.json)
+      ? (color, string) => {
+         const tag1 = (string ? (chalk.inverse(color(bold(string))) + (this.label ? ' ' : '')) : '')
+         const tag2 = (this.label ? color(this.label) : '')
+         return tag1 + tag2
+       }
+     : (color, string) => {
+         const tag1 = string
+         const tag2 = this.label
+         return tag1 + tag2
+       }
     hideProperties(this,
-      'label', 'tags', 'tag', '_tag', 'parent', 'sub',
+      'label', 'tags', 'tag', '_tag', '_print', 'parent', 'sub',
       'br', 'log', 'info', 'warn', 'error', 'debug', 'trace', 'table', 
       '_print',
     )
   }
 
   label
-
   parent
+  _print
+  _tag
 
   sub = (label, options = {}) => new SubConsole(label, { ...options, parent: this })
   br = () => { this.parent.log(); return this }
@@ -46,16 +70,6 @@ export class Console extends defineCallable(function log(...args){
     this._print('table', ...args)
   }
 
-  _print = (method, tag, ...args) => {
-    this.parent[method](tag, ...args);
-    return this
-  }
-
-  _tag = (color, string) => {
-    const tag1 = (string ? (chalk.inverse(color(bold(string))) + (this.label ? ' ' : '')) : '')
-    const tag2 = (this.label ? color(this.label) : '')
-    return tag1 + tag2
-  }
 
   get [Symbol.toStringTag]() {
     return this.label

logs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hackbg/logs",
-  "version": "2.3.3",
+  "version": "3.0.0",
   "main": "./logs.mjs",
   "types": "./logs.d.ts",
   "type": "module",
@@ -29,7 +29,7 @@
   },
   "scripts": {
     "ubik": "npm test && npm run check && ubik",
-    "test": "true || ganesha-node README.md",
+    "test": "node test.cjs",
     "check": "tsc --noEmit",
     "clean": "ubik clean && rm -rf dist types *.dist.*",
     "release": "pnpm check && pnpm test && ubik release --access public --otp 123123"

logs/test.cjs

@@ -0,0 +1,19 @@
+;(async function testLogs () {
+  const logsMjs = await import('./logs.mjs')
+  const logsCjs = require('./logs.cjs')
+  for (const [variant, { Console }] of Object.entries({logsMjs, logsCjs})) {
+    for (const color of [true, false]) {
+      for (const json of [true, false]) {
+        console.log('\nTesting with', { variant, color, json })
+        const logger = new Console("Testing!", { color, json })
+        for (const method of ['log', 'info', 'warn', 'error', 'debug', 'trace']) {
+          logger[method]("hello")
+          logger[method]({ json: "object", bigint: 100n })
+          logger.table([["asdf","qwer"],["zxcv","uiop"]])
+          logger.table([{asdf:"qwer"},{zxcv:"uiop"}])
+          logger.table({foo:{asdf:"qwer"},bar:{zxcv:"uiop"}})
+        }
+      }
+    }
+  }
+})()