Skip to content

Commit 4869daf

Browse files
ssbrewsteraddaleax
authored andcommitted
doc: instructions for generating coverage reports
Add instructions for generating code coverage reports to BUILDING.md PR-URL: nodejs#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 ff3e592 commit 4869daf

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
@@ -126,6 +126,25 @@ To run the tests:
126126
$ make test
127127
```
128128

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

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

0 commit comments

Comments
 (0)