Skip to content

Commit 53d53cf

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 2881911 commit 53d53cf

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
@@ -128,6 +128,25 @@ To run the tests:
128128
$ make test
129129
```
130130

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

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

0 commit comments

Comments
 (0)