doc: clarify --watch and --watch-path usage with --run by juanibe · Pull Request #58136 · nodejs/node

juanibe · 2025-05-03T10:10:31Z

This PR adds a note under the --watch and --watch-path CLI options in cli.md to clarify that these flags require a file path and cannot be used with --run.

Fixes confusion where users might assume --watch-path or --watch work with --run, which currently results in a runtime error.

Helps address issue discussion here

juanarbol · 2025-05-03T16:23:32Z

Hi! Thanks for taking care of this.

The PR may need some extra edits. The implies of watch in watch-path is not being shown, and also, just keep in mind that the --run flag has priority; It can not be mixed with watch and its derivatives. Could you please reflect that into your PR?

Refs:
https://github.com/nodejs/node/blob/main/src/node.cc#L1067

juanibe · 2025-05-03T17:14:40Z

Hi @juanarbol!, thanks for the observation
I added the missing detail that --watch-path implicitly enables --watch and simplified the wording to reduce redundancy (since the reader can now refer to --watch). Let me know if any further clarification or modification is needed

juanarbol

Just some more minor clarifications, I'm sorry I just forgot a couple details, but after this; I'm more than happy with this PR. Thanks again!

juanarbol

RLGTM

juanarbol · 2025-05-03T18:48:09Z

Worth reading doc.

https://github.com/nodejs/node/blob/70863fb9dd4b70f1ba6141db4403e69eb7a9eeff/CONTRIBUTING.md :)

juanarbol

lgtm

juanarbol · 2025-05-03T23:03:13Z

Test failure is already reported.

Refs: #58127

juanibe · 2025-05-04T14:34:57Z

Updated the first commit message accordingly by amending it

juanarbol · 2025-05-04T17:35:34Z

Updated the first commit message accordingly by amending it

Thanks. You don't have to do it now, but if you intend to land a single commit, squash everything into a single commit.

juanibe · 2025-05-06T08:28:55Z

Updated the first commit message accordingly by amending it

Thanks. You don't have to do it now, but if you intend to land a single commit, squash everything into a single commit.

Thanks! I've squashed the commits and the PR should be ready now. Let me know if there's anything else needed from my side.

juanarbol · 2025-05-07T04:06:24Z

Thanks! I've squashed the commits and the PR should be ready now. Let me know if there's anything else needed from my side.

I'm sorry, CI still not happy due to commit guidelines. Fix it, will approve and wait for more reviews :-)

Humble ping to @nodejs/documentation

Refs:
https://github.com/nodejs/node/actions/runs/14824640752/job/41770212057#step:6:15

juanibe · 2025-05-07T09:09:28Z

Yeah, missed that part 🙏.
Already amended it
Thanks!

Co-authored-by: Tierney Cyren <accounts@bnb.im>

juanarbol · 2025-05-16T19:26:14Z

@juanibe https://github.com/nodejs/node/actions/runs/14916227242/job/42382918668?pr=58136#step:7:21

Please, please, always run linters/tests before exposing it for review. Once CI is happy, this will be landed.

juanibe · 2025-05-16T19:39:24Z

@juanibe https://github.com/nodejs/node/actions/runs/14916227242/job/42382918668?pr=58136#step:7:21

Please, please, always run linters/tests before exposing it for review. Once CI is happy, this will be landed.

Thanks @juanarbol for the reminder I've just run make format-md and pushed the changes. Let me know if there's anything else I should take care of.

nodejs-github-bot · 2025-05-19T19:18:07Z

Commit Queue failed

- Loading data for nodejs/node/pull/58136 ✔ Done loading data for nodejs/node/pull/58136 ----------------------------------- PR info ------------------------------------ Title doc: clarify --watch and --watch-path usage with --run (#58136) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch juanibe:docs/watch-cli-usage -> nodejs:main Labels doc, cli, author ready Commits 3 - doc: clarify behavior of --watch-path and --watch flags - Update doc/api/cli.md - doc: clarify context of --run incompatibility Committers 2 - Juan Ignacio Benito <benitojuanignacio@gmail.com> - GitHub <noreply@github.com> PR-URL: https://github.com/nodejs/node/pull/58136 Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Tierney Cyren <hello@bnb.im> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/58136 Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Tierney Cyren <hello@bnb.im> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> -------------------------------------------------------------------------------- ℹ This PR was created on Sat, 03 May 2025 10:10:31 GMT ✔ Approvals: 4 ✔ - Juan José Arboleda (@juanarbol): https://github.com/nodejs/node/pull/58136#pullrequestreview-2851757702 ✔ - Tierney Cyren (@bnb): https://github.com/nodejs/node/pull/58136#pullrequestreview-2833848422 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/58136#pullrequestreview-2834775904 ✔ - Ulises Gascón (@UlisesGascon): https://github.com/nodejs/node/pull/58136#pullrequestreview-2835351578 ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/main up to date... From https://github.com/nodejs/node * branch main -> FETCH_HEAD ✔ origin/main is now up-to-date - Downloading patch for 58136 From https://github.com/nodejs/node * branch refs/pull/58136/merge -> FETCH_HEAD ✔ Fetched commits as b395420a99ff..6cd8d116fc9b -------------------------------------------------------------------------------- Auto-merging doc/api/cli.md [main 1fe793a132] doc: clarify behavior of --watch-path and --watch flags Author: Juan Ignacio Benito <benitojuanignacio@gmail.com> Date: Sat May 3 11:07:24 2025 +0100 1 file changed, 7 insertions(+) Auto-merging doc/api/cli.md [main 35555b9788] Update doc/api/cli.md Author: juanibe <39571376+juanibe@users.noreply.github.com> Date: Thu May 8 17:13:01 2025 +0100 1 file changed, 1 insertion(+), 1 deletion(-) Auto-merging doc/api/cli.md [main 0eee13a752] doc: clarify context of --run incompatibility Author: Juan Ignacio Benito <benitojuanignacio@gmail.com> Date: Thu May 8 22:10:55 2025 +0100 1 file changed, 3 insertions(+), 3 deletions(-) ✔ Patches applied There are 3 commits in the PR. Attempting autorebase. Rebasing (2/6) Executing: git node land --amend --yes --------------------------------- New Message ---------------------------------- doc: clarify behavior of --watch-path and --watch flags

PR-URL: #58136
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

[detached HEAD de56f98f63] doc: clarify behavior of --watch-path and --watch flags
Author: Juan Ignacio Benito <benitojuanignacio@gmail.com>
Date: Sat May 3 11:07:24 2025 +0100
1 file changed, 7 insertions(+)
Rebasing (3/6)
Rebasing (4/6)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update doc/api/cli.md

Co-authored-by: Tierney Cyren <accounts@bnb.im>
PR-URL: #58136
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

[detached HEAD 22b2e8356b] Update doc/api/cli.md
Author: juanibe <39571376+juanibe@users.noreply.github.com>
Date: Thu May 8 17:13:01 2025 +0100
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (5/6)
Rebasing (6/6)
Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc: clarify context of --run incompatibility

PR-URL: #58136
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

[detached HEAD 3f60e3ef87] doc: clarify context of --run incompatibility
Author: Juan Ignacio Benito <benitojuanignacio@gmail.com>
Date: Thu May 8 22:10:55 2025 +0100
1 file changed, 3 insertions(+), 3 deletions(-)
Successfully rebased and updated refs/heads/main.

ℹ Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.

https://github.com/nodejs/node/actions/runs/15121317393

juanarbol · 2025-05-22T17:00:18Z

Landed in 0d3e1b3 🎉

Congrats on the contribution! Thanks!

nodejs-github-bot added cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. labels May 3, 2025

juanibe mentioned this pull request May 3, 2025

--watch-path combined with --run fails #58113

Closed

shivarm reviewed May 3, 2025

View reviewed changes

Comment thread doc/api/cli.md

juanarbol requested changes May 3, 2025

View reviewed changes

Comment thread doc/api/cli.md Outdated

Comment thread doc/api/cli.md Outdated

juanarbol approved these changes May 3, 2025

View reviewed changes

juanibe changed the title ~~docs: clarify --watch and --watch-path usage with --run~~ doc: clarify --watch and --watch-path usage with --run May 3, 2025

juanarbol approved these changes May 3, 2025

View reviewed changes

juanarbol added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 3, 2025

juanibe force-pushed the docs/watch-cli-usage branch from a0fca22 to b740f44 Compare May 4, 2025 14:33

juanibe force-pushed the docs/watch-cli-usage branch 2 times, most recently from 90561a2 to c5881e6 Compare May 4, 2025 19:51

doc: clarify behavior of --watch-path and --watch flags

e8bef23

juanibe force-pushed the docs/watch-cli-usage branch from c5881e6 to e8bef23 Compare May 7, 2025 09:06

bnb requested changes May 8, 2025

View reviewed changes

Comment thread doc/api/cli.md Outdated

Comment thread doc/api/cli.md Outdated

Update doc/api/cli.md

f6b87b7

Co-authored-by: Tierney Cyren <accounts@bnb.im>

juanibe requested a review from bnb May 12, 2025 09:07

bnb approved these changes May 12, 2025

View reviewed changes

jasnell approved these changes May 12, 2025

View reviewed changes

UlisesGascon approved these changes May 13, 2025

View reviewed changes

aymen94 approved these changes May 14, 2025

View reviewed changes

viky-01 mentioned this pull request May 14, 2025

doc: clarify --watch and --watch-path usage with --run #58334

Open

doc: clarify context of --run incompatibility

6cd8d11

juanibe force-pushed the docs/watch-cli-usage branch from b34c59e to 6cd8d11 Compare May 16, 2025 19:32

juanarbol added the commit-queue Add this label to land a pull request using GitHub Actions. label May 19, 2025

nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels May 19, 2025

This comment was marked as outdated.

Sign in to view

juanarbol approved these changes May 19, 2025

View reviewed changes

juanarbol added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels May 19, 2025

nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels May 19, 2025

juanarbol added commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels May 19, 2025

juanarbol closed this May 22, 2025

juanarbol removed the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label May 22, 2025

This was referenced Jun 8, 2025

2025-06-09, Version 24.2.0 (Current) #58635

Merged

2025-06-24, Version 22.17.0 'Jod' (LTS) #58665

Merged

Conversation

juanibe commented May 3, 2025

Uh oh!

Uh oh!

juanarbol commented May 3, 2025

Uh oh!

juanibe commented May 3, 2025

Uh oh!

juanarbol left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

juanarbol left a comment

Choose a reason for hiding this comment

Uh oh!

juanarbol commented May 3, 2025

Uh oh!

juanarbol left a comment

Choose a reason for hiding this comment

Uh oh!

juanarbol commented May 3, 2025

Uh oh!

juanibe commented May 4, 2025

Uh oh!

juanarbol commented May 4, 2025

Uh oh!

juanibe commented May 6, 2025

Uh oh!

juanarbol commented May 7, 2025

Uh oh!

juanibe commented May 7, 2025

Uh oh!

Uh oh!

Uh oh!

juanarbol commented May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

juanibe commented May 16, 2025

Uh oh!

This comment was marked as outdated.

nodejs-github-bot commented May 19, 2025

PR-URL: #58136 Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Tierney Cyren <hello@bnb.im> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

Co-authored-by: Tierney Cyren <accounts@bnb.im> PR-URL: #58136 Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Tierney Cyren <hello@bnb.im> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

PR-URL: #58136 Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Tierney Cyren <hello@bnb.im> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

[detached HEAD 3f60e3ef87] doc: clarify context of --run incompatibility Author: Juan Ignacio Benito <benitojuanignacio@gmail.com> Date: Thu May 8 22:10:55 2025 +0100 1 file changed, 3 insertions(+), 3 deletions(-) Successfully rebased and updated refs/heads/main.

Uh oh!

juanarbol commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

juanarbol commented May 16, 2025 •

edited

Loading

PR-URL: #58136
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

Co-authored-by: Tierney Cyren <accounts@bnb.im>
PR-URL: #58136
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

PR-URL: #58136
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>

[detached HEAD 3f60e3ef87] doc: clarify context of --run incompatibility
Author: Juan Ignacio Benito <benitojuanignacio@gmail.com>
Date: Thu May 8 22:10:55 2025 +0100
1 file changed, 3 insertions(+), 3 deletions(-)
Successfully rebased and updated refs/heads/main.

juanarbol commented May 22, 2025 •

edited

Loading