Skip to content

Commit c733cc0

Browse files
committed
test_runner: mark module as stable
PR-URL: #46983 Fixes: #46642 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Danielle Adams <adamzdanielle@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
1 parent 9960c36 commit c733cc0

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

doc/api/cli.md

+19
Original file line numberDiff line numberDiff line change
@@ -1396,6 +1396,9 @@ added:
13961396
- v18.1.0
13971397
- v16.17.0
13981398
changes:
1399+
- version: REPLACEME
1400+
pr-url: https://github.com/nodejs/node/pull/46983
1401+
description: The test runner is now stable.
13991402
- version:
14001403
- v19.2.0
14011404
- v18.13.0
@@ -1412,6 +1415,10 @@ for more details.
14121415

14131416
<!-- YAML
14141417
added: v18.11.0
1418+
changes:
1419+
- version: REPLACEME
1420+
pr-url: https://github.com/nodejs/node/pull/46983
1421+
description: The test runner is now stable.
14151422
-->
14161423

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

14291440
A test reporter to use when running tests. See the documentation on
@@ -1435,6 +1446,10 @@ A test reporter to use when running tests. See the documentation on
14351446
added:
14361447
- v19.6.0
14371448
- v18.15.0
1449+
changes:
1450+
- version: REPLACEME
1451+
pr-url: https://github.com/nodejs/node/pull/46983
1452+
description: The test runner is now stable.
14381453
-->
14391454

14401455
The destination for the corresponding test reporter. See the documentation on
@@ -1446,6 +1461,10 @@ The destination for the corresponding test reporter. See the documentation on
14461461
added:
14471462
- v18.0.0
14481463
- v16.17.0
1464+
changes:
1465+
- version: REPLACEME
1466+
pr-url: https://github.com/nodejs/node/pull/46983
1467+
description: The test runner is now stable.
14491468
-->
14501469

14511470
Configures the test runner to only execute top level tests that have the `only`

doc/api/test.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@
66
added:
77
- v18.0.0
88
- v16.17.0
9+
changes:
10+
- version: REPLACEME
11+
pr-url: https://github.com/nodejs/node/pull/46983
12+
description: The test runner is now stable.
913
-->
1014

11-
> Stability: 1 - Experimental
15+
> Stability: 2 - Stable
1216
1317
<!-- source_link=lib/test.js -->
1418

@@ -377,6 +381,8 @@ internally.
377381

378382
## Collecting code coverage
379383

384+
> Stability: 1 - Experimental
385+
380386
When Node.js is started with the [`--experimental-test-coverage`][]
381387
command-line flag, code coverage is collected and statistics are reported once
382388
all tests have completed. If the [`NODE_V8_COVERAGE`][] environment variable is
@@ -535,6 +541,11 @@ The following built-reporters are supported:
535541
When `stdout` is a [TTY][], the `spec` reporter is used by default.
536542
Otherwise, the `tap` reporter is used by default.
537543

544+
The exact output of these reporters is subject to change between versions of
545+
Node.js, and should not be relied on programmatically. If programmatic access
546+
to the test runner's output is required, use the events emitted by the
547+
{TestsStream}.
548+
538549
### Custom reporters
539550

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

0 commit comments

Comments
 (0)