util: add parseArgs module #42675

bcoe · 2022-04-09T20:56:17Z

Adds util.parseArgs helper for higher level command-line argument parsing.

Background

There has been an ongoing effort in pkgjs/parseargs to define a command-line argument parsing API for Node.js core.

The effort has taken several years to get to this point, with many amazing contributors across a variety of companies and projects: IBM, Microsoft, Google, Shopify, npm, nvm, commander, yargs, just to name a few.

Where parseArgs is at

@shadowspawn, who's been most recently pushing a lot of the work on parseArgs forward, indicates in pkgjs/parseargs/issues/87 that "we're close to having a decent MVP."

I agree, and thought it would be worth having a candidate PR open on Node.js to get additional feedback.

This is a controversial topic, be kind

There's a lot of nuance and opinion, as to what constitutes a "decent MVP" for a command-line argument parser. Please be respectful of opinions you might not agree with 😊

Before leaving feedback on this thread, I suggest reading past issues on parseArgs. Perhaps there's already been a discussion that touches on your feedback (or there's an ongoing discussion).

Similarly, if themes of discussion jump out in this PR, let's move them to an issue in parseArgs (this should help keep this PR less confusing).

ToDo

PR: should flags be removed consolidating on values.~ landed
PR: strict mode handling. landed
Issue: should poisitional parsing be opt-in.
finish audit of prototype pollution.

CC: @ljharb, @bakkot, @iansu, @darcyclarke, @ruyadorno, @shadowspawn, @nodejs/tooling, @Trott (who I believe asked after this), @aaronccasanova.

nodejs-github-bot · 2022-04-09T20:56:21Z

Review requested:

@nodejs/startup

mcollina · 2022-04-09T21:07:48Z

I would recommend this to be exposed as node:parseargs instead (or analog in the node: prefix). process is already overloaded with so much functionality, I would prefer not adding new things there that could stay separate.

doc/api/process.md

ljharb · 2022-04-09T21:20:32Z

It definitely should not be exposed only under the prefix, for a ton of reasons (but that’s being discussed elsewhere)

doc/api/errors.md

doc/api/process.md

lib/internal/process/parse_args/utils.js

test/parallel/test-parse-args.mjs

bcoe · 2022-04-10T00:05:54Z

I would recommend this to be exposed as node:parseargs

@mcollina done, opted for node:parse_args.

bnb · 2022-04-10T00:06:08Z

I am -1 on it being exposed only under the node: prefix. I do not much mind what it's called, but I'd strongly prefer that we do not limit new additions to that unless we're willing to fully break and force it for all modules, retroactively, and force all core modules under it.

I am, however, +1 on this landing assuming we can come to consensus on it.

aaronccasanova · 2022-04-10T00:28:51Z

My assumption thus far was that parseArgs would be exposed from the util module. However, I can see process.parseArgs() being a common replacement for process.argv and I think it would feel very intuitive for folks. That being said, I have no strong preference and would be happy with any consensus.

cjihrig

Left a few comments.

Regarding the node: scheme - there is a vote on this in nodejs/TSC#1206, which is expected to be completed Monday (so a decision can be made in time for Node 18). I think the outcome there should dictate how this module is exposed.

doc/api/parse_args.md

lib/internal/errors.js

doc/api/parse_args.md

test/parallel/test-parse-args.mjs

lib/parse_args.js

lib/internal/parse_args/parse_args.js

doc/api/parse_args.md

bcoe · 2022-04-10T13:52:08Z

I am -1 on it being exposed only under the node: prefix. I do not much mind what it's called, but I'd strongly prefer that we do not limit new additions to that unless we're willing to fully break and force it for all modules

@cjihrig @mcollina @bnb, can we agree that we will have the functionality available in node:parse_args, this would allow us to get this PR to an MVP with this assumption -- and if we then decide to also expose the feature in process or util, it's a non breaking addition.

mcollina · 2022-04-10T14:34:16Z

I'm totally ok for it to stay inside util, I'm just not ok with using process.

bcoe · 2022-04-10T14:38:49Z

@cjihrig @mcollina @Trott how would folks feel about this feature experimental in docs only? with strong warnings in the documentation that this is a work in progress?

On one hand, a runtime experimental warning makes it difficult to create real-world command line applications, as they'll have noisy output.

On the other hand, users might not realize it's experimental and get frustrated if the API breaks.

mcollina · 2022-04-10T14:49:43Z

I'm ok in being doc-only experimental.

Trott · 2022-04-10T16:03:32Z

@cjihrig @mcollina @Trott how would folks feel about this feature experimental in docs only? which strong warnings in the documentation that this is a work in progress?

I'd punt that to @nodejs/tsc and @nodejs/releasers. I'm personally fine with it, but I also wouldn't want that to sneak by anyone.

I'm not sure if this is actually feasible, but maybe we can split the difference and have a warning be emitted (so if anything is listening for warnings, it picks it up) but ignored by the default "print the warning to the console" listener.

lib/internal/parse_args/utils.js

cjihrig · 2022-04-10T19:29:05Z

would folks feel about this feature experimental in docs only?

I don't mind due to the nature of this API.

bcoe · 2022-04-11T13:07:36Z

@nodejs/tsc two questions I would love feedback on from the TSC:

would it be okay to expose this feature as util.parseArgs, as well as in the module node:parse_args?
would it be okay to indicate that this feature is experimental in docs only (which would make it easier for people to test the API for real world applications), or should it have a runtime experimental warning.

RaisinTen · 2022-04-11T14:52:30Z

would it be okay to expose this feature as util.parseArgs, as well as in the module node:parse_args?

I think it's okay to expose this as a part of the util module. It probably doesn't require a completely new module of its own because it's just a single function.

would it be okay to indicate that this feature is experimental in docs only (which would make it easier for people to test the API for real world applications), or should it have a runtime experimental warning.

I'm okay with it.

Notable changes: * deps: update undici to 5.3.0 (Node.js GitHub Bot) #43197 * (SEMVER-MINOR) util: add parseArgs module (Benjamin Coe) #42675 * (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) #41397 * deps: upgrade npm to 8.11.0 (npm team) #43210 * deps: patch V8 to 10.2.154.4 (Michaël Zasso) #43067 * (SEMVER-MINOR) deps: update V8 to 10.2.154.2 (Michaël Zasso) #42740 * (SEMVER-MINOR) fs: make params in writing methods optional (LiviaMedeiros) #42601 * (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) #41397 * (SEMVER-MINOR) net: add ability to reset a tcp socket (pupilTong) #43112 PR-URL: #43266

Notable changes: * deps: update undici to 5.3.0 (Node.js GitHub Bot) #43197 * (SEMVER-MINOR) util: add parseArgs module (Benjamin Coe) #42675 * (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) #41397 * deps: upgrade npm to 8.11.0 (npm team) #43210 * deps: patch V8 to 10.2.154.4 (Michaël Zasso) #43067 * (SEMVER-MINOR) deps: update V8 to 10.2.154.2 (Michaël Zasso) #42740 * (SEMVER-MINOR) fs: make params in writing methods optional (LiviaMedeiros) #42601 * (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) #41397 * (SEMVER-MINOR) net: add ability to reset a tcp socket (pupilTong) #43112 * (SEMVER-MINOR) Revert "build: make x86 Windows support temporarily experimental" (Michaël Zasso) [#42740](#42740) * This means 32-bit Windows binaries are back with this release. PR-URL: #43266

Notable changes: * deps: update undici to 5.4.0 (Node.js GitHub Bot) #43262 * (SEMVER-MINOR) util: add parseArgs module (Benjamin Coe) #42675 * (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) #41397 * deps: upgrade npm to 8.11.0 (npm team) #43210 * deps: patch V8 to 10.2.154.4 (Michaël Zasso) #43067 * (SEMVER-MINOR) deps: update V8 to 10.2.154.2 (Michaël Zasso) #42740 * (SEMVER-MINOR) fs: make params in writing methods optional (LiviaMedeiros) #42601 * (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) #41397 * (SEMVER-MINOR) net: add ability to reset a tcp socket (pupilTong) #43112 * (SEMVER-MINOR) Revert "build: make x86 Windows support temporarily experimental" (Michaël Zasso) [#42740](#42740) * This means 32-bit Windows binaries are back with this release. PR-URL: #43266

Notable changes: * deps: update undici to 5.4.0 (Node.js GitHub Bot) nodejs#43262 * (SEMVER-MINOR) util: add parseArgs module (Benjamin Coe) nodejs#42675 * (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) nodejs#41397 * deps: upgrade npm to 8.11.0 (npm team) nodejs#43210 * deps: patch V8 to 10.2.154.4 (Michaël Zasso) nodejs#43067 * (SEMVER-MINOR) deps: update V8 to 10.2.154.2 (Michaël Zasso) nodejs#42740 * (SEMVER-MINOR) fs: make params in writing methods optional (LiviaMedeiros) nodejs#42601 * (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) nodejs#41397 * (SEMVER-MINOR) net: add ability to reset a tcp socket (pupilTong) nodejs#43112 * (SEMVER-MINOR) Revert "build: make x86 Windows support temporarily experimental" (Michaël Zasso) [nodejs#42740](nodejs#42740) * This means 32-bit Windows binaries are back with this release. PR-URL: nodejs#43266

targos · 2022-07-12T12:33:46Z

@nodejs/tooling would you like this to be pulled into the next v16.x release?

bcoe · 2022-07-13T14:09:35Z

@targos seems like it would be great to have in v16.

targos · 2022-07-18T10:00:55Z

Well I tried, but the tests rely on node:test, which unfortunately wasn't backported (I don't know why).

bcoe · 2022-07-18T15:12:00Z

Well I tried, but the tests rely on #42658, which unfortunately wasn't backported (I don't know why).

@targos thanks for the effort, not the end of the world.

Adds util.parseArgs helper for higher level command-line argument parsing. PR-URL: #42675 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Joe Sepi <sepi@joesepi.com> Reviewed-By: Ian Sutherland <ian@iansutherland.ca>

@kuriyosh

Notable changes: crypto: * (SEMVER-MINOR) remove Node.js-specific webcrypto extensions (Filip Skokan) #43310 * (SEMVER-MINOR) add CFRG curves to Web Crypto API (Filip Skokan) #42507 * (SEMVER-MINOR) make authTagLength optional for CC20P1305 (Tobias Nießen) #42427 * (SEMVER-MINOR) align webcrypto RSA key import/export with other implementations (Filip Skokan) #42816 deps: * update undici to 5.4.0 (Node.js GitHub Bot) #43262 * update undici to 5.3.0 (Node.js GitHub Bot) #43197 dns: * (SEMVER-MINOR) export error code constants from `dns/promises` (Feng Yu) #43176 doc: * add F3n67u to collaborators (Feng Yu) #43953 * deprecate coercion to integer in process.exit (Daeyeon Jeong) #43738 * (SEMVER-MINOR) deprecate diagnostics_channel object subscribe method (Stephen Belanger) #42714 * add LiviaMedeiros to collaborators (LiviaMedeiros) #43039 * add @kuriyosh to collaborators (Yoshiki Kurihara) #42824 * add RafaelGSS to collaborators (RafaelGSS) #42718 * add @meixg to collaborators (Xuguang Mei) #42576 errors: * (SEMVER-MINOR) add support for cause in aborterror (James M Snell) #41008 esm: * (SEMVER-MINOR) add chaining to loaders (Jacob Smith) #42623 events: * (SEMVER-MINOR) expose CustomEvent on global with CLI flag (Daeyeon Jeong) #43885 * (SEMVER-MINOR) add `CustomEvent` (Daeyeon Jeong) #43514 * (SEMVER-MINOR) propagate abortsignal reason in new AbortError ctor in events (James M Snell) #41008 fs: * (SEMVER-MINOR) propagate abortsignal reason in new AbortSignal constructors (James M Snell) #41008 * (SEMVER-MINOR) make params in writing methods optional (LiviaMedeiros) #42601 * (SEMVER-MINOR) add `read(buffer[, options])` versions (LiviaMedeiros) #42768 http: * (SEMVER-MINOR) add drop request event for http server (theanarkh) #43806 * (SEMVER-MINOR) add diagnostics channel for http client (theanarkh) #43580 * (SEMVER-MINOR) add perf_hooks detail for http request and client (theanarkh) #43361 * (SEMVER-MINOR) add uniqueHeaders option to request and createServer (Paolo Insogna) #41397 http2: * (SEMVER-MINOR) propagate abortsignal reason in new AbortError constructor (James M Snell) #41008 * (SEMVER-MINOR) compat support for array headers (OneNail) #42901 lib: * (SEMVER-MINOR) propagate abortsignal reason in new AbortError constructor in blob (James M Snell) #41008 * (SEMVER-MINOR) add abortSignal.throwIfAborted() (James M Snell) #40951 * (SEMVER-MINOR) improved diagnostics_channel subscribe/unsubscribe (Stephen Belanger) #42714 module: * (SEMVER-MINOR) add isBuiltIn method (hemanth.hm) #43396 module,repl: * (SEMVER-MINOR) support 'node:'-only core modules (Colin Ihrig) #42325 net: * (SEMVER-MINOR) add drop event for net server (theanarkh) #43582 * (SEMVER-MINOR) add ability to reset a tcp socket (pupilTong) #43112 node-api: * (SEMVER-MINOR) emit uncaught-exception on unhandled tsfn callbacks (Chengzhong Wu) #36510 perf_hooks: * (SEMVER-MINOR) add PerformanceResourceTiming (RafaelGSS) #42725 report: * (SEMVER-MINOR) add more heap infos in process report (theanarkh) #43116 src: * (SEMVER-MINOR) add --openssl-legacy-provider option (Daniel Bevenius) #40478 * (SEMVER-MINOR) define fs.constants.S_IWUSR & S_IRUSR for Win (Liviu Ionescu) #42757 src,doc,test: * (SEMVER-MAJOR) add --openssl-shared-config option (Daniel Bevenius) #43124 stream: * (SEMVER-MINOR) use cause options in AbortError constructors (James M Snell) #41008 * (SEMVER-MINOR) add iterator helper find (Nitzan Uziely) #41849 * (SEMVER-MINOR) add writableAborted (Robert Nagy) #40802 test: * (SEMVER-MINOR) add initial test module (Colin Ihrig) #42325 test_runner: * (SEMVER-MINOR) expose `describe` and `it` (Moshe Atlow) #43420 * (SEMVER-MINOR) add initial CLI runner (Colin Ihrig) #42658 * (SEMVER-MINOR) support 'only' tests (Colin Ihrig) #42514 timers: * (SEMVER-MINOR) propagate signal.reason in awaitable timers (James M Snell) #41008 util: * (SEMVER-MINOR) add tokens to parseArgs (John Gee) #43459 * (SEMVER-MINOR) add parseArgs module (Benjamin Coe) #42675 v8: * (SEMVER-MINOR) add v8.startupSnapshot utils (Joyee Cheung) #43329 * (SEMVER-MINOR) export more fields in getHeapStatistics (theanarkh) #42784 worker: * (SEMVER-MINOR) add hasRef() to MessagePort (Darshan Sen) #42849 PR-URL: TODO

Notable changes: Adds `util.parseArgs` helper for higher level command-line argument parsing. Contributed by Benjamin Coe, John Gee, Darcy Clarke, Joe Sepi, Kevin Gibbons, Aaron Casanova, Jessica Nahulan, and Jordan Harband. #42675 Node.js ESM Loader hooks now support multiple custom loaders, and composition is achieved via "chaining": `foo-loader` calls `bar-loader` calls `qux-loader` (a custom loader _must_ now signal a short circuit when intentionally not calling the next). See the ESM docs (https://nodejs.org/dist/latest-v16.x/docs/api/esm.html) for details. Contributed by Jacob Smith, Geoffrey Booth, and Bradley Farias. #42623 The `node:test` module, which was initially introduced in Node.js v18.0.0, is now available with all the changes done to it up to Node.js v18.7.0. To better align Node.js' experimental implementation of the Web Crypto API with other runtimes, several changes were made: * Support for CFRG curves was added, with the `'Ed25519'`, `'Ed448'`, `'X25519'`, and `'X448'` algorithms. * The proprietary `'NODE-DSA'`, `'NODE-DH'`, `'NODE-SCRYPT'`, `'NODE-ED25519'`, `'NODE-ED448'`, `'NODE-X25519'`, and `'NODE-X448'` algorithms were removed. * The proprietary `'node.keyObject'` import/export format was removed. Contributed by Filip Skokan. #42507 #43310 Updated Corepack to 0.12.1 - #43965 Updated ICU to 71.1 - #42655 Updated npm to 8.15.0 - #43917 Updated Undici to 5.8.0 - #43886 (SEMVER-MINOR) crypto: make authTagLength optional for CC20P1305 (Tobias Nießen) [#42427](#42427) (SEMVER-MINOR) crypto: align webcrypto RSA key import/export with other implementations (Filip Skokan) [#42816](#42816) (SEMVER-MINOR) dns: export error code constants from `dns/promises` (Feng Yu) [#43176](#43176) doc: deprecate ercion to integer in process.exit (Daeyeon Jeong) [#43738](#43738) (SEMVER-MINOR) doc: deprecate diagnostics\_channel object subscribe method (Stephen Belanger) [#42714](#42714) (SEMVER-MINOR) errors: add support for cause in aborterror (James M Snell) [#41008](#41008) (SEMVER-MINOR) events: expose CustomEvent on global with CLI flag (Daeyeon Jeong) [#43885](#43885) (SEMVER-MINOR) events: add `CustomEvent` (Daeyeon Jeong) [#43514](#43514) (SEMVER-MINOR) events: propagate abortsignal reason in new AbortError ctor in events (James M Snell) [#41008](#41008) (SEMVER-MINOR) fs: propagate abortsignal reason in new AbortSignal constructors (James M Snell) [#41008](#41008) (SEMVER-MINOR) fs: make params in writing methods optional (LiviaMedeiros) [#42601](#42601) (SEMVER-MINOR) fs: add `read(buffer[, options])` versions (LiviaMedeiros) [#42768](#42768) (SEMVER-MINOR) http: add drop request event for http server (theanarkh) [#43806](#43806) (SEMVER-MINOR) http: add diagnostics channel for http client (theanarkh) [#43580](#43580) (SEMVER-MINOR) http: add perf\_hooks detail for http request and client (theanarkh) [#43361](#43361) (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) [#41397](#41397) (SEMVER-MINOR) http2: propagate abortsignal reason in new AbortError constructor (James M Snell) [#41008](#41008) (SEMVER-MINOR) http2: compat support for array headers (OneNail) [#42901](#42901) (SEMVER-MINOR) lib: propagate abortsignal reason in new AbortError constructor in blob (James M Snell) [#41008](#41008) (SEMVER-MINOR) lib: add abortSignal.throwIfAborted() (James M Snell) [#40951](#40951) (SEMVER-MINOR) lib: improved diagnostics\_channel subscribe/unsubscribe (Stephen Belanger) [#42714](#42714) (SEMVER-MINOR) module: add isBuiltIn method (hemanth.hm) [#43396](#43396) (SEMVER-MINOR) moduleepl**: support 'node:'-only core modules (Colin Ihrig) [#42325](#42325) (SEMVER-MINOR) net: add drop event for net server (theanarkh) [#43582](#43582) (SEMVER-MINOR) net: add ability to reset a tcp socket (pupilTong) [#43112](#43112) (SEMVER-MINOR) nodepi**: emit uncaught-exception on unhandled tsfn callbacks (Chengzhong Wu) [#36510](#36510) (SEMVER-MINOR) perfhooks**: add PerformanceResourceTiming (RafaelGSS) [#42725](#42725) (SEMVER-MINOR) report: add more heap infos in process report (theanarkh) [#43116](#43116) (SEMVER-MINOR) src: add --openssl-legacy-provider option (Daniel Bevenius) [#40478](#40478) (SEMVER-MINOR) src: define fs.constants.S\_IWUSR & S\_IRUSR for Win (Liviu Ionescu) [#42757](#42757) (SEMVER-MINOR) srcoc,test**: add --openssl-shared-config option (Daniel Bevenius) [#43124](#43124) (SEMVER-MINOR) stream: use cause options in AbortError constructors (James M Snell) [#41008](#41008) (SEMVER-MINOR) stream: add iterator helper find (Nitzan Uziely) [#41849](#41849) (SEMVER-MINOR) stream: add writableAborted (Robert Nagy) [#40802](#40802) (SEMVER-MINOR) timers: propagate signal.reason in awaitable timers (James M Snell) [#41008](#41008) (SEMVER-MINOR) v8: add v8.startupSnapshot utils (Joyee Cheung) [#43329](#43329) (SEMVER-MINOR) v8: export more fields in getHeapStatistics (theanarkh) [#42784](#42784) (SEMVER-MINOR) worker: add hasRef() to MessagePort (Darshan Sen) [#42849](#42849) PR-URL: #44098

Notable changes: Adds `util.parseArgs` helper for higher level command-line argument parsing. Contributed by Benjamin Coe, John Gee, Darcy Clarke, Joe Sepi, Kevin Gibbons, Aaron Casanova, Jessica Nahulan, and Jordan Harband. #42675 Node.js ESM Loader hooks now support multiple custom loaders, and composition is achieved via "chaining": `foo-loader` calls `bar-loader` calls `qux-loader` (a custom loader _must_ now signal a short circuit when intentionally not calling the next). See the ESM docs (https://nodejs.org/dist/latest-v16.x/docs/api/esm.html) for details. Contributed by Jacob Smith, Geoffrey Booth, and Bradley Farias. #42623 The `node:test` module, which was initially introduced in Node.js v18.0.0, is now available with all the changes done to it up to Node.js v18.7.0. To better align Node.js' experimental implementation of the Web Crypto API with other runtimes, several changes were made: * Support for CFRG curves was added, with the `'Ed25519'`, `'Ed448'`, `'X25519'`, and `'X448'` algorithms. * The proprietary `'NODE-DSA'`, `'NODE-DH'`, `'NODE-SCRYPT'`, `'NODE-ED25519'`, `'NODE-ED448'`, `'NODE-X25519'`, and `'NODE-X448'` algorithms were removed. * The proprietary `'node.keyObject'` import/export format was removed. Contributed by Filip Skokan. #42507 #43310 Updated Corepack to 0.12.1 - #43965 Updated ICU to 71.1 - #42655 Updated npm to 8.15.0 - #43917 Updated Undici to 5.8.0 - #43886 (SEMVER-MINOR) crypto: make authTagLength optional for CC20P1305 (Tobias Nießen) #42427 (SEMVER-MINOR) crypto: align webcrypto RSA key import/export with other implementations (Filip Skokan) #42816 (SEMVER-MINOR) dns: export error code constants from `dns/promises` (Feng Yu) #43176 doc: deprecate coercion to integer in process.exit (Daeyeon Jeong) #43738 (SEMVER-MINOR) doc: deprecate diagnostics_channel object subscribe method (Stephen Belanger) #42714 (SEMVER-MINOR) errors: add support for cause in aborterror (James M Snell) #41008 (SEMVER-MINOR) events: expose CustomEvent on global with CLI flag (Daeyeon Jeong) #43885 (SEMVER-MINOR) events: add `CustomEvent` (Daeyeon Jeong) #43514 (SEMVER-MINOR) events: propagate abortsignal reason in new AbortError ctor in events (James M Snell) #41008 (SEMVER-MINOR) fs: propagate abortsignal reason in new AbortSignal constructors (James M Snell) #41008 (SEMVER-MINOR) fs: make params in writing methods optional (LiviaMedeiros) #42601 (SEMVER-MINOR) fs: add `read(buffer[, options])` versions (LiviaMedeiros) #42768 (SEMVER-MINOR) http: add drop request event for http server (theanarkh) #43806 (SEMVER-MINOR) http: add diagnostics channel for http client (theanarkh) #43580 (SEMVER-MINOR) http: add perf_hooks detail for http request and client (theanarkh) #43361 (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) #41397 (SEMVER-MINOR) http2: propagate abortsignal reason in new AbortError constructor (James M Snell) #41008 (SEMVER-MINOR) http2: compat support for array headers (OneNail) #42901 (SEMVER-MINOR) lib: propagate abortsignal reason in new AbortError constructor in blob (James M Snell) #41008 (SEMVER-MINOR) lib: add abortSignal.throwIfAborted() (James M Snell) #40951 (SEMVER-MINOR) lib: improved diagnostics_channel subscribe/unsubscribe (Stephen Belanger) #42714 (SEMVER-MINOR) module: add isBuiltIn method (hemanth.hm) #43396 (SEMVER-MINOR) module,repl: support 'node:'-only core modules (Colin Ihrig) #42325 (SEMVER-MINOR) net: add drop event for net server (theanarkh) #43582 (SEMVER-MINOR) net: add ability to reset a tcp socket (pupilTong) #43112 (SEMVER-MINOR) node-api: emit uncaught-exception on unhandled tsfn callbacks (Chengzhong Wu) #36510 (SEMVER-MINOR) perf_hooks: add PerformanceResourceTiming (RafaelGSS) #42725 (SEMVER-MINOR) report: add more heap infos in process report (theanarkh) #43116 (SEMVER-MINOR) src: add --openssl-legacy-provider option (Daniel Bevenius) #40478 (SEMVER-MINOR) src: define fs.constants.S_IWUSR & S_IRUSR for Win (Liviu Ionescu) #42757 (SEMVER-MINOR) src,doc,test: add --openssl-shared-config option (Daniel Bevenius) #43124 (SEMVER-MINOR) stream: use cause options in AbortError constructors (James M Snell) #41008 (SEMVER-MINOR) stream: add iterator helper find (Nitzan Uziely) #41849 (SEMVER-MINOR) stream: add writableAborted (Robert Nagy) #40802 (SEMVER-MINOR) timers: propagate signal.reason in awaitable timers (James M Snell) #41008 (SEMVER-MINOR) v8: add v8.startupSnapshot utils (Joyee Cheung) #43329 (SEMVER-MINOR) v8: export more fields in getHeapStatistics (theanarkh) #42784 (SEMVER-MINOR) worker: add hasRef() to MessagePort (Darshan Sen) #42849 PR-URL: #44098

Notable changes: Adds `util.parseArgs` helper for higher level command-line argument parsing. Contributed by Benjamin Coe, John Gee, Darcy Clarke, Joe Sepi, Kevin Gibbons, Aaron Casanova, Jessica Nahulan, and Jordan Harband. nodejs#42675 Node.js ESM Loader hooks now support multiple custom loaders, and composition is achieved via "chaining": `foo-loader` calls `bar-loader` calls `qux-loader` (a custom loader _must_ now signal a short circuit when intentionally not calling the next). See the ESM docs (https://nodejs.org/dist/latest-v16.x/docs/api/esm.html) for details. Contributed by Jacob Smith, Geoffrey Booth, and Bradley Farias. nodejs#42623 The `node:test` module, which was initially introduced in Node.js v18.0.0, is now available with all the changes done to it up to Node.js v18.7.0. To better align Node.js' experimental implementation of the Web Crypto API with other runtimes, several changes were made: * Support for CFRG curves was added, with the `'Ed25519'`, `'Ed448'`, `'X25519'`, and `'X448'` algorithms. * The proprietary `'NODE-DSA'`, `'NODE-DH'`, `'NODE-SCRYPT'`, `'NODE-ED25519'`, `'NODE-ED448'`, `'NODE-X25519'`, and `'NODE-X448'` algorithms were removed. * The proprietary `'node.keyObject'` import/export format was removed. Contributed by Filip Skokan. nodejs#42507 nodejs#43310 Updated Corepack to 0.12.1 - nodejs#43965 Updated ICU to 71.1 - nodejs#42655 Updated npm to 8.15.0 - nodejs#43917 Updated Undici to 5.8.0 - nodejs#43886 (SEMVER-MINOR) crypto: make authTagLength optional for CC20P1305 (Tobias Nießen) nodejs#42427 (SEMVER-MINOR) crypto: align webcrypto RSA key import/export with other implementations (Filip Skokan) nodejs#42816 (SEMVER-MINOR) dns: export error code constants from `dns/promises` (Feng Yu) nodejs#43176 doc: deprecate coercion to integer in process.exit (Daeyeon Jeong) nodejs#43738 (SEMVER-MINOR) doc: deprecate diagnostics_channel object subscribe method (Stephen Belanger) nodejs#42714 (SEMVER-MINOR) errors: add support for cause in aborterror (James M Snell) nodejs#41008 (SEMVER-MINOR) events: expose CustomEvent on global with CLI flag (Daeyeon Jeong) nodejs#43885 (SEMVER-MINOR) events: add `CustomEvent` (Daeyeon Jeong) nodejs#43514 (SEMVER-MINOR) events: propagate abortsignal reason in new AbortError ctor in events (James M Snell) nodejs#41008 (SEMVER-MINOR) fs: propagate abortsignal reason in new AbortSignal constructors (James M Snell) nodejs#41008 (SEMVER-MINOR) fs: make params in writing methods optional (LiviaMedeiros) nodejs#42601 (SEMVER-MINOR) fs: add `read(buffer[, options])` versions (LiviaMedeiros) nodejs#42768 (SEMVER-MINOR) http: add drop request event for http server (theanarkh) nodejs#43806 (SEMVER-MINOR) http: add diagnostics channel for http client (theanarkh) nodejs#43580 (SEMVER-MINOR) http: add perf_hooks detail for http request and client (theanarkh) nodejs#43361 (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) nodejs#41397 (SEMVER-MINOR) http2: propagate abortsignal reason in new AbortError constructor (James M Snell) nodejs#41008 (SEMVER-MINOR) http2: compat support for array headers (OneNail) nodejs#42901 (SEMVER-MINOR) lib: propagate abortsignal reason in new AbortError constructor in blob (James M Snell) nodejs#41008 (SEMVER-MINOR) lib: add abortSignal.throwIfAborted() (James M Snell) nodejs#40951 (SEMVER-MINOR) lib: improved diagnostics_channel subscribe/unsubscribe (Stephen Belanger) nodejs#42714 (SEMVER-MINOR) module: add isBuiltIn method (hemanth.hm) nodejs#43396 (SEMVER-MINOR) module,repl: support 'node:'-only core modules (Colin Ihrig) nodejs#42325 (SEMVER-MINOR) net: add drop event for net server (theanarkh) nodejs#43582 (SEMVER-MINOR) net: add ability to reset a tcp socket (pupilTong) nodejs#43112 (SEMVER-MINOR) node-api: emit uncaught-exception on unhandled tsfn callbacks (Chengzhong Wu) nodejs#36510 (SEMVER-MINOR) perf_hooks: add PerformanceResourceTiming (RafaelGSS) nodejs#42725 (SEMVER-MINOR) report: add more heap infos in process report (theanarkh) nodejs#43116 (SEMVER-MINOR) src: add --openssl-legacy-provider option (Daniel Bevenius) nodejs#40478 (SEMVER-MINOR) src: define fs.constants.S_IWUSR & S_IRUSR for Win (Liviu Ionescu) nodejs#42757 (SEMVER-MINOR) src,doc,test: add --openssl-shared-config option (Daniel Bevenius) nodejs#43124 (SEMVER-MINOR) stream: use cause options in AbortError constructors (James M Snell) nodejs#41008 (SEMVER-MINOR) stream: add iterator helper find (Nitzan Uziely) nodejs#41849 (SEMVER-MINOR) stream: add writableAborted (Robert Nagy) nodejs#40802 (SEMVER-MINOR) timers: propagate signal.reason in awaitable timers (James M Snell) nodejs#41008 (SEMVER-MINOR) v8: add v8.startupSnapshot utils (Joyee Cheung) nodejs#43329 (SEMVER-MINOR) v8: export more fields in getHeapStatistics (theanarkh) nodejs#42784 (SEMVER-MINOR) worker: add hasRef() to MessagePort (Darshan Sen) nodejs#42849 PR-URL: nodejs#44098

Adds util.parseArgs helper for higher level command-line argument parsing. PR-URL: nodejs/node#42675 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Ruy Adorno <ruyadorno@github.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Joe Sepi <sepi@joesepi.com> Reviewed-By: Ian Sutherland <ian@iansutherland.ca>

Notable changes: Adds `util.parseArgs` helper for higher level command-line argument parsing. Contributed by Benjamin Coe, John Gee, Darcy Clarke, Joe Sepi, Kevin Gibbons, Aaron Casanova, Jessica Nahulan, and Jordan Harband. nodejs/node#42675 Node.js ESM Loader hooks now support multiple custom loaders, and composition is achieved via "chaining": `foo-loader` calls `bar-loader` calls `qux-loader` (a custom loader _must_ now signal a short circuit when intentionally not calling the next). See the ESM docs (https://nodejs.org/dist/latest-v16.x/docs/api/esm.html) for details. Contributed by Jacob Smith, Geoffrey Booth, and Bradley Farias. nodejs/node#42623 The `node:test` module, which was initially introduced in Node.js v18.0.0, is now available with all the changes done to it up to Node.js v18.7.0. To better align Node.js' experimental implementation of the Web Crypto API with other runtimes, several changes were made: * Support for CFRG curves was added, with the `'Ed25519'`, `'Ed448'`, `'X25519'`, and `'X448'` algorithms. * The proprietary `'NODE-DSA'`, `'NODE-DH'`, `'NODE-SCRYPT'`, `'NODE-ED25519'`, `'NODE-ED448'`, `'NODE-X25519'`, and `'NODE-X448'` algorithms were removed. * The proprietary `'node.keyObject'` import/export format was removed. Contributed by Filip Skokan. nodejs/node#42507 nodejs/node#43310 Updated Corepack to 0.12.1 - nodejs/node#43965 Updated ICU to 71.1 - nodejs/node#42655 Updated npm to 8.15.0 - nodejs/node#43917 Updated Undici to 5.8.0 - nodejs/node#43886 (SEMVER-MINOR) crypto: make authTagLength optional for CC20P1305 (Tobias Nießen) nodejs/node#42427 (SEMVER-MINOR) crypto: align webcrypto RSA key import/export with other implementations (Filip Skokan) nodejs/node#42816 (SEMVER-MINOR) dns: export error code constants from `dns/promises` (Feng Yu) nodejs/node#43176 doc: deprecate coercion to integer in process.exit (Daeyeon Jeong) nodejs/node#43738 (SEMVER-MINOR) doc: deprecate diagnostics_channel object subscribe method (Stephen Belanger) nodejs/node#42714 (SEMVER-MINOR) errors: add support for cause in aborterror (James M Snell) nodejs/node#41008 (SEMVER-MINOR) events: expose CustomEvent on global with CLI flag (Daeyeon Jeong) nodejs/node#43885 (SEMVER-MINOR) events: add `CustomEvent` (Daeyeon Jeong) nodejs/node#43514 (SEMVER-MINOR) events: propagate abortsignal reason in new AbortError ctor in events (James M Snell) nodejs/node#41008 (SEMVER-MINOR) fs: propagate abortsignal reason in new AbortSignal constructors (James M Snell) nodejs/node#41008 (SEMVER-MINOR) fs: make params in writing methods optional (LiviaMedeiros) nodejs/node#42601 (SEMVER-MINOR) fs: add `read(buffer[, options])` versions (LiviaMedeiros) nodejs/node#42768 (SEMVER-MINOR) http: add drop request event for http server (theanarkh) nodejs/node#43806 (SEMVER-MINOR) http: add diagnostics channel for http client (theanarkh) nodejs/node#43580 (SEMVER-MINOR) http: add perf_hooks detail for http request and client (theanarkh) nodejs/node#43361 (SEMVER-MINOR) http: add uniqueHeaders option to request and createServer (Paolo Insogna) nodejs/node#41397 (SEMVER-MINOR) http2: propagate abortsignal reason in new AbortError constructor (James M Snell) nodejs/node#41008 (SEMVER-MINOR) http2: compat support for array headers (OneNail) nodejs/node#42901 (SEMVER-MINOR) lib: propagate abortsignal reason in new AbortError constructor in blob (James M Snell) nodejs/node#41008 (SEMVER-MINOR) lib: add abortSignal.throwIfAborted() (James M Snell) nodejs/node#40951 (SEMVER-MINOR) lib: improved diagnostics_channel subscribe/unsubscribe (Stephen Belanger) nodejs/node#42714 (SEMVER-MINOR) module: add isBuiltIn method (hemanth.hm) nodejs/node#43396 (SEMVER-MINOR) module,repl: support 'node:'-only core modules (Colin Ihrig) nodejs/node#42325 (SEMVER-MINOR) net: add drop event for net server (theanarkh) nodejs/node#43582 (SEMVER-MINOR) net: add ability to reset a tcp socket (pupilTong) nodejs/node#43112 (SEMVER-MINOR) node-api: emit uncaught-exception on unhandled tsfn callbacks (Chengzhong Wu) nodejs/node#36510 (SEMVER-MINOR) perf_hooks: add PerformanceResourceTiming (RafaelGSS) nodejs/node#42725 (SEMVER-MINOR) report: add more heap infos in process report (theanarkh) nodejs/node#43116 (SEMVER-MINOR) src: add --openssl-legacy-provider option (Daniel Bevenius) nodejs/node#40478 (SEMVER-MINOR) src: define fs.constants.S_IWUSR & S_IRUSR for Win (Liviu Ionescu) nodejs/node#42757 (SEMVER-MINOR) src,doc,test: add --openssl-shared-config option (Daniel Bevenius) nodejs/node#43124 (SEMVER-MINOR) stream: use cause options in AbortError constructors (James M Snell) nodejs/node#41008 (SEMVER-MINOR) stream: add iterator helper find (Nitzan Uziely) nodejs/node#41849 (SEMVER-MINOR) stream: add writableAborted (Robert Nagy) nodejs/node#40802 (SEMVER-MINOR) timers: propagate signal.reason in awaitable timers (James M Snell) nodejs/node#41008 (SEMVER-MINOR) v8: add v8.startupSnapshot utils (Joyee Cheung) nodejs/node#43329 (SEMVER-MINOR) v8: export more fields in getHeapStatistics (theanarkh) nodejs/node#42784 (SEMVER-MINOR) worker: add hasRef() to MessagePort (Darshan Sen) nodejs/node#42849 PR-URL: nodejs/node#44098

nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Apr 9, 2022

bcoe mentioned this pull request Apr 9, 2022

refactor: tweaks for landing in Node.js pkgjs/parseargs#89

Merged

shadowspawn reviewed Apr 9, 2022

View reviewed changes

doc/api/process.md Outdated Show resolved Hide resolved

bakkot reviewed Apr 9, 2022

View reviewed changes

doc/api/errors.md Outdated Show resolved Hide resolved

doc/api/process.md Outdated Show resolved Hide resolved

doc/api/process.md Outdated Show resolved Hide resolved

VoltrexKeyva reviewed Apr 9, 2022

View reviewed changes

bcoe mentioned this pull request Apr 10, 2022

docs: fix formatting nits in comments pkgjs/parseargs#91

Merged

cjihrig reviewed Apr 10, 2022

View reviewed changes

bakkot reviewed Apr 10, 2022

View reviewed changes

doc/api/parse_args.md Outdated Show resolved Hide resolved

shadowspawn mentioned this pull request Apr 10, 2022

refactor: use arrow functions for tests pkgjs/parseargs#96

Merged

vladfrangu reviewed Apr 10, 2022

View reviewed changes

lib/internal/parse_args/utils.js Outdated Show resolved Hide resolved

shadowspawn mentioned this pull request Apr 11, 2022

refactor: updates to comments and code per feedback pkgjs/parseargs#101

Merged

bcoe changed the title ~~process: add parseArgs method~~ lib: add parseArgs module Apr 11, 2022

bcoe added notable-change PRs with changes that should be highlighted in changelogs. tsc-agenda Issues and PRs to discuss during the meetings of the TSC. labels Apr 11, 2022

targos added the semver-minor PRs that contain new features and should be released in the next minor version. label Apr 11, 2022

shadowspawn mentioned this pull request Jun 15, 2022

feat: add parsed meta-data to returned properties pkgjs/parseargs#129

Merged

targos added backport-requested-v16.x and removed backport-requested-v16.x labels Jul 18, 2022

This was referenced Jul 18, 2022

test: improve code coverage of util.parseArgs #43358

Merged

doc: fix typo in util.parseArgs usage example #43332

Closed

lib: add internalUtil.kEmptyObject #43159

Merged

bakkot mentioned this pull request Jul 30, 2022

feat(node): types for util.parseArgs DefinitelyTyped/DefinitelyTyped#61512

Merged

8 tasks

targos removed the backport-blocked-v16.x label Jul 31, 2022

targos mentioned this pull request Aug 2, 2022

v16.17.0 release proposal #44098

Merged

ruyadorno mentioned this pull request Aug 17, 2022

argument parsing nodejs/tooling#19

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: add parseArgs module #42675

util: add parseArgs module #42675

bcoe commented Apr 9, 2022 •

edited

Loading

nodejs-github-bot commented Apr 9, 2022

mcollina commented Apr 9, 2022

ljharb commented Apr 9, 2022

bcoe commented Apr 10, 2022

bnb commented Apr 10, 2022 •

edited

Loading

aaronccasanova commented Apr 10, 2022 •

edited

Loading

cjihrig left a comment

bcoe commented Apr 10, 2022

mcollina commented Apr 10, 2022

bcoe commented Apr 10, 2022 •

edited

Loading

mcollina commented Apr 10, 2022

Trott commented Apr 10, 2022

cjihrig commented Apr 10, 2022

bcoe commented Apr 11, 2022

RaisinTen commented Apr 11, 2022

targos commented Jul 12, 2022

bcoe commented Jul 13, 2022

targos commented Jul 18, 2022

bcoe commented Jul 18, 2022

util: add parseArgs module #42675

util: add parseArgs module #42675

Conversation

bcoe commented Apr 9, 2022 • edited Loading

Background

Where parseArgs is at

This is a controversial topic, be kind

ToDo

nodejs-github-bot commented Apr 9, 2022

mcollina commented Apr 9, 2022

ljharb commented Apr 9, 2022

bcoe commented Apr 10, 2022

bnb commented Apr 10, 2022 • edited Loading

aaronccasanova commented Apr 10, 2022 • edited Loading

cjihrig left a comment

Choose a reason for hiding this comment

bcoe commented Apr 10, 2022

mcollina commented Apr 10, 2022

bcoe commented Apr 10, 2022 • edited Loading

mcollina commented Apr 10, 2022

Trott commented Apr 10, 2022

cjihrig commented Apr 10, 2022

bcoe commented Apr 11, 2022

RaisinTen commented Apr 11, 2022

targos commented Jul 12, 2022

bcoe commented Jul 13, 2022

targos commented Jul 18, 2022

bcoe commented Jul 18, 2022

bcoe commented Apr 9, 2022 •

edited

Loading

bnb commented Apr 10, 2022 •

edited

Loading

aaronccasanova commented Apr 10, 2022 •

edited

Loading

bcoe commented Apr 10, 2022 •

edited

Loading