coverjs

JSCoverage compatible JavaScript code coverage tool

npm install coverjs
17 downloads in the last day
170 downloads in the last week
951 downloads in the last month

CoverJS (alpha)

Make sure all your code is tested, don't miss anything. CoverJS intruments your code. Using the instrumented code with your tests will result in a nice object, which can be passed through one of the reporters to create a nice graphical output of your code.

Instead of instrumenting lines (like JSCoverage), CoverJS will instrument statements, which should result in a more precise result.

Dependencies

Reporters

  • HTML
  • Text

CLI Usage

To instrument the code, CoverJS comes with a CLI tool:

coverjs --output cov/ file.js test/*

Reporting

The instrumented code should be executed to count the number of calls for each statement.

Usually your tests will try to cover each statement.

An example code that will capture the output and generate a HTML report would look like:


var HTMLReporter = require('../lib/reporters/HTMLReporter');

require('../test-cov/test/fixture.js');

var reporter = new HTMLReporter(global.__$coverObject);
console.log(reporter.report());

The output stream can be redirected to a file using

node test.js > report.html

so the result can be viewed in a browser

node

There are different templates with which what the instrumented code should start and end. For node there exists an template that saves the output as a JSON file, which can later be used as to generate a HTML report.

coverjs --template node --report ./cov.json file.js

With the coverjs-report tool, which reads from stdin, an HTML output can be generated:

cat ./cov.json | coverjs-report -r html > cov.html

See the prime Makefile for an example.

Screenshot

Screenshot

npm loves you