From 6e27fd7bdeb60477d19c4d80dac57b002e6552e4 Mon Sep 17 00:00:00 2001 From: Simon Brewster Date: Tue, 5 Sep 2017 00:10:05 +0200 Subject: [PATCH] doc: instructions for generating coverage reports Add instructions for generating code coverage reports to BUILDING.md PR-URL: https://github.com/nodejs/node/pull/15190 Reviewed-By: Timothy Gu Reviewed-By: Luigi Pinca Reviewed-By: Michael Dawson Reviewed-By: James M Snell --- BUILDING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 805c89a3cdf9bf..8bf3d79cd586ae 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -126,6 +126,25 @@ To run the tests: $ make test ``` +To run the tests and generate code coverage reports: + +```console +$ ./configure --coverage +$ make coverage +``` + +This will generate coverage reports for both JavaScript and C++ tests (if you +only want to run the JavaScript tests then you do not need to run the first +command `./configure --coverage`). + +The `make coverage` command downloads some tools to the project root directory +and overwrites the `lib/` directory. To clean up after generating the coverage +reports: + +```console +make coverage-clean +``` + To build the documentation: This will build Node.js first (if necessary) and then use it to build the docs: