collect-v8-coverage

What is collect-v8-coverage?

The collect-v8-coverage npm package is used to collect code coverage information from V8 JavaScript engine. It is particularly useful for gathering detailed coverage data during the execution of JavaScript code, which can be used for testing and performance analysis.

What are collect-v8-coverage's main functionalities?

Start Coverage Collection

This feature allows you to start collecting coverage data. The code sample demonstrates how to initialize the coverage map and start the collection process.

const { createCoverageMap } = require('collect-v8-coverage');
const coverageMap = createCoverageMap();

async function startCoverage() {
  await coverageMap.startCollecting();
  console.log('Coverage collection started');
}

startCoverage();

Stop Coverage Collection

This feature allows you to stop collecting coverage data and retrieve the collected data. The code sample shows how to stop the collection and log the results.

async function stopCoverage() {
  const result = await coverageMap.stopCollecting();
  console.log('Coverage collection stopped');
  console.log(result);
}

stopCoverage();

Serialize Coverage Data

This feature allows you to serialize the collected coverage data to a file. The code sample demonstrates how to save the coverage data to a JSON file.

const fs = require('fs');

async function saveCoverageData() {
  const result = await coverageMap.stopCollecting();
  fs.writeFileSync('coverage.json', JSON.stringify(result));
  console.log('Coverage data saved to coverage.json');
}

saveCoverageData();

Other packages similar to collect-v8-coverage

nyc

nyc is a popular code coverage tool for JavaScript that works with various testing frameworks. It provides detailed coverage reports and integrates well with CI/CD pipelines. Compared to collect-v8-coverage, nyc offers more features and flexibility for different testing environments.

istanbul

Istanbul is another widely-used code coverage tool for JavaScript. It provides comprehensive coverage reports and supports various output formats. Istanbul is known for its ease of use and integration with other tools. While collect-v8-coverage focuses on V8 engine coverage, Istanbul provides a broader range of features and compatibility.

c8

c8 is a code coverage tool that uses V8's built-in coverage collection capabilities. It is similar to collect-v8-coverage in that it leverages V8's native features, but c8 offers additional functionalities such as integration with Node.js and support for various reporting formats.

README

collect-v8-coverage

Use this module to start and stop the V8 inspector manually and collect precise coverage.

const {CoverageInstrumenter} = require('collect-v8-coverage');

const instrumenter = new CoverageInstrumenter();

await instrumenter.startInstrumenting();

// require some modules, run some code

const coverage = await instrumenter.stopInstrumenting();

Changelog

1.0.2 (2023-07-05)

Bug Fixes

• workaround for networked filesystems on Windows (#174) (4de72ea)