v8-to-istanbul
Advanced tools
Package description
The v8-to-istanbul package is a tool that converts V8 coverage information into a format that is compatible with Istanbul's coverage reports. It allows developers to generate coverage reports for JavaScript code executed in the V8 JavaScript engine, which is used by Node.js and Chrome.
Convert V8 coverage to Istanbul format
This feature allows you to convert V8 coverage information into the Istanbul format. You can then use this data to generate reports with Istanbul-compatible tools.
const v8toIstanbul = require('v8-to-istanbul');
const scriptPath = './path/to/script.js';
const v8Coverage = require('./path/to/v8-coverage.json');
const converter = v8toIstanbul(scriptPath);
converter.load();
converter.applyCoverage(v8Coverage);
const istanbulCoverage = converter.toIstanbul();
console.log(JSON.stringify(istanbulCoverage, null, 2));Exclude specific functions or lines from coverage
This feature allows you to exclude specific functions or ranges of lines from the coverage report. This is useful for ignoring code that you do not want to include in your coverage metrics.
const v8toIstanbul = require('v8-to-istanbul');
const scriptPath = './path/to/script.js';
const converter = v8toIstanbul(scriptPath, {
exclude: ['**/node_modules/**', '**/test/**']
});
converter.exclude('functionName');
converter.excludeRange([startLine, endLine]);nyc is a command-line tool and library for instrumenting code with Istanbul's coverage tracking and reporting. It is a more comprehensive tool that includes v8-to-istanbul's functionality as part of its coverage processing pipeline.
c8 is a higher-level tool that uses v8-to-istanbul under the hood to collect and report V8 code coverage. It provides a simple command-line interface to generate coverage reports without needing to manually convert V8 coverage data.
istanbul-lib-instrument is part of the Istanbul API and is responsible for instrumenting JavaScript code. It differs from v8-to-istanbul in that it modifies the code to track coverage, rather than converting coverage data from the V8 engine.
Changelog
Readme
converts from v8 coverage format to istanbul's coverage format.
const v8toIstanbul = require('v8-to-istanbul')
// create a script object from a source-file. the source file
// is loaded from disk and this is used to determine the original
// line count.
const script = v8toIstanbul('./path-to-instrumented-file.js')
// provide an array of coverage information in v8 format.
script.applyCoverage([
{
"functionName": "",
"ranges": [
{
"startOffset": 0,
"endOffset": 520,
"count": 1
}
],
"isBlockCoverage": true
},
// ...
])
// output coverage information in a form that can
// be consumed by Istanbul.
console.info(JSON.stringify(script.toIstanbul()))
To execute tests, simply run:
npm test
To output istanbul coverage data while running tests (useful as you add new assertions), simply run:
DEBUG=true npm test
FAQs
convert from v8 coverage format to istanbul's format
We found that v8-to-istanbul demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.