diff options
author | Joel Kronqvist <work.joelkronqvist@pm.me> | 2022-03-11 20:46:06 +0200 |
---|---|---|
committer | Joel Kronqvist <work.joelkronqvist@pm.me> | 2022-03-11 20:46:06 +0200 |
commit | 080c5819d87b933816d724a83f3bf4f1686770a7 (patch) | |
tree | 4a2ccc68b27edf7d4cbc586c932cc7542b655e19 /node_modules/v8-to-istanbul/README.md | |
parent | 5ac7049a9d30733165cc212dee308163c2a14644 (diff) | |
parent | d003b82235a9329f912522a2f70aa950dfce4998 (diff) | |
download | LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.tar.gz LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.zip |
Merge branch 'master' of https://github.com/JoelHMikael/FoodJS
Updating remote changes
Diffstat (limited to 'node_modules/v8-to-istanbul/README.md')
-rw-r--r-- | node_modules/v8-to-istanbul/README.md | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/node_modules/v8-to-istanbul/README.md b/node_modules/v8-to-istanbul/README.md new file mode 100644 index 0000000..7e9bf69 --- /dev/null +++ b/node_modules/v8-to-istanbul/README.md @@ -0,0 +1,90 @@ +# v8-to-istanbul + +[](https://travis-ci.org/istanbuljs/v8-to-istanbul) +[](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 the async source-map dependency. +// 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())) + +// cleanup resources allocated in "load" (i.e. by the source-map dependency), +// the converter may not be used anymore afterwards +converter.destroy() +``` + +## 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 `/* c8 ignore next */`. + +### ignoring the next line + +```js +const myVariable = 99 +/* c8 ignore next */ +if (process.platform === 'win32') console.info('hello world') +``` + +### ignoring the next N lines + +```js +const myVariable = 99 +/* c8 ignore next 3 */ +if (process.platform === 'win32') { + console.info('hello world') +} +``` + +### ignoring all lines until told + +```js +/* c8 ignore start */ +function dontMindMe() { + // ... +} +/* c8 ignore stop */ +``` + +### ignoring the same line as the comment + +```js +const myVariable = 99 +const os = process.platform === 'darwin' ? 'OSXy' /* c8 ignore next */ : 'Windowsy' +``` + +## Testing + +To execute tests, simply run: + +```bash +npm test +``` |