remap-istanbul/lib/remap.js

A tool for remapping Istanbul coverage via Source Maps

const CoverageTransformer = require('./CoverageTransformer');

/**
 * Remaps coverage data based on the source maps it discovers in the
 * covered files and returns a coverage Collector that contains the remappped
 * data.
 * @param  {Array|Object} coverage The coverage (or array of coverages) that need to be
 *                                 remapped
 * @param  {Object} options A configuration object:
 *                              basePath?    - a string containing to utilise as the base path
 *                                             for determining the location of the source file
 *                              exclude?     - a string or Regular Expression that filters out
 *                                             any coverage where the file path matches
 *                              mapFileName? - a function that takes the remapped file name and
 *                                             and returns a string that should be the name in
 *                                             the final coverage
 *                              readFile?    - a function that can read a file
 *                                             syncronously
 *                              readJSON?    - a function that can read and parse a
 *                                             JSON file syncronously
 *                              sources?     - a Istanbul store where inline sources will be
 *                                             added
 *                              warn?        - a function that logs warnings
 * @return {istanbul/lib/_collector}           The remapped collector
 */
module.exports = function remap(coverage, options = {}) {
	const smc = new CoverageTransformer(options);

	if (!Array.isArray(coverage)) {
		coverage = [coverage];
	}

	coverage.forEach(item => {
		smc.addCoverage(item);
	});

	return smc.getFinalCoverage();
};