Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added examples of coverage reports #656

Merged
merged 3 commits into from
Oct 21, 2017
Merged

Added examples of coverage reports #656

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0e3914
Added examples of coverage reports
d4nyll Aug 28, 2017
86c094f
Merge branch 'master' into patch-1
d4nyll Oct 16, 2017
d459677
Update link to point to a istanbul.js.org
d4nyll Oct 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,12 +173,14 @@ To view your coverage report:

<img width="500" src="screen.png">

you can use [any reporters that are supported by `istanbul`](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-reports/lib):
You can use [any reporters that are supported by `istanbul`](https://github.com/istanbuljs/istanbuljs/tree/master/packages/istanbul-reports/lib): `clover`, `cobertura`, `html`, `json-summary`, `json`, `lcov`, `lcovonly`, `none`, `teamcity`, `text-lcov`, `text-summary`, `text`.

```bash
nyc report --reporter=lcov
```

You can find examples of the output for various reporters [here](https://istanbul.js.org/docs/advanced/instrument/alternative-reporters).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link should be: https://istanbul.js.org/docs/advanced/alternative-reporters/

once this is fixed we can land things, thanks for your updates to the docs 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh silly me! I'll fix it straight away.


## Excluding files

You can tell nyc to exclude specific files and directories by adding
Expand Down