Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/istanbuljs/v8-to-istanbul
convert from v8 coverage format to istanbul's format
https://github.com/istanbuljs/v8-to-istanbul
Last synced: about 2 months ago
JSON representation
convert from v8 coverage format to istanbul's format
- Host: GitHub
- URL: https://github.com/istanbuljs/v8-to-istanbul
- Owner: istanbuljs
- License: isc
- Created: 2017-11-25T03:36:32.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-09T07:59:26.000Z (3 months ago)
- Last Synced: 2024-07-16T01:51:42.848Z (2 months ago)
- Language: JavaScript
- Size: 1.67 MB
- Stars: 112
- Watchers: 6
- Forks: 40
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# v8-to-istanbul
[](https://github.com/istanbuljs/v8-to-istanbul/actions)
[](https://conventionalcommits.org)
converts from v8 coverage format to [istanbul's coverage format](https://github.com/gotwarlost/istanbul/blob/master/coverage.json.md).
## Usage
```js
const v8toIstanbul = require('v8-to-istanbul')
// the path to the original source-file is required, as its contents are
// used during the conversion algorithm.
const converter = v8toIstanbul('./path-to-instrumented-file.js')
await converter.load() // this is required due to async file reading.
// provide an array of coverage information in v8 format.
converter.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(converter.toIstanbul()))
```
## Ignoring Uncovered Lines
Sometimes you might find yourself wanting to ignore uncovered lines
in your application (for example, perhaps you run your tests in Linux, but
there's code that only executes on Windows).
To ignore lines, use the special comment `/* v8 ignore next */`.
**NOTE**: Before version `9.2.0` the ignore hint had to contain `c8` keyword, e.g. `/* c8 ignore ...`.
### ignoring the next line
```js
const myVariable = 99
/* v8 ignore next */
if (process.platform === 'win32') console.info('hello world')
```
### ignoring the next N lines
```js
const myVariable = 99
/* v8 ignore next 3 */
if (process.platform === 'win32') {
console.info('hello world')
}
```
### ignoring all lines until told
```js
/* v8 ignore start */
function dontMindMe() {
// ...
}
/* v8 ignore stop */
```
### ignoring the same line as the comment
```js
const myVariable = 99
const os = process.platform === 'darwin' ? 'OSXy' /* v8 ignore next */ : 'Windowsy'
```
## Testing
To execute tests, simply run:
```bash
npm test
```