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

Example for running the test runner manually is broken #49488

Closed
mcollina opened this issue Sep 4, 2023 · 2 comments · Fixed by #49489
Closed

Example for running the test runner manually is broken #49488

mcollina opened this issue Sep 4, 2023 · 2 comments · Fixed by #49489
Labels
good first issue Issues that are suitable for first-time contributors. test_runner Issues and PRs related to the test runner subsystem.

Comments

@mcollina
Copy link
Member

mcollina commented Sep 4, 2023

The current example:

import { tap } from 'node:test/reporters';
import process from 'node:process';

run({ files: [path.resolve('./tests/test.js')] })
  .compose(tap)
  .pipe(process.stdout);

Does not run because it's missing a few imports:

  • run
  • path
@MoLow MoLow added good first issue Issues that are suitable for first-time contributors. test_runner Issues and PRs related to the test runner subsystem. labels Sep 4, 2023
@MoLow
Copy link
Member

MoLow commented Sep 4, 2023

added the good first issue Issues that are suitable for first-time contributors. label. PRS fixing the documentation are welcome

@OshriAsulin
Copy link
Contributor

OshriAsulin commented Sep 4, 2023 •
edited
Loading

@MoLow
I have submitted two pull requests (PRs) to address and resolve this issue.
#49489 and #49490

@MoLow MoLow mentioned this issue Sep 4, 2023
Merged
nodejs-github-bot pushed a commit that referenced this issue Sep 6, 2023
@OshriAsulin
doc: fix missing imports in test.run code examples
6919d72 
The script was missing necessary imports for the `run`
function and the `path` module, causing it to fail.
This commit adds the missing imports and resolves the issue.

- Import `run` from the appropriate module.
- Import `path` to resolve file paths.

The script should now run without errors.

PR-URL: #49489
Fixes: #49488
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
ruyadorno pushed a commit that referenced this issue Sep 28, 2023
@OshriAsulin @ruyadorno
doc: fix missing imports in test.run code examples
f3fea92 
The script was missing necessary imports for the `run`
function and the `path` module, causing it to fail.
This commit adds the missing imports and resolves the issue.

- Import `run` from the appropriate module.
- Import `path` to resolve file paths.

The script should now run without errors.

PR-URL: #49489
Fixes: #49488
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
alexfernandez pushed a commit to alexfernandez/node that referenced this issue Nov 1, 2023
@OshriAsulin @alexfernandez
doc: fix missing imports in test.run code examples
5e87609 
The script was missing necessary imports for the `run`
function and the `path` module, causing it to fail.
This commit adds the missing imports and resolves the issue.

- Import `run` from the appropriate module.
- Import `path` to resolve file paths.

The script should now run without errors.

PR-URL: nodejs#49489
Fixes: nodejs#49488
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Issues that are suitable for first-time contributors. test_runner Issues and PRs related to the test runner subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: Fix missing imports in script OshriAsulin/node
3 participants
@mcollina @MoLow @OshriAsulin