Getting Started

The main purpose of remap-istanbul is to take coverage information from Istanbul that was collected from "emitted" code and then remap the positions in the coverage information back to their original locations. This then provides users with better insight into the code coverage of the original code.

remap-istanbul is designed to be integrated into a larger toolchain that would become part of a build, test or continuous integration process. To that end, the interface to remap-istanbul is provided in several different "out of the box" fashions:

There are various ways of installing remap-istanbul but the most common way is utilizing Node's package manager. In most cases you would only want to install remap-istanbul as a development dependency:

$ npm install remap-istanbul --save-dev

This will place remap-istanbul in the node_modules path of your project. From there you would then need to utilize one of the interfaces mentioned above.