Collecting code coverage

Node.js provides built-in support for code coverage through its test runner, which can be enabled using the --experimental-test-coverage flag. If using the run() API, the coverage option must be set to true. For more information on the run() API, see the node:test documentation.

What is code coverage?

Code coverage is a metric for test runners that gauges how much of a program’s source code is executed during testing. It reveals which portions of the codebase are tested and which are not, helping to pinpoint gaps in the test suite. This ensures more comprehensive testing of the software and minimizes the risk of undetected bugs. Typically expressed as a percentage, higher code coverage percentages indicate more thorough test coverage. For a more detailed explanation, refer to the “Code coverage” Wikipedia article.

Basic coverage reporting

Let’s walk through a simple example to demonstrate how code coverage works in Node.js.

This example, and all other ones in this page, are written using CommonJS. If you are unfamiliar with this concept, please read the CommonJS Modules documentation.

function add(a, b) {
  return a + b;
}

function isEven(num) {
  return num % 2 === 0;
}

function multiply(a, b) {
  return a * b;
}

module.exports = { add, isEven, multiply };

In the module, we have three functions: add, isEven, and multiply. In the test file, we are testing the add() and isEven() functions. Notice that the multiply() function is not covered by any tests. To collect code coverage while running your tests:

CLI
run() API

node --experimental-test-coverage --test main.test.js

run({ files: ['main.test.js'], coverage: true });

After running the tests, you’ll receive a report that looks something like this:

✔ add() should add two numbers (1.505987ms)
✔ isEven() should report whether a number is even (0.175859ms)
ℹ tests 2
ℹ suites 0
ℹ pass 2
ℹ fail 0
ℹ cancelled 0
ℹ skipped 0
ℹ todo 0
ℹ duration_ms 59.480373
ℹ start of coverage report
ℹ -------------------------------------------------------------
ℹ file         | line % | branch % | funcs % | uncovered lines
ℹ -------------------------------------------------------------
ℹ main.js      |  76.92 |   100.00 |   66.67 | 9-11
ℹ main.test.js | 100.00 |   100.00 |  100.00 |
ℹ -------------------------------------------------------------
ℹ all files    |  86.96 |   100.00 |   80.00 |
ℹ -------------------------------------------------------------
ℹ end of coverage report

The coverage report provides a breakdown of how much of your code is covered by tests:

Line coverage: The percentage of lines executed during the tests.
Branch coverage: The percentage of code branches (like if-else statements) tested.
Function coverage: The percentage of functions that have been invoked during testing.

In this example:

main.js shows 76.92% line coverage and 66.67% function coverage because the multiply() function was not tested. The uncovered lines (9-11) correspond to this function.
main.test.js shows 100% coverage across all metrics, indicating that the tests themselves were fully executed.

Including and excluding

When working on applications, you might encounter situations where certain files or lines of code need to be excluded. Node.js provides mechanisms to handle this, including the use of comments to ignore specific code sections and the CLI to exclude entire patterns.

Using comments

There are multiple ways to ignore sections of code using comments:

ignore next N
ignore next (line by line)
disable / enable

function add(a, b) {
  return a + b;
}

function isEven(num) {
  return num % 2 === 0;
}

/* node:coverage ignore next 3 */
function multiply(a, b) {
  return a * b;
}

module.exports = { add, isEven, multiply };

function add(a, b) {
  return a + b;
}

function isEven(num) {
  return num % 2 === 0;
}

/* node:coverage ignore next */
function multiply(a, b) {
  /* node:coverage ignore next */
  return a * b;
  /* node:coverage ignore next */
}

module.exports = { add, isEven, multiply };

function add(a, b) {
  return a + b;
}

function isEven(num) {
  return num % 2 === 0;
}

/* node:coverage disable */
function multiply(a, b) {
  return a * b;
}
/* node:coverage enable */

module.exports = { add, isEven, multiply };

Each of these different methods will produce the same report, with 100% code coverage across all metrics:

ℹ start of coverage report
ℹ -------------------------------------------------------------
ℹ file         | line % | branch % | funcs % | uncovered lines
ℹ -------------------------------------------------------------
ℹ main.js      | 100.00 |   100.00 |  100.00 |
ℹ main.test.js | 100.00 |   100.00 |  100.00 |
ℹ -------------------------------------------------------------
ℹ all files    | 100.00 |   100.00 |  100.00 |
ℹ -------------------------------------------------------------
ℹ end of coverage report

Using the CLI

Node.js offers two CLI arguments for managing the inclusion or exclusion of specific files in a coverage report.

--test-coverage-include (coverageIncludeGlobs in the run() API) restricts the coverage to files that match the provided glob pattern. By default, files in the /node_modules/ directory are excluded, but this flag allows you to explicitly include them.
--test-coverage-exclude (coverageExcludeGlobs in the run() API) omits files that match the given glob pattern from the coverage report.

These flags can be used multiple times, and when both are used together, files must adhere to the inclusion rules while also avoiding the exclusion rules. Given the following directory structure:

.
├── main.test.js
├── src
│   ├── age.js
│   └── name.js

And this default coverage report:

ℹ start of coverage report
ℹ -------------------------------------------------------------
ℹ file         | line % | branch % | funcs % | uncovered lines
ℹ -------------------------------------------------------------
ℹ main.test.js | 100.00 |   100.00 |  100.00 |
ℹ src/age.js   |  45.45 |   100.00 |    0.00 | 3-5 7-9
ℹ src/name.js  | 100.00 |   100.00 |  100.00 |
ℹ -------------------------------------------------------------
ℹ all files    |  88.68 |   100.00 |   75.00 |
ℹ -------------------------------------------------------------
ℹ end of coverage report

src/age.js has less-than-optimal coverage, but with --test-coverage-exclude you can exclude it from the report entirely:

CLI
run() API

node --experimental-test-coverage --test-coverage-exclude=src/age.js --test main.test.js

run({
  files: ['main.test.js'],
  coverage: true,
  coverageExclude: ['src/age.js'],
});

ℹ start of coverage report
ℹ -------------------------------------------------------------
ℹ file         | line % | branch % | funcs % | uncovered lines
ℹ -------------------------------------------------------------
ℹ main.test.js | 100.00 |   100.00 |  100.00 |
ℹ src/name.js  | 100.00 |   100.00 |  100.00 |
ℹ -------------------------------------------------------------
ℹ all files    | 100.00 |   100.00 |  100.00 |
ℹ -------------------------------------------------------------
ℹ end of coverage report

Our test file is also included in this coverage report, but we only want JavaScript files in the src/ directory. The --test-coverage-include flag can be used in this case:

CLI
run() API

node --experimental-test-coverage --test-coverage-include=src/*.js --test main.test.js

run({ files: ['main.test.js'], coverage: true, coverageInclude: ['src/*.js'] });

ℹ start of coverage report
ℹ ------------------------------------------------------------
ℹ file        | line % | branch % | funcs % | uncovered lines
ℹ ------------------------------------------------------------
ℹ src/age.js  |  45.45 |   100.00 |    0.00 | 3-5 7-9
ℹ src/name.js | 100.00 |   100.00 |  100.00 |
ℹ ------------------------------------------------------------
ℹ all files   |  72.73 |   100.00 |   66.67 |
ℹ ------------------------------------------------------------
ℹ end of coverage report

Thresholds

By default, when all tests pass, Node.js exits with code 0, which indicates a successful execution. However, the coverage report can be configured to exit with code 1 when coverage is failing. Node.js currently supports thresholds for all three coverage types:

--test-coverage-lines (lineCoverage in the run() API) for line coverage.
--test-coverage-branches (branchCoverage in the run() API) for branch coverage.
--test-coverage-functions (functionCoverage in the run() API) for function coverage.

If you wanted to require the previous example to have line coverage >= 90%:

CLI
run() API

node --experimental-test-coverage --test-coverage-lines=90 --test main.test.js

run({ files: ['main.test.js'], coverage: true, lineCoverage: 90 });

ℹ start of coverage report
ℹ -------------------------------------------------------------
ℹ file         | line % | branch % | funcs % | uncovered lines
ℹ -------------------------------------------------------------
ℹ main.test.js | 100.00 |   100.00 |  100.00 |
ℹ src/age.js   |  45.45 |   100.00 |    0.00 | 3-5 7-9
ℹ src/name.js  | 100.00 |   100.00 |  100.00 |
ℹ -------------------------------------------------------------
ℹ all files    |  88.68 |   100.00 |   75.00 |
ℹ -------------------------------------------------------------
ℹ end of coverage report
ℹ Error: 88.68% line coverage does not meet threshold of 90%.

Getting Started

Asynchronous Work

Command Line

File System

HTTP

Package Management

Diagnostics

Security

Testing

TypeScript

Collecting code coverage

What is code coverage?

Basic coverage reporting

Including and excluding

Using comments

Using the CLI

Thresholds

Build docs developers (and LLMs) love

Getting Started

Asynchronous Work

Command Line

File System

HTTP

Package Management

Diagnostics

Security

Testing

TypeScript

​What is code coverage?

​Basic coverage reporting

​Including and excluding

​Using comments

​Using the CLI

​Thresholds

Build docs developers (and LLMs) love

What is code coverage?

Basic coverage reporting

Including and excluding

Using comments

Using the CLI

Thresholds