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

Jump to bottom

Use c8 for code coverage examples instead of nyc #2843

Merged
merged 4 commits into from Sep 26, 2021
Merged

Use c8 for code coverage examples instead of nyc #2843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
116a91e
Update code-coverage.md
bompus Sep 21, 2021
7a6bce7
Update vue.md
bompus Sep 21, 2021
b8c03c7
Update beautify-stack.js
bompus Sep 21, 2021
327ef34
Update beautify-stack.js
bompus Sep 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/recipes/code-coverage.md
View file
Open in desktop
Expand Up @@ -2,29 +2,28 @@

Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/docs/recipes/code-coverage.md), [Français](https://github.com/avajs/ava-docs/blob/master/fr_FR/docs/recipes/code-coverage.md), [Italiano](https://github.com/avajs/ava-docs/blob/master/it_IT/docs/recipes/code-coverage.md), [日本語](https://github.com/avajs/ava-docs/blob/master/ja_JP/docs/recipes/code-coverage.md), [Português](https://github.com/avajs/ava-docs/blob/master/pt_BR/docs/recipes/code-coverage.md), [Русский](https://github.com/avajs/ava-docs/blob/master/ru_RU/docs/recipes/code-coverage.md), [简体中文](https://github.com/avajs/ava-docs/blob/master/zh_CN/docs/recipes/code-coverage.md)

Use [`nyc`] to compute the code coverage of your tests.
Use [`c8`] to compute the code coverage of your tests.

First install [`nyc`]:
First install [`c8`]:

```
$ npm install --save-dev nyc
$ npm install --save-dev c8
```

At its simplest run AVA through [`nyc`]. In your `package.json` file:
At its simplest run AVA through [`c8`]. In your `package.json` file:

```json
{
"scripts": {
"test": "nyc ava"
"test": "c8 ava"
}
}
```

You may want to exclude the `.nyc_output` and `coverage` directories from source control. Assuming you're using Git, add the following to your `.gitignore` file:
You may want to exclude the `coverage` directory from source control. Assuming you're using Git, add the following to your `.gitignore` file:

```
.nyc_output
coverage
```

[`nyc`]: https://github.com/istanbuljs/nyc
[`c8`]: https://github.com/bcoe/c8
4 changes: 2 additions & 2 deletions docs/recipes/vue.md
View file
Open in desktop
Expand Up @@ -73,11 +73,11 @@ test('renders', t => {

## Coverage reporting

Follow the [coverage reporting recipe](code-coverage.md), additionally adding the `.vue` extension to the `nyc` config to instrument `.vue` files.
Follow the [coverage reporting recipe](code-coverage.md), additionally adding the `.vue` extension to the `c8` config to instrument `.vue` files.

```json
{
"nyc": {
"c8": {
"extension": [
".js",
".vue"
Expand Down