bare-console 2.0.2 → 3.1.0

package/README.md

@@ -8,8 +8,9 @@ npm i bare-console
 
 ## Usage
 
-```javascript
+```js
 const Console = require('bare-console')
+
 const console = new Console({ stdout: process.stdout, stderr: process.stderr })
 
 console.log('Hello')

package/index.js

@@ -1,28 +1,61 @@
-const { Crayon } = require('tiny-crayon')
+const inspect = require('bare-inspect')
 
 module.exports = class Console {
   constructor (opts = {}) {
-    const { isTTY } = adaptStream(opts.stdout || opts.stderr)
-    this.colors = typeof opts.colors === 'boolean' ? opts.colors : isTTY
-    this.crayon = new Crayon({ isTTY: this.colors })
+    this._stdout = adaptStream(opts.stdout)
+    this._stderr = adaptStream(opts.stderr)
+
+    this._colors = opts.colors === true
+    this._timers = new Map()
+
+    if (opts.bind) {
+      this.log = this.log.bind(this)
+      this.error = this.error.bind(this)
+      this.time = this.time.bind(this)
+      this.timeEnd = this.timeEnd.bind(this)
+      this.trace = this.trace.bind(this)
+    }
+  }
+
+  log (...args) {
+    let out = ''
+    let first = true
+
+    for (const arg of args) {
+      if (first) first = false
+      else out += ' '
+
+      out += typeof arg === 'string' ? arg : inspect(arg, { colors: this._colors })
+    }
+
+    this._stdout.write(out + '\n')
+  }
+
+  error (...args) {
+    let out = ''
+    let first = true
 
-    this.log = this._print.bind(this, adaptStream(opts.stdout))
-    this.error = this._print.bind(this, adaptStream(opts.stderr))
+    for (const arg of args) {
+      if (first) first = false
+      else out += ' '
+
+      out += typeof arg === 'string' ? arg : inspect(arg, { colors: this._colors })
+    }
 
-    this.times = new Map()
+    this._stderr.write(out + '\n')
   }
 
   time (label = 'default') {
-    if (this.times.has(label)) {
+    if (this._timers.has(label)) {
       this.error('Warning: Label \'' + label + '\' already exists for console.time()')
       return
     }
 
-    this.times.set(label, process.hrtime())
+    this._timers.set(label, process.hrtime())
   }
 
   timeEnd (label = 'default') {
-    const started = this.times.get(label)
+    const started = this._timers.get(label)
 
     if (!started) {
       this.error('Warning: No such label \'' + label + '\' for console.timeEnd()')
@@ -31,7 +64,7 @@ module.exports = class Console {
 
     const d = process.hrtime(started)
     const ms = d[0] * 1e3 + d[1] / 1e6
-    this.times.delete(label)
+    this._timers.delete(label)
 
     if (ms > 1000) this.log(label + ': ' + (ms / 1000).toFixed(3) + 's')
     else this.log(label + ': ' + ms.toFixed(3) + 'ms')
@@ -46,334 +79,8 @@ module.exports = class Console {
 
     this.error('Trace: ' + messages.join(' ') + stack.slice(start))
   }
-
-  // + clear () {}
-
-  _print (stream, ...args) {
-    const paint = new Paint(this.crayon)
-    let identifier = 0
-
-    for (let i = 0; i < args.length; i++) {
-      const arg = args[i]
-
-      const single = generateSingleValue(arg, { escape: false })
-      if (single !== null) {
-        paint.push('value', single)
-      } else if (typeof arg === 'object') {
-        let levels = 0
-
-        iterateObject(arg)
-
-        function iterateObject (arg, backward = new WeakSet(), forward = new WeakSet(), add = true) {
-          if (add) backward.add(arg)
-          else forward.add(arg)
-
-          const id = identifier++
-          const isArray = Array.isArray(arg)
-          const isBuffer = Buffer.isBuffer(arg) && arg.constructor.name === 'Buffer'
-          const isInts = !isBuffer && isIntArray(arg)
-          const isObject = !(isArray || isInts || isBuffer)
-          const brackets = isBuffer ? '<>' : (isInts || isArray ? '[]' : '{}')
-
-          levels++
-
-          if (levels >= 4 && !isObjectEmpty(arg)) {
-            let type = isArray ? 'Array' : (typeof arg)
-            type = type[0].toUpperCase() + type.slice(1)
-            paint.push('value', '[' + type + ']', { id, crayon: 'cyan' })
-            levels--
-            return paint.width[id]
-          }
-
-          if (isInts) paint.push('open', arg.constructor.name + '(' + arg.length + ') ', { id })
-          paint.push('open', brackets[0], { id })
-          if (isBuffer) paint.push('open', 'Buffer', { id })
-
-          const MAX = isObject ? Infinity : (isBuffer ? 50 : 100)
-          let count = 0
-
-          for (const key in arg) {
-            const k = isObject ? key : parseInt(key, 10)
-            const isNumeric = !isObject && isFinite(k)
-            const v = arg[isNumeric ? k : key]
-
-            if (isBuffer && !isNumeric && Object.hasOwn(Object.getPrototypeOf(arg), key)) continue
-
-            if (count++ >= MAX) break
-
-            if (count === 1) {
-              paint.push('spacing-start', null, { id, levels, isArray, isInts, isBuffer, arg, k })
-            } else {
-              paint.push('separator', isBuffer && isNumeric ? '' : ',', { id })
-              paint.push('spacing-sep', null, { id, levels, isArray, isInts, isBuffer, arg, k })
-            }
-
-            if (!isNumeric) {
-              const singleKey = generateSingleKey(key)
-              paint.push('key', [singleKey, ': '], { id })
-            }
-
-            const single = generateSingleValue(v, { levels, stringColor: true, intToHex: isBuffer })
-            if (single !== null) {
-              paint.push('value', single, { id })
-            } else if (typeof v === 'object') {
-              if (backward.has(v) || (!add && forward.has(v))) {
-                paint.push('value', '[Circular]', { id, crayon: 'cyan' })
-                continue
-              }
-
-              const subWidth = iterateObject(v, backward, forward, false)
-              paint.width[id].child += subWidth.self + subWidth.child // + double check after colors fix
-            } else {
-              throw new Error('Argument not supported (' + (typeof v) + '): ' + v)
-            }
-          }
-
-          const symbols = Object.getOwnPropertySymbols(arg)
-
-          for (const symbol of symbols) {
-            count++
-
-            if (count === 1) {
-              paint.push('spacing-start', null, { id, levels })
-            } else {
-              paint.push('separator', ',', { id })
-              paint.push('spacing-sep', null, { id, levels })
-            }
-
-            if (!isArray) {
-              paint.push('key', ['[', { out: symbol.toString(), crayon: 'green' }, ']', ': '], { id })
-            }
-
-            const single = generateSingleValue(arg[symbol], { levels })
-            if (single === null) throw new Error('Symbol value not supported: (' + (typeof arg[symbol]) + '): ' + arg[symbol])
-            paint.push('value', single, { id })
-          }
-
-          if (!isObject && arg.length > MAX) paint.push('more', null, { id, levels, isArray, isInts, isBuffer, arg, left: (arg.length - MAX) })
-
-          if (count > 0) paint.push('spacing-end', null, { id, levels, isArray, isInts, isBuffer, arg })
-
-          if (count === 0 && isBuffer) paint.push('spacing-sep', null, { id, levels, isArray, isInts, isBuffer, arg })
-
-          paint.push('close', brackets[1], { id })
-
-          levels--
-
-          return paint.width[id]
-        }
-      } else {
-        throw new Error('Argument not supported (' + (typeof arg) + '): ' + arg)
-      }
-
-      if (i + 1 !== args.length) paint.push('space', ' ')
-    }
-
-    paint.push('break-line', '\n')
-
-    stream.write(paint.done())
-
-    function generateSingleKey (key) {
-      if (key === '') return { out: "''", crayon: 'green' }
-
-      const names = ['undefined', 'null', 'true', 'false', 'NaN', 'Infinity']
-      if (names.indexOf(key) > -1) return { out: key }
-
-      if (isKindOfAlphaNumeric(key) && !isFinite(key)) return { out: key }
-
-      return { out: "'" + key + "'", crayon: 'green' }
-    }
-
-    function generateSingleValue (value, { levels = 0, stringColor = false, escape = true, intToHex = false } = {}) {
-      if (typeof value === 'undefined') return { out: 'undefined', crayon: 'blackBright' }
-      if (value === null) return { out: 'null', crayon: 'bold' }
-
-      if (typeof value === 'string') return stringColor ? { out: dynamicQuotes(value, { escape }), crayon: 'green' } : { out: dynamicQuotes(value, { escape }) }
-      if (typeof value === 'number') return intToHex ? { out: numberToHex(value) } : { out: value.toString(), crayon: 'yellow' }
-      if (typeof value === 'boolean') return { out: value.toString(), crayon: 'yellow' }
-      if (typeof value === 'function') return { out: (value.name ? '[Function: ' + value.name + ']' : '[Function (anonymous)]'), crayon: 'cyan' }
-      if (typeof value === 'symbol') return { out: value.toString(), crayon: 'green' }
-      if (typeof value === 'bigint') return { out: value.toString() + 'n', crayon: 'yellow' } // + edge case: typeof Object(1n) === 'object'
-
-      if (value instanceof Promise) return { out: 'Promise' }
-      if (value instanceof RegExp) return { out: value.toString(), crayon: 'red' }
-
-      // + AggregateError?
-      if (value instanceof Error) return { out: value.stack } // This includes EvalError, RangeError, ReferenceError, SyntaxError, TypeError, URIError
-      if (value instanceof String) return { out: '[String: ' + dynamicQuotes(value.toString()) + ']', crayon: 'green' }
-      if (value instanceof Number) return { out: '[Number: ' + value.toString() + ']', crayon: 'yellow' }
-      if (value instanceof Boolean) return { out: '[Boolean: ' + value.toString() + ']', crayon: 'yellow' }
-      if (value instanceof Date) return { out: value.toISOString(), crayon: 'magenta' }
-
-      if (value instanceof Map) return { out: 'Map(' + value.size + ') {' + (value.size ? ' ... ' : '') + '}' }
-      if (value instanceof Set) return { out: 'Set(' + value.size + ') {' + (value.size ? ' ... ' : '') + '}' }
-
-      if (value instanceof WeakMap) return [{ out: 'WeakMap { ' }, { out: '<items unknown>', crayon: 'cyan' }, { out: ' }' }]
-      if (value instanceof WeakSet) return [{ out: 'WeakSet { ' }, { out: '<items unknown>', crayon: 'cyan' }, { out: ' }' }]
-
-      return null
-    }
-  }
-}
-
-function numberToHex (value) {
-  return value.toString(16).padStart(2, '0')
-}
-
-function isIntArray (value) {
-  if (value instanceof Uint8Array || value instanceof Uint16Array || value instanceof Uint32Array) return true
-  if (value instanceof Int8Array || value instanceof Int16Array || value instanceof Int32Array) return true
-  return false
-}
-
-function dynamicQuotes (str, opts = {}) {
-  if (opts.escape === false) return str
-
-  if (str.indexOf("'") === -1) return "'" + escapeString(str) + "'"
-  if (str.indexOf('"') === -1) return '"' + escapeString(str) + '"'
-  if (str.indexOf('`') === -1) return '`' + escapeString(str) + '`'
-
-  return "'" + escapeString(str, true) + "'"
-}
-
-function escapeString (str, singled = false) {
-  str = str
-    .replace(/[\\]/g, '\\\\')
-    .replace(/[/]/g, '\\/')
-    .replace(/[\b]/g, '\\b')
-    .replace(/[\f]/g, '\\f')
-    .replace(/[\n]/g, '\\n')
-    .replace(/[\r]/g, '\\r')
-    .replace(/[\t]/g, '\\t')
-
-  if (singled) str = str.replace(/[']/g, '\\\'')
-
-  return str
 }
 
 function adaptStream (stream) {
-  if (typeof stream === 'function') {
-    return { isTTY: true, write: stream }
-  }
-  return stream
-}
-
-class Paint {
-  constructor (crayon) {
-    this.prints = []
-    this.width = { all: 0 }
-    this.crayon = crayon
-  }
-
-  push (type, chunk = null, opts = {}) {
-    if (Array.isArray(chunk)) return chunk.forEach(value => this.push(type, value, opts))
-
-    let color = opts.crayon
-
-    if (chunk && typeof chunk === 'object') {
-      color = chunk.crayon
-      chunk = chunk.out
-    }
-
-    if (chunk !== null) {
-      this.width.all += chunk.length // + it's not including spaces as it's mostly dynamic
-
-      if (opts && opts.id !== undefined) {
-        if (!this.width[opts.id]) this.width[opts.id] = { self: 0, child: 0 }
-        this.width[opts.id].self += chunk.length
-      }
-    }
-
-    if (color) chunk = this.crayon[color](chunk)
-
-    this.prints.push({ type, chunk, ...opts })
-  }
-
-  done () {
-    let output = ''
-
-    for (const print of this.prints) {
-      // raw
-      if (['open', 'close', 'key', 'value', 'separator', 'space', 'break-line'].indexOf(print.type) > -1) {
-        output += print.chunk
-        continue
-      }
-
-      // dynamic
-      if (print.type === 'spacing-start' || print.type === 'spacing-sep' || print.type === 'spacing-end') {
-        const type = print.type.replace('spacing-', '')
-        const totalWidth = this.width[print.id] ? (this.width[print.id].self + this.width[print.id].child) : this.width.all
-        const expand = print.isInts || print.isArray || totalWidth > 60 // + 64? double check after colors fix
-        let arrayBreakpoint = 0
-
-        if (print.isInts || print.isArray) {
-          const lengths = [7, 9, 13, 17, 23, 29, 37, 45, 53]
-
-          for (let i = lengths.length - 1; i >= 0; i--) {
-            if (print.arg.length >= lengths[i]) {
-              arrayBreakpoint = 4 + i // Range: 4-12
-              break
-            }
-          }
-        }
-
-        if (print.isBuffer) {
-          if (type === 'start' || type === 'sep') output += ' '
-          continue
-        }
-
-        if (print.isInts || print.isArray) {
-          const addSpacing = arrayBreakpoint !== 0
-          const skipSpacing = type === 'sep' && !(print.k % arrayBreakpoint === 0)
-
-          if (!addSpacing || skipSpacing) {
-            output += ' '
-            continue
-          }
-        }
-
-        if (!expand) output += ' '
-        else output += '\n' + '  '.repeat(print.levels - (type === 'end' ? 1 : 0))
-
-        continue
-      }
-
-      if (print.type === 'more') {
-        const addSpacing = !print.isBuffer
-        const sep = print.isBuffer ? '' : ','
-
-        output += addSpacing ? (',\n' + '  '.repeat(print.levels)) : (sep + ' ')
-        output += '... ' + print.left + ' more ' + (print.isBuffer ? 'byte' : 'item') + (print.left >= 2 ? 's' : '')
-
-        continue
-      }
-
-      throw new Error('Invalid print: ' + JSON.stringify(print))
-    }
-
-    return output
-  }
-}
-
-function isObjectEmpty (obj) {
-  for (const k in obj) return false // eslint-disable-line no-unreachable-loop
-  return true
-}
-
-function isKindOfAlphaNumeric (str) {
-  for (let i = 0; i < str.length; i++) {
-    const code = str.charCodeAt(i)
-
-    // first char, and numeric (0-9)
-    if (i === 0 && (code > 47 && code < 58)) return false
-
-    if (!(code > 47 && code < 58) && // numeric (0-9)
-        !(code > 64 && code < 91) && // upper alpha (A-Z)
-        !(code > 96 && code < 123) && // lower alpha (a-z)
-        !(code === 95)) { // underscore (_)
-      return false
-    }
-  }
-
-  return true
+  return typeof stream === 'function' ? { write: stream } : stream
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "bare-console",
-  "version": "2.0.2",
+  "version": "3.1.0",
   "description": "Simple debugging console for JavaScript",
   "main": "index.js",
   "files": [
     "index.js"
   ],
   "scripts": {
-    "test": "standard && bare test.js"
+    "test": "standard && brittle test.js"
   },
   "repository": {
     "type": "git",
@@ -20,7 +20,7 @@
   },
   "homepage": "https://github.com/holepunchto/bare-console#readme",
   "dependencies": {
-    "tiny-crayon": "^1.0.4"
+    "bare-inspect": "^1.0.0"
   },
   "devDependencies": {
     "brittle": "^3.1.1",