Jasmine 2.0 Terminal Reporter

A cool, very customisable, terminal reporter for visualizing Jasmine 2.0 test results.

Usage

In most cases if a reference to the jasmine object is defined, the reporter can be added using the test runner api:

jasmine.getEnv().addReporter(reporter);

NodeJS (minijasminenode2)

This example is based on minijasminenode2 library. The reporter can be used with other Jasmine plugins. Check the appropriate documentation for usage details.

var miniJasmineLib = require('minijasminenode2'),
  TestsReporter = require('jasmine2-reporter').Jasmine2Reporter,
  options = {
    pendingSpec: false,
    colors: {
      pending: 'orange',
    },
    symbols: {
      pending: '*  '.strikethrough, //strikethrough is a colors module feature
    }
  };

  miniJasmineLib.addReporter(new TestsReporter(options));

Options

• failedAsserts: true - display the asserts that failed with the failed specs;
• failedSpec: true - display failed specs;
• failuresSummary: true - display a summary with the failed specs;
• hideEmptySummary: false - hide passed/failed/pending in the summary if the corresponding tests number is 0;
• inColors: colors.supportsColor - use colors to display the reports. Turn on if supported;
• indent: '\t' - the indentation character/string;
• namesInColors: false - display suite and specs names in colors;
• startingSpec: false - display started specs;
• passedSpec: true - display passed specs;
• pendingSpec: true - display pending/skipped specs (xit, pending());
• pendingSuite: true - display pending/skipped suites (xdescribe);
• specDuration: true - display test duration for each spec;
• stacktrace: true - display stack traces for failed specs;
• suiteDuration: false - display duration for each suite;
• summary: true - display a summary with passed/failed/pending percentages, after all the test have runned;
• colors
  • starting: 'grey' - color used to display started tests;
  • failed: 'red' - color used to display failed tests;
  • passed: 'green' - color used to display passed tests;
  • pending: 'yellow' - color used to display pending(skipped) tests;
  • suite: 'cyan' - color used to display suite symbol/name;
  • system: 'grey' - color used to display system information (duration, summary, ...);
• symbols
  • starting: '▻ '.strikethrough - spec started symbol;
  • failed: 'X '.strikethrough - failed spec symbol;
  • passed: '√ '.strikethrough - passed spec symbol;
  • pending: '~ '.strikethrough - pending(skipped) spec symbol;
  • disabled: '# '.strikethrough - disabled spec symbol;
  • suite: '» '.strikethrough - suite symbol;

Note: By default the symbols are emphasized with strikethrough wich is a colors module feature. The dependancy is used for displaying the colored output, so for more options check their documentation.

Changelog

• v1.0.1
  • #23 - fix: exposing the module #23
• v1.0.0
  • #21 - refactor: update code to ES6
  • #18 - add demo
  • #16 - only use colors when supported
• v0.3.1
  • Fix #17 - use characters supported everywhere
• v0.3.0
  • Fix #14 - update colors usage
• v0.2.0
  • Feat #12 - Add startingSpec options which toggles logging of starting specs
• v0.1.2
  • Fix #11 - Avoid reported crashing on disabled specs
• v0.1.1
  • Fix #1 - documentation
  • Fix #4 - NaN on summary
  • Fix #5 - error on undefined stack
  • Fix #6 - added hideEmptySummary option
• v0.1.0 (initial functionality)
  • terminal reported compatible with Jasmine 2.0

LICENCE

MIT

Screenshots