Skip to content

Commit d60b017

Browse files
Trottrvagg
authored andcommitted
test,doc: adjust markdown table for linting
In preparation for applying markdown linting to the `test` directory, adjust the table in `test/README.md` to comply with our markdown rules. PR-URL: #22221 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Khaidi Chu <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: George Adams <[email protected]>
1 parent 8f56cc0 commit d60b017

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

test/README.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,25 @@ GitHub with the `autocrlf` git config flag set to true.
1313

1414
## Test Directories
1515

16-
|Directory |Runs on CI |Purpose |
17-
|-------------------|---------------|---------------|
18-
|abort |Yes |Tests for when the ``` --abort-on-uncaught-exception ``` flag is used.|
19-
|addons |Yes |Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon to function properly.|
20-
|addons-napi |Yes |Tests for [n-api](https://nodejs.org/api/n-api.html) functionality.|
21-
|async-hooks |Yes |Tests for [async_hooks](https://nodejs.org/api/async_hooks.html) functionality.|
22-
|cctest |Yes |C++ tests that are run as part of the build process.|
23-
|code-cache |No |Tests for a Node.js binary compiled with V8 code cache.|
24-
|common | |Common modules shared among many tests. [Documentation](./common/README.md)|
25-
|doctool |Yes |Tests for the documentation generator.|
26-
|es-module |Yes |Test ESM module loading.|
27-
|fixtures | |Test fixtures used in various tests throughout the test suite.|
28-
|internet |No |Tests that make real outbound connections (mainly networking related modules). Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections.|
29-
|known_issues |Yes |Tests reproducing known issues within the system. All tests inside of this directory are expected to fail consistently. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`.|
30-
|message |Yes |Tests for messages that are output for various conditions (```console.log```, error messages etc.)|
31-
|parallel |Yes |Various tests that are able to be run in parallel.|
32-
|pseudo-tty |Yes |Tests that require stdin/stdout/stderr to be a TTY.|
33-
|pummel |No |Various tests for various modules / system functionality operating under load.|
34-
|sequential |Yes |Various tests that are run sequentially.|
35-
|testpy | |Test configuration utility used by various test suites.|
36-
|tick-processor |No |Tests for the V8 tick processor integration. The tests are for the logic in ```lib/internal/v8_prof_processor.js``` and ```lib/internal/v8_prof_polyfill.js```. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic.|
37-
|v8-updates |No |Tests for V8 performance integration.|
16+
| Directory | Runs on CI | Purpose |
17+
| ------------------- | --------------- | --------------- |
18+
| `abort` | Yes | Tests for when the ``` --abort-on-uncaught-exception ``` flag is used. |
19+
| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon to function properly. |
20+
| `addons-napi` | Yes | Tests for [n-api](https://nodejs.org/api/n-api.html) functionality. |
21+
| `async-hooks` | Yes | Tests for [async_hooks](https://nodejs.org/api/async_hooks.html) functionality. |
22+
| `cctest` | Yes | C++ tests that are run as part of the build process. |
23+
| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. |
24+
| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) |
25+
| `doctool` | Yes | Tests for the documentation generator. |
26+
| `es-module` | Yes | Test ESM module loading. |
27+
| `fixtures` | | Test fixtures used in various tests throughout the test suite. |
28+
| `internet` | No | Tests that make real outbound connections (mainly networking related modules). Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. |
29+
| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail consistently. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. |
30+
| `message` | Yes | Tests for messages that are output for various conditions (```console.log```, error messages etc.) |
31+
| `parallel` | Yes | Various tests that are able to be run in parallel. |
32+
| `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
33+
| `pummel` | No | Various tests for various modules / system functionality operating under load. |
34+
| `sequential` | Yes | Various tests that are run sequentially. |
35+
| `testpy` | | Test configuration utility used by various test suites. |
36+
| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in ```lib/internal/v8_prof_processor.js``` and ```lib/internal/v8_prof_polyfill.js```. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. |
37+
| `v8-updates` | No | Tests for V8 performance integration. |

0 commit comments

Comments
 (0)