bare-console 5.1.1 → 6.0.1

package/README.md

@@ -1,6 +1,6 @@
 # bare-console
 
-Simple debugging console for JavaScript.
+WHATWG debugging console for JavaScript.
 
 ```
 npm i bare-console
@@ -11,7 +11,7 @@ npm i bare-console
 ```js
 const Console = require('bare-console')
 
-const console = new Console({ stdout: process.stdout, stderr: process.stderr })
+const console = new Console()
 
 console.log('Hello')
 console.error(new Error('Something happened'))

package/global.d.ts

@@ -0,0 +1,5 @@
+import { Console } from '.'
+
+declare global {
+  const console: Console
+}

package/global.js

@@ -0,0 +1,3 @@
+const Console = require('.')
+
+global.console = new Console()

package/index.d.ts

@@ -0,0 +1,34 @@
+import Log from 'bare-logger'
+
+interface Console {
+  readonly Console: ConsoleConstructor
+
+  debug(...data: unknown[]): void
+  log(...data: unknown[]): void
+  info(...data: unknown[]): void
+  warn(...data: unknown[]): void
+  error(...data: unknown[]): void
+
+  clear(): void
+
+  time(label?: string): void
+  timeEnd(label?: string): void
+  timeLog(label?: string, ...data: unknown[]): void
+
+  assert(condition: unknown, ...data: unknown[]): void
+  count(label?: string): void
+  countReset(label?: string): void
+  trace(...data: unknown[]): void
+}
+
+declare class Console {
+  constructor(log?: Log)
+}
+
+type ConsoleConstructor = typeof Console
+
+declare namespace Console {
+  export { Console }
+}
+
+export = Console

package/index.js

@@ -1,72 +1,117 @@
-const { formatWithOptions } = require('bare-format')
+const Log = require('bare-logger')
 const hrtime = require('bare-hrtime')
 
-module.exports = class Console {
-  constructor (opts = {}) {
-    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.warn = this.warn.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)
+module.exports = exports = class Console {
+  constructor(log = new Log()) {
+    const timers = new Map()
+    const counters = new Map()
+
+    // https://console.spec.whatwg.org/#debug
+    this.debug = function debug(...data) {
+      log.debug(...data)
     }
-  }
 
-  log (...args) {
-    this._stdout.write(formatWithOptions({ colors: this._colors }, ...args) + '\n')
-  }
+    // https://console.spec.whatwg.org/#info
+    this.info = function info(...data) {
+      log.info(...data)
+    }
 
-  warn (...args) {
-    this._stderr.write(formatWithOptions({ colors: this._colors }, ...args) + '\n')
-  }
+    // https://console.spec.whatwg.org/#warn
+    this.warn = function warn(...data) {
+      log.warn(...data)
+    }
 
-  error (...args) {
-    this._stderr.write(formatWithOptions({ colors: this._colors }, ...args) + '\n')
-  }
+    // https://console.spec.whatwg.org/#error
+    this.error = function error(...data) {
+      log.error(...data)
+    }
 
-  time (label = 'default') {
-    if (this._timers.has(label)) {
-      this.error('Warning: Label \'' + label + '\' already exists for console.time()')
-      return
+    // https://console.spec.whatwg.org/#log
+    this.log = this.info
+
+    // https://console.spec.whatwg.org/#clear
+    this.clear = function clear() {
+      log.clear()
     }
 
-    this._timers.set(label, hrtime())
-  }
+    // https://console.spec.whatwg.org/#time
+    this.time = function time(label = 'default') {
+      if (timers.has(label)) {
+        this.warn(`Warning: Label '${label}' already exists for console.time()`)
+        return
+      }
+
+      timers.set(label, hrtime())
+    }
 
-  timeEnd (label = 'default') {
-    const started = this._timers.get(label)
+    // https://console.spec.whatwg.org/#timelog
+    this.timeLog = function timeLog(label = 'default', ...data) {
+      const started = timers.get(label)
 
-    if (!started) {
-      this.error('Warning: No such label \'' + label + '\' for console.timeEnd()')
-      return
+      if (started === undefined) {
+        this.warn(`Warning: No such label '${label}' for console.timeEnd()`)
+        return
+      }
+
+      const elapsed = hrtime(started)
+      const ms = elapsed[0] * 1e3 + elapsed[1] / 1e6
+
+      if (ms > 1000) this.log(`${label}: ${(ms / 1000).toFixed(3)}s`, ...data)
+      else this.log(`${label}: ${ms.toFixed(3)}ms`, ...data)
     }
 
-    const d = hrtime(started)
-    const ms = d[0] * 1e3 + d[1] / 1e6
-    this._timers.delete(label)
+    // https://console.spec.whatwg.org/#timeend
+    this.timeEnd = function timeEnd(label = 'default') {
+      this.timeLog(label)
 
-    if (ms > 1000) this.log(label + ': ' + (ms / 1000).toFixed(3) + 's')
-    else this.log(label + ': ' + ms.toFixed(3) + 'ms')
-  }
+      timers.delete(label)
+    }
+
+    // https://console.spec.whatwg.org/#count
+    this.count = function count(label = 'default') {
+      const count = counters.get(label) || 1
+
+      this.log(`${label}: ${count}`)
+
+      counters.set(label, count + 1)
+    }
+
+    // https://console.spec.whatwg.org/#countreset
+    this.countReset = function countReset(label = 'default') {
+      counters.delete(label)
+    }
 
-  trace (...args) {
-    const err = { name: 'Trace', message: formatWithOptions({ colors: this._colors }, ...args) }
+    // https://console.spec.whatwg.org/#trace
+    this.trace = function trace(...data) {
+      const err = {
+        name: 'Trace',
+        message: log.format(...data),
+        stack: null
+      }
 
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(err, this.trace)
+      if (Error.captureStackTrace) {
+        Error.captureStackTrace(err, this.trace)
+      }
+
+      this.error(err.stack)
     }
 
-    this.error(err.stack)
+    // https://console.spec.whatwg.org/#assert
+    this.assert = function assert(condition, ...data) {
+      if (condition) return
+
+      if (data.length === 0) data.push('Assertion failed')
+      else if (typeof data[0] !== 'string') data.unshift('Assertion failed')
+      else data[0] = `Assertion failed: ${data[0]}`
+
+      this.error(...data)
+    }
   }
-}
 
-function adaptStream (stream) {
-  return typeof stream === 'function' ? { write: stream } : stream
+  // For Node.js compatibility
+  get Console() {
+    return Console
+  }
 }
+
+exports.Console = exports // For Node.js compatibility

package/package.json

@@ -1,13 +1,26 @@
 {
   "name": "bare-console",
-  "version": "5.1.1",
-  "description": "Simple debugging console for JavaScript",
-  "main": "index.js",
+  "version": "6.0.1",
+  "description": "WHATWG debugging console for JavaScript",
+  "exports": {
+    "./package": "./package.json",
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./global": {
+      "types": "./global.d.ts",
+      "default": "./global.js"
+    }
+  },
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts",
+    "global.js",
+    "global.d.ts"
   ],
   "scripts": {
-    "test": "standard && bare test.js"
+    "test": "prettier . --check && bare test.js"
   },
   "repository": {
     "type": "git",
@@ -20,13 +33,12 @@
   },
   "homepage": "https://github.com/holepunchto/bare-console#readme",
   "dependencies": {
-    "bare-events": "^2.2.0",
-    "bare-format": "^1.0.0",
-    "bare-hrtime": "^2.0.0"
+    "bare-hrtime": "^2.0.0",
+    "bare-logger": "^1.0.0"
   },
   "devDependencies": {
-    "bare-stream": "^2.0.0",
     "brittle": "^3.1.1",
-    "standard": "^17.0.0"
+    "prettier": "^3.3.3",
+    "prettier-config-standard": "^7.0.0"
   }
 }