suman-reporters v0.0.1015

Official Suman reporters

This repo contains reporters for both Node.js and the browser. Suman supports asynchronous reporters, so that reporters can persist data using async I/O, etc, if they wish.

Installing

$ npm install suman-reporters

Loading reporters

Suman reporters in this package can be imported like so:

// typescript
import r = require('suman-reporters/modules/tap-reporter');

// js
const r = require('suman-reporters/modules/tap-reporter');

To use a reporter with the suman command line, the API is like so:

$ suman --reporter="tap-reporter"

You can load multiple reporters like so:

$ suman --reporter="tap-reporter" --reporter="std-reporter"

The loading logic is as follows:

1. First suman will attempt to require('tap-reporter')
2. If the above fails, then it will attempt to require('suman-reporters/modules/tap-reporter')

So for "max efficiency", you could just use this:

$ suman --reporter="suman-reporters/modules/tap-reporter"

Anatomy of a Suman-compliant reporter:

Export a function, either with module.exports or exports.default.

This function takes 4 arguments:

exports.default = function(s, o, expct, c){
  
   // s is an event emitter instance
   // o is a copy of the suman command line options as a plain object
   // expct is a plain object representing the expected pass/fail/skipped/stubbed counts
   // c is a socket.io client

}

Take a look at the modules directory for up-to-date samples; TypeScript will aid in getting the types right.