test: add tests to ensure that node.1 is kept in sync with cli.md

[dario-piotrowicz]

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]

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.

[dario-piotrowicz]

@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]

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

[jasnell]

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

[dario-piotrowicz]

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

[jasnell]

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.

[dario-piotrowicz]

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]

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

[dario-piotrowicz]

@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]

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

[jasnell]

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]

Landed in 4b4aaf9