README.md

karma-tap-pretty-reporter

a Karma reporter plugin for report and prettify TAP test results

Installation

npm

npm install karma karma-tap karma-tap-pretty-reporter --save-dev

[optional] install a prettify package. See below supported prettifiers

npm install faucet --save-dev

Usage

Add karma.conf.js file to project.

Example:

// karma.conf.js
module.exports = function(config) {
  config.set({
    reporters: ['tap-pretty'],

    tapReporter: {
      prettify: require('faucet'), // default 'standard TAP' output
      separator: '****************************'
    },
  });
};

Using separator

On Karma autoWatch mode maybe we need separate test run cycles output. Create a separator string for this purpose.

In order of not pollute output, separator will be shown only if LogLevel is different of LOG_INFO nor LOG_DEBUG

Report to a file

Optionally you can save report to a file and turn off output to the console.

// karma.conf.js

reporters: ['tap-pretty'],

tapReporter: {
  outputFile: './test.out.tap',
  disableStdout: true            // default 'false'
},

Supported prettifiers

• faucet
• tap-spec
• tap-min
• tap-diff
• tap-notify
• tap-summary
• tap-markdown
• tap-difflet

Use Cases

Show only 'failed' test

Install tap-difflet package

npm install tap-difflet --save-dev

Add settings to tapReporter on karma.conf.js

tapReporter: {
      // outputFile: './unit.tap',
      prettify: function() { return require('tap-difflet')({ pessimistic: true }); },
      separator: '****************************',
    },

Example

• karma-tap-pretty-reporter--example

Credits

author

• bySabi Files <> @bySabi

contributors

• Rostyslav Diachok <> @infernalmaster
• VitProg <> @VitProg
• wesley luyten <> @luwes

Contributing

• Documentation improvement
• Feel free to send any PR

License

ISC