Commit c733cc0
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
2 files changed
Lines changed: 31 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1396,6 +1396,9 @@ added: | |||
| 1396 | 1396 | - v18.1.0 | |
| 1397 | 1397 | - v16.17.0 | |
| 1398 | 1398 | changes: | |
| 1399 | + - version: REPLACEME | ||
| 1400 | + pr-url: https://github.com/nodejs/node/pull/46983 | ||
| 1401 | + description: The test runner is now stable. | ||
| 1399 | 1402 | - version: | |
| 1400 | 1403 | - v19.2.0 | |
| 1401 | 1404 | - v18.13.0 | |
@@ -1412,6 +1415,10 @@ for more details. | |||
| 1412 | 1415 | ||
| 1413 | 1416 | <!-- YAML | |
| 1414 | 1417 | 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. | ||
| 1415 | 1422 | --> | |
| 1416 | 1423 | ||
| 1417 | 1424 | 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 | |||
| 1424 | 1431 | added: | |
| 1425 | 1432 | - v19.6.0 | |
| 1426 | 1433 | - 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. | ||
| 1427 | 1438 | --> | |
| 1428 | 1439 | ||
| 1429 | 1440 | 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 | |||
| 1435 | 1446 | added: | |
| 1436 | 1447 | - v19.6.0 | |
| 1437 | 1448 | - 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. | ||
| 1438 | 1453 | --> | |
| 1439 | 1454 | ||
| 1440 | 1455 | 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 | |||
| 1446 | 1461 | added: | |
| 1447 | 1462 | - v18.0.0 | |
| 1448 | 1463 | - 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. | ||
| 1449 | 1468 | --> | |
| 1450 | 1469 | ||
| 1451 | 1470 | Configures the test runner to only execute top level tests that have the `only` | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -6,9 +6,13 @@ | |||
| 6 | 6 | added: | |
| 7 | 7 | - v18.0.0 | |
| 8 | 8 | - 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. | ||
| 9 | 13 | --> | |
| 10 | 14 | ||
| 11 | - > Stability: 1 - Experimental | ||
| 15 | + > Stability: 2 - Stable | ||
| 12 | 16 | ||
| 13 | 17 | <!-- source_link=lib/test.js --> | |
| 14 | 18 | ||
@@ -377,6 +381,8 @@ internally. | |||
| 377 | 381 | ||
| 378 | 382 | ## Collecting code coverage | |
| 379 | 383 | ||
| 384 | + > Stability: 1 - Experimental | ||
| 385 | + | ||
| 380 | 386 | When Node.js is started with the [`--experimental-test-coverage`][] | |
| 381 | 387 | command-line flag, code coverage is collected and statistics are reported once | |
| 382 | 388 | all tests have completed. If the [`NODE_V8_COVERAGE`][] environment variable is | |
@@ -535,6 +541,11 @@ The following built-reporters are supported: | |||
| 535 | 541 | When `stdout` is a [TTY][], the `spec` reporter is used by default. | |
| 536 | 542 | Otherwise, the `tap` reporter is used by default. | |
| 537 | 543 | ||
| 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 | + | ||
| 538 | 549 | ### Custom reporters | |
| 539 | 550 | ||
| 540 | 551 | [`--test-reporter`][] can be used to specify a path to custom reporter. | |
0 commit comments