isabella232 / tap-console-parser

parses TAP by hijacking console.log

tap-console-parser

Parses TAP by hijacking console.log, primarily useful for colorizing tests in the browser console.

var parser = require('tap-console-parser')

// start hijacking console.log()
var tap = parser()

// we can print to the real console with log()
tap.on('assert', function (assert) {
  tap.log('Got assert!', assert.name)
})

// get result
tap.on('complete', function (result) {
  // stop hijacking console.log
  tap.detach()
  
  if (result.ok)
    console.log('Ok!')
  else
    console.log('Not ok!')
})

Usage

parser = tapConsole()

Creates a new TAP parser and hijacks the global console.log function.

parser.attach()

Hijacks the console.log function. Any subsequent logs will be captured by this parser and not printed to the native console.

parser.detach()

Un-hijacks the console.log function. Subsequent logs will not be parsed, and will be passed to the native console as usual.

parser.log(args)

The native console.log() function, can be used while the parser is attached to actually log something to the console.

parser.on('assert', fn)

Called when an assertion is met, see tap-out#assert.

parser.on('test', fn)

Called when a new test block is met, see tap-out#test

parser.on('complete', fn)

Called when tests, fail and pass have been parsed, and we can assume the test is over. The passed parameter looks like:

{
  ok: false,
  total: 3,
  pass: 2,
  fail: 1
}

parser.on('log', fn)

Called whenever console.log() is called with args, an array of the user's arguments. It allows you to pass along logs to the native console like so:

parser.on('log', function(args) {
  parser.log.apply(null, args)
})

License

MIT, see LICENSE.md for details.