karma-jasmine-html-reporter

What is karma-jasmine-html-reporter?

The karma-jasmine-html-reporter npm package is a plugin for the Karma test runner that provides a visual HTML report of the results of Jasmine tests. It allows developers to see their test results in a more readable and user-friendly format directly in the browser.

What are karma-jasmine-html-reporter's main functionalities?

Visual HTML Test Results

This feature allows you to see your Jasmine test results in a formatted HTML output. The code sample shows how to configure Karma to use the karma-jasmine-html-reporter by adding 'kjhtml' to the list of reporters and including the plugin in the Karma configuration.

module.exports = function(config) {
  config.set({
    reporters: ['progress', 'kjhtml'],
    plugins: [
      require('karma-jasmine'),
      require('karma-chrome-launcher'),
      require('karma-jasmine-html-reporter')
    ]
  });
};

Debugging Support

The reporter supports interactive debugging by leaving the Jasmine Spec Runner output visible in the browser. The 'clearContext' option is set to false to keep the HTML output visible, allowing developers to inspect and debug directly.

module.exports = function(config) {
  config.set({
    reporters: ['kjhtml'],
    client: {
      clearContext: false // leave Jasmine Spec Runner output visible in browser
    }
  });
};

Other packages similar to karma-jasmine-html-reporter

karma-mocha-reporter

This package is similar to karma-jasmine-html-reporter but is designed to work with the Mocha testing framework. It provides a more flexible output by allowing different report styles and color schemes.

karma-spec-reporter

Karma-spec-reporter outputs test results to the console in a spec format. It is less visual than karma-jasmine-html-reporter as it does not produce an HTML report, but it is useful for a quick overview of test results in the terminal.

karma-summary-reporter

This reporter generates a summary of test results in the console after all tests have run. It is simpler than karma-jasmine-html-reporter and does not provide an HTML interface, focusing instead on a concise summary.

README

karma-jasmine-html-reporter

Reporter that dynamically shows tests results at debug.html page.

Jasmine 1.3 is not supported. For Jasmine < 3.0.0, use version 0.2.2

You can also run a describe block, or a single test.

Installation

You can simply install karma-jasmine-html-reporter as a devDependency by:

npm install karma-jasmine-html-reporter --save-dev

Configuration

// karma.conf.js
module.exports = function(config) {
  config.set({
    reporters: ['kjhtml']
  });
};

With options

In combination with multiple reporters you may want to disable failed messages because it's already handled by another reporter.

Example when using the 'karma-mocha-reporter' plugin:

// karma.conf.js
module.exports = function(config) {
  config.set({

    // Combine multiple reporters
    reporters: ['kjhtml', 'mocha'],

    jasmineHtmlReporter: {
      // Suppress failed messages
      suppressFailed: true
    }

  });
};

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

karma start --reporters kjhtml

Develop

There's not much to this package.

adapter.js, html.jasmine.reporter.js, and jasmine.css are copied with small adjustments from jasmine/lib/jasmine-core/boot.js and jasmine/lib/jasmine-core/jasmine-html.js, and jasmine/lib/jasmine-core/jasmine.css respectively.

Just pull over changes from Jasmine as needed. There is a script to help with that; just run npm run build and review the changes. Specifically, adapter.js needs a lot of manual removals.