From 7f1e920a63ccb3023788d03ebbf3c2b3b7d4d648 Mon Sep 17 00:00:00 2001 From: Benjamin Date: Sun, 26 Nov 2017 19:12:42 -0800 Subject: [PATCH] docs: update notes --- README.md | 7 ++++--- package.json | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 32a5b35e..bbe331e5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # c8 - native v8 code-coverage -Code-coverage using [v8's Profiler](https://nodejs.org/dist/latest-v8.x/docs/api/inspector.html) +Code-coverage using [v8's Inspector](https://nodejs.org/dist/latest-v8.x/docs/api/inspector.html) that's compatible with [Istanbul's reporters](https://istanbul.js.org/docs/advanced/alternative-reporters/). Like [nyc](https://github.com/istanbuljs/nyc), c8 just magically works, simply: @@ -10,7 +10,7 @@ npm i c8 -g c8 node foo.js ``` -The above example will collect coverage for `foo.js` using v8's profiler. +The above example will collect coverage for `foo.js` using v8's inspector. TODO: @@ -29,4 +29,5 @@ TODO: - [x] process.exit() can't perform an async operation; how can we track coverage for scripts that exit? * we can now listen for the `Runtime.executionContextDestroyed` event. -- [ ] +- [ ] figure out why instrumentation of .mjs files does not work: + * see: https://github.com/nodejs/node/issues/17336 \ No newline at end of file diff --git a/package.json b/package.json index 06d060e4..8fded6dc 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "c8", "version": "1.0.1", - "description": "collect test coverage using v8's profiler", + "description": "collect test coverage using v8's inspector", "main": "index.js", "bin": "./bin/c8.js", "scripts": {