Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test_runner: mark module as stable #46983

Merged
merged 1 commit into from
Mar 8, 2023
Merged

test_runner: mark module as stable #46983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions doc/api/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1396,6 +1396,9 @@ added:
- v18.1.0
- v16.17.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/46983
description: The test runner is now stable.
- version:
- v19.2.0
- v18.13.0
Expand All @@ -1412,6 +1415,10 @@ for more details.

<!-- YAML
added: v18.11.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/46983
description: The test runner is now stable.
-->

A regular expression that configures the test runner to only execute tests
Expand All @@ -1424,6 +1431,10 @@ whose name matches the provided pattern. See the documentation on
added:
- v19.6.0
- v18.15.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/46983
description: The test runner is now stable.
-->

A test reporter to use when running tests. See the documentation on
Expand All @@ -1435,6 +1446,10 @@ A test reporter to use when running tests. See the documentation on
added:
- v19.6.0
- v18.15.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/46983
description: The test runner is now stable.
-->

The destination for the corresponding test reporter. See the documentation on
Expand All @@ -1446,6 +1461,10 @@ The destination for the corresponding test reporter. See the documentation on
added:
- v18.0.0
- v16.17.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/46983
description: The test runner is now stable.
-->

Configures the test runner to only execute top level tests that have the `only`
Expand Down
13 changes: 12 additions & 1 deletion doc/api/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@
added:
- v18.0.0
- v16.17.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/46983
description: The test runner is now stable.
-->

> Stability: 1 - Experimental
> Stability: 2 - Stable

<!-- source_link=lib/test.js -->

Expand Down Expand Up @@ -377,6 +381,8 @@ internally.

## Collecting code coverage

> Stability: 1 - Experimental

When Node.js is started with the [`--experimental-test-coverage`][]
command-line flag, code coverage is collected and statistics are reported once
all tests have completed. If the [`NODE_V8_COVERAGE`][] environment variable is
Expand Down Expand Up @@ -535,6 +541,11 @@ The following built-reporters are supported:
When `stdout` is a [TTY][], the `spec` reporter is used by default.
Otherwise, the `tap` reporter is used by default.

The exact output of these reporters is subject to change between versions of
Node.js, and should not be relied on programmatically. If programmatic access
to the test runner's output is required, use the events emitted by the
{TestsStream}.

### Custom reporters

[`--test-reporter`][] can be used to specify a path to custom reporter.
Expand Down