Skip to content

Commit

Permalink
docs: update notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin committed Nov 27, 2017
1 parent 9534f56 commit 7f1e920
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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:

Expand All @@ -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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 7f1e920

Please sign in to comment.