CLI: support --flag=value syntax in parseFlags#28
Merged
Conversation
parseFlags only understood the spaced --flag value form. The
--flag=value form failed with a misleading error, since the whole
"flag=value" fragment was treated as the flag name and the next argv
entry (or its absence) was blamed for a missing value.
Split each token on its first "=" before falling back to the spaced
form. This also gives an escape hatch for values that legitimately
start with --, which the spaced form's startsWith('--') guard would
otherwise reject.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthrough
ChangesCLI flag parsing
Estimated code review effort: 2 (Simple) | ~10 minutes ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #25.
What
parseFlagsinsrc/cli/index.tsonly understood the spaced--flag valueform.--flag=valuefailed with a misleading error (Missing value for --url=postgres://...), since the wholeflag=valuefragment was read as the flag name.Fix
Split each token on its first
=before falling back to the spaced-form handling. As a side effect this also lets a value legitimately start with--when passed via the equals form (--url=--weird-value), since it bypasses the spaced form'sstartsWith('--')guard entirely.Test plan
npm test(types + runtime) green, 53/53tests/cli-flags.test.ts: spaced form, equals form, mixed in one call,---prefixed value via equals, missing-value error still thrown for the spaced formSummary by CodeRabbit
New Features
--key valueand--key=valueformats.Tests
--, and missing-value errors.