Agnostic in browser Javascript coverage reporter
JavaScript
Pull request Compare This branch is 2 commits ahead of TwoApart:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
JSCovReporter.js
README.md
reporter.css

README.md

JSCovReporter

[Fork Details]

This fork removes the original repo's dependency on backbone and underscore to render the browser report. In fact it shouldn't have any non-native browser dependencies now when viewing the report.

[Original]

This is a testing framework agnostic in-browser Javascript coverage reporter. It works with CoverJS instrumented code. The UX and appearance of the report mimic Mocha's HTMLCov runner which only works with nodejs. JSCovReporter should work with any testing framework such as QUnit, Jasmine, Mocha, Buster or anything you use.

The files included here are borrowed from Mocha project and have been slightly modified to work with the HTML produced by this reporter and work well with Mocha's HTML runner, currently the only Mocha in-browser runner. This is what Mocha looks like when used with JSCovRepoter:

Setup

  • Download from this repository and include reporter.css and JSCovReporter.js files in your runner.

  • Your test runner body will need to contain this DOM, besides the one that your testing framework needs. Most likely you want these after the div for your framework, so that coverage appears after testing results:

    <div id="coverage"></div>
    <div id="menu"></div>

Usage

Instrument your Javascript code

You will first need to instrument your javascript code using CoverJS. Install it using nodejs npm package manager:

npm install coverjs

Add coverjs bin to your PATH and then do:

coverjs mylibrary.js --output instrumented

This will create an instrumenteddirectory, containing an instrumented mylibrary.js, these are the files you have to link in your HTML test runner.

Generate a report

When the testing suite is done, just create a JSCovReporter instance passing it CoverJS' global coverObject as coverObject argument:

    if (typeof window.__$coverObject !== 'undefined') {
        var reporter = new JSCovReporter({ coverObject: window.__$coverObject });
    }

In this case we are making sure coverObject exists, this way your runner will work with or without instrumented code.

Mocha usage example

For example in Mocha you can easily plug it in using run callback:

    mocha.run(function () {
        if (typeof window.__$coverObject !== 'undefined') {
            var reporter = new JSCovReporter({ coverObject: window.__$coverObject });
        }
    });