test: add tests to ensure that node.1 is kept in sync with cli.md by dario-piotrowicz · Pull Request #58878 · nodejs/node

dario-piotrowicz · 2025-06-28T20:59:54Z

add tests to make sure that the content of the doc/node.1 file is kept in snyc with the content of the doc/api/cli.md file (to make sure that when a flag or environment variable is added or removed to one, the same change is also applied to the other)

codecov · 2025-06-28T21:49:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.11%. Comparing base (4d5ee24) to head (c3be698).
Report is 13 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #58878 +/- ##
=======================================
Coverage 90.10% 90.11% =======================================
Files 640 640 Lines 188493 188426 -67 Branches 36971 36960 -11 =======================================
- Hits 169843 169793 -50 + Misses 11358 11332 -26 - Partials 7292 7301 +9

see 31 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

add tests to make sure that the content of the doc/node.1 file is kept in snyc with the content of the doc/api/cli.md file (to make sure that when a flag or environment variable is added or removed to one, the same change is also applied to the other)

Co-authored-by: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>

dario-piotrowicz · 2025-06-29T20:32:04Z

@VoltrexKeyva, suggestions accepted, thanks for having a look at the PR 🫶

Regarding non-capturing groups, I did accept the suggestions anyways I wanted to mention that I generally purposely avoid adding the ?:s unless actually necessary since they, in my opinion, add extra noise to regexes, which are already generally hard to read on their own (I appreciate that with ?: you're clearly indicating that you don't care about capturing the content inside that group, however I don't know if that is worth the extra (although small) complexity/noise 🤔 )

nodejs-github-bot · 2025-06-29T20:44:03Z

CI: https://ci.nodejs.org/job/node-test-pull-request/67725/

jasnell · 2025-06-29T20:45:24Z

+ 'experimental-require-module',
+ 'experimental-sea-config',
+ 'experimental-worker-inspection',
+ 'expose-gc',


This is the only one I'm not sure about adding to node.1. The rest should be fine tho.

what's the rationale about wanting the flag in the CLI docs but not in the manpage? 🤔

expose-gc is actually a v8 provided flag and we typically do not document them. I can't remember the rationale for why we added it to the CLI docs.

The documentation was added in #53078
It seems like you and Joyee requested the doc's removal, but only part of it was actually removed? 🤔
(although Joyee's next suggestion makes it sound like they were ok with the docs after all?... 🤔)
Anyways, it looks likely that the docs for the flag were just added by mistake, what do you think?
I can open a PR removing the flag from the docs and see what people say?

nodejs-github-bot · 2025-06-29T21:51:33Z

CI: https://ci.nodejs.org/job/node-test-pull-request/67733/

dario-piotrowicz · 2025-06-29T22:20:04Z

@jasnell Issues added for the missing env variables and options 🙂

I've also linked those in the code comments 👍

By the way, I put my name in the TODO comments as I am happy to look into adding those, however the issues also seems like nice potential good first issues (and we only have a few of those), what do you think? maybe it'd be better to remove my name from the TODO comments, add the good first issue label to the issues? 🤔

nodejs-github-bot · 2025-06-30T10:10:02Z

CI: https://ci.nodejs.org/job/node-test-pull-request/67743/ 💛

jasnell · 2025-06-30T10:49:41Z

Add your name to the todo comments isn't really claiming them but providing a pointer for someone who may want to tackle those todos later... it basically identifies who to go ask about it :-)

nodejs-github-bot · 2025-06-30T21:03:30Z

Landed in 4b4aaf9

add tests to make sure that the content of the doc/node.1 file is kept in snyc with the content of the doc/api/cli.md file (to make sure that when a flag or environment variable is added or removed to one, the same change is also applied to the other) PR-URL: #58878 Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs/node#58878

* chore: bump node in DEPS to v22.18.0 * crypto: fix inclusion of OPENSSL_IS_BORINGSSL define nodejs/node#58845 * crypto: fix SHAKE128/256 breaking change introduced with OpenSSL 3.4 nodejs/node#58960 * permission: propagate permission model flags on spawn nodejs/node#58853 * esm: syncify default path of ModuleLoader\.load nodejs/node#57419 * src: remove fast API for InternalModuleStat nodejs/node#58489 * src: simplify adding fast APIs to ExternalReferenceRegistry nodejs/node#58896 * chore: fixup patch indices * src: fix internalModuleStat v8 fast path nodejs/node#58054 * test: add tests to ensure that node.1 is kept in sync with cli.md nodejs/node#58878 * crypto: fix SHAKE128/256 breaking change introduced with OpenSSL 3.4 nodejs/node#58942 --------- Co-authored-by: electron-roller[bot] <84116207+electron-roller[bot]@users.noreply.github.com> Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

chore: bump node to v22.18.0 (main) (#47937) * chore: bump node in DEPS to v22.18.0 * crypto: fix inclusion of OPENSSL_IS_BORINGSSL define nodejs/node#58845 * crypto: fix SHAKE128/256 breaking change introduced with OpenSSL 3.4 nodejs/node#58960 * permission: propagate permission model flags on spawn nodejs/node#58853 * esm: syncify default path of ModuleLoader\.load nodejs/node#57419 * src: remove fast API for InternalModuleStat nodejs/node#58489 * src: simplify adding fast APIs to ExternalReferenceRegistry nodejs/node#58896 * chore: fixup patch indices * src: fix internalModuleStat v8 fast path nodejs/node#58054 * test: add tests to ensure that node.1 is kept in sync with cli.md nodejs/node#58878 * crypto: fix SHAKE128/256 breaking change introduced with OpenSSL 3.4 nodejs/node#58942 --------- Co-authored-by: electron-roller[bot] <84116207+electron-roller[bot]@users.noreply.github.com> Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

* chore: bump node in DEPS to v22.18.0 * crypto: fix inclusion of OPENSSL_IS_BORINGSSL define nodejs/node#58845 * crypto: fix SHAKE128/256 breaking change introduced with OpenSSL 3.4 nodejs/node#58960 * permission: propagate permission model flags on spawn nodejs/node#58853 * esm: syncify default path of ModuleLoader\.load nodejs/node#57419 * src: remove fast API for InternalModuleStat nodejs/node#58489 * src: simplify adding fast APIs to ExternalReferenceRegistry nodejs/node#58896 * chore: fixup patch indices * src: fix internalModuleStat v8 fast path nodejs/node#58054 * test: add tests to ensure that node.1 is kept in sync with cli.md nodejs/node#58878 * crypto: fix SHAKE128/256 breaking change introduced with OpenSSL 3.4 nodejs/node#58942 --------- Co-authored-by: electron-roller[bot] <84116207+electron-roller[bot]@users.noreply.github.com> Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

nodejs-github-bot added needs-ci PRs that need a full CI run. test Issues and PRs related to the tests. labels Jun 28, 2025

dario-piotrowicz force-pushed the dario/node.1-cli-sync-tests branch 4 times, most recently from 436ee86 to f9bf6f8Compare June 28, 2025 23:05

dario-piotrowicz force-pushed the dario/node.1-cli-sync-tests branch from f9bf6f8 to 31315b2Compare June 28, 2025 23:27

This comment was marked as outdated.
Sign in to view

VoltrexKeyva reviewed Jun 29, 2025
View reviewed changes

Comment threadtest/parallel/test-cli-node-cli-manpage-env-vars.mjs Outdated
Comment threadtest/parallel/test-cli-node-cli-manpage-options.mjs Outdated

Apply suggestions from code review
6acdbef
Co-authored-by: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>

dario-piotrowicz added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Jun 29, 2025

dario-piotrowicz requested a review from VoltrexKeyva June 29, 2025 20:32

dario-piotrowicz added 2 commits June 29, 2025 21:41

replace \ns with platform independeny EOLs
8f55596

add node: prefix to assert import
09a14d1

jasnell reviewed Jun 29, 2025
View reviewed changes

Comment threadtest/parallel/test-cli-node-cli-manpage-env-vars.mjs

jasnell reviewed Jun 29, 2025
View reviewed changes

Comment threadtest/parallel/test-cli-node-cli-manpage-options.mjs

atlowChemi approved these changes Jun 29, 2025
View reviewed changes

dario-piotrowicz added the request-ci Add this label to start a Jenkins CI on a PR. label Jun 29, 2025

github-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jun 29, 2025

dario-piotrowicz mentioned this pull request Jun 29, 2025
Some environment variables documented in the CLI docs are missing in node manpage #58894
Closed

add reference to env variables issue
a2a1c6f

dario-piotrowicz mentioned this pull request Jun 29, 2025
Some CLI options documented in the CLI docs are missing in node manpage #58895
Closed

add reference to options issue
c3be698

This comment was marked as outdated.
Sign in to view

jasnell approved these changes Jun 30, 2025
View reviewed changes

jasnell added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 30, 2025

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

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 30, 2025

nodejs-github-bot merged commit 4b4aaf9 into nodejs:mainJun 30, 2025
60 checks passed

dario-piotrowicz deleted the dario/node.1-cli-sync-tests branch June 30, 2025 21:24

dario-piotrowicz mentioned this pull request Jun 30, 2025
doc: remove --expose-gc flag from CLI documentation #58909
Merged

github-actionsBot mentioned this pull request Jul 8, 2025
2025-07-09, Version 24.4.0 (Current) #58993
Merged

github-actionsBot mentioned this pull request Jul 28, 2025
2025-07-29, Version 22.18.0 'Jod' (LTS) #59256
Merged

codebytere added a commit to electron/electron that referenced this pull request Aug 4, 2025
test: add tests to ensure that node.1 is kept in sync with cli.md
605c137
nodejs/node#58878

Uh oh!

Uh oh!

Conversation

dario-piotrowicz commented Jun 28, 2025

Uh oh!

codecovBot commented Jun 28, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

dario-piotrowicz commented Jun 29, 2025

Uh oh!

nodejs-github-bot commented Jun 29, 2025

Uh oh!

Uh oh!

jasnellJun 29, 2025

Choose a reason for hiding this comment

Uh oh!

dario-piotrowiczJun 29, 2025

Choose a reason for hiding this comment

Uh oh!

jasnellJun 29, 2025

Choose a reason for hiding this comment

Uh oh!

dario-piotrowiczJun 29, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nodejs-github-bot commented Jun 29, 2025

Uh oh!

dario-piotrowicz commented Jun 29, 2025

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

nodejs-github-bot commented Jun 30, 2025• edited by jasnell Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jasnell commented Jun 30, 2025

Uh oh!

Uh oh!

nodejs-github-bot commented Jun 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecovBot commented Jun 28, 2025•
edited
Loading

dario-piotrowiczJun 29, 2025•
edited
Loading

nodejs-github-bot commented Jun 30, 2025•
edited by jasnell
Loading