docs: add util.parseArgs replacements for CLI argument parsers #274
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds migration documentation for replacing minimist, mri, arg, meow, yargs-parser, yargs, commander, and sade with Node.js built-in util.parseArgs (available in Node 18.3+/16.17+).
|
Also worth suggesting as an alternative is https://npmgraph.js.org/?q=pargs, which is built on top of util.parseArgs, has no deps, is written in ESM, and adds a number of helpful features when migrating from the listed packages. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds migration documentation for replacing CLI argument parsing packages with Node.js built-in
util.parseArgs(available in Node 18.3+/16.17+).Packages covered
minimistmriargmeowyargs-parseryargscommandersadeChanges
docs/modules/parseargs.mdwith migration examples for each packagemanifests/preferred.jsonNotes
??) for defaults instead ofparseArgs'sdefaultoption to ensure compatibility with all Node 18.3+ versions