/karma-htmlfile-reporter

A karma plugin for exporting unit test results as styled HTML file

Primary LanguageJavaScriptMIT LicenseMIT

karma-htmlfile-reporter

A karma plugin for exporting unit test results as styled HTML file

This is a plugin for the Karma Test Runner. By adding this reporter to your karma configuration, unit test results will be exported as a styled HTML file. For each test browser, a separate table is generated. The plugin is based on the karma-junit-reporter plugin.

HTML test result page

Click here to see an example of the exported unit test result page.

Installation

The easiest way is to keep karma-htmlfile-reporter as a devDependency in your package.json.

{
  "devDependencies": {
    "karma": "~0.10",
    "karma-htmlfile-reporter": "~0.2"
  }
}

You can simple do it by:

npm install karma-htmlfile-reporter --save-dev

It may also be necessary to install globally:

npm install -g karma-htmlfile-reporter

Configuration

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

    htmlReporter: {
      outputFile: 'tests/units.html',
			
      // Optional
      pageTitle: 'Unit Tests',
      subPageTitle: 'A sample project description'
    }
  });
};

You can pass list of reporters as a CLI argument too:

karma start --reporters html

For more information on Karma see the homepage.