Skip to content

Commit a260190

Browse files
ssbrewsterMylesBorins
authored andcommitted
doc: instructions for generating coverage reports
Add instructions for generating code coverage reports to BUILDING.md PR-URL: #15190 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 1b0e660 commit a260190

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

BUILDING.md

+19
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,25 @@ To run the tests:
129129
$ make test
130130
```
131131

132+
To run the tests and generate code coverage reports:
133+
134+
```console
135+
$ ./configure --coverage
136+
$ make coverage
137+
```
138+
139+
This will generate coverage reports for both JavaScript and C++ tests (if you
140+
only want to run the JavaScript tests then you do not need to run the first
141+
command `./configure --coverage`).
142+
143+
The `make coverage` command downloads some tools to the project root directory
144+
and overwrites the `lib/` directory. To clean up after generating the coverage
145+
reports:
146+
147+
```console
148+
make coverage-clean
149+
```
150+
132151
To build the documentation:
133152

134153
This will build Node.js first (if necessary) and then use it to build the docs:

0 commit comments

Comments
 (0)