From 342b501cb0ceed7aeaadba09a13024cbab5f24c2 Mon Sep 17 00:00:00 2001 From: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:11:04 -0400 Subject: [PATCH] doc: fix information about including coverage files PR-URL: https://github.com/nodejs/node/pull/54527 Reviewed-By: Moshe Atlow Reviewed-By: Benjamin Gruenbaum Reviewed-By: James M Snell Reviewed-By: Colin Ihrig --- doc/api/test.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/api/test.md b/doc/api/test.md index 312f9c27eaac5e..a7af114880ea87 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -474,7 +474,8 @@ command-line flag, code coverage is collected and statistics are reported once all tests have completed. If the [`NODE_V8_COVERAGE`][] environment variable is used to specify a code coverage directory, the generated V8 coverage files are written to that directory. Node.js core modules and files within -`node_modules/` directories are not included in the coverage report. If +`node_modules/` directories are, by default, not included in the coverage report. +However, they can be explicity included via the [`--test-coverage-include`][] flag. If coverage is enabled, the coverage report is sent to any [test reporters][] via the `'test:coverage'` event. @@ -3507,6 +3508,7 @@ Can be used to abort test subtasks when the test has been aborted. [`--experimental-test-snapshots`]: cli.md#--experimental-test-snapshots [`--import`]: cli.md#--importmodule [`--test-concurrency`]: cli.md#--test-concurrency +[`--test-coverage-include`]: cli.md#--test-coverage-include [`--test-name-pattern`]: cli.md#--test-name-pattern [`--test-only`]: cli.md#--test-only [`--test-reporter-destination`]: cli.md#--test-reporter-destination