Prevent multiple occurrences of --path from eating up the subcommand #224
Conversation
This file contains 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
In case the '--path' option was specified multiple times, it'd
consider the subcommand as yet another path value, thereby causing the
subcommand to default to 'Check'.
Steps to reproduce:
$ mkdir /tmp/{foo,bar}
$ echo "[tag: hello]" > /tmp/foo/file.txt
$ echo "[ref: hello]" > /tmp/bar/file.txt
$ tagref -p /tmp/foo -p /tmp/bar list-tags
1 tag, 1 tag reference, 0 file references, and 0 directory references validated in 2 files.
Notice that it prints the output of check subcommand instead of
list-tags. This happens because the default behavior
'Args::multiple(true)' in clap (version 2.x) is to allow multiple
values per occurrence of the option.
Setting 'Args::number_of_values(1)' in coordination with
'Args::multiple(true)' fixes it. It allows multiple occurrences of the
option but only one value per occurrence[1].
[1]: https://docs.rs/clap/2.34.0/clap/struct.Arg.html#method.multiple
|
Thank you @naiquevin for fixing this issue! I will take a closer look later, but right now it looks good to me. |
stepchowfun
approved these changes
Apr 4, 2024
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.
In case the
--pathoption was specified multiple times, it'd consider the subcommand as yet another path value, thereby causing the subcommand to default toCheck.Steps to reproduce:
$ mkdir /tmp/{foo,bar} $ echo "[tag: hello]" > /tmp/foo/file.txt $ echo "[ref: hello]" > /tmp/bar/file.txt $ tagref -p /tmp/foo -p /tmp/bar list-tags 1 tag, 1 tag reference, 0 file references, and 0 directory references validated in 2 files.Notice that it prints the output of check subcommand instead of list-tags. This happens because the default behavior
Args::multiple(true)in clap (version 2.x) is to allow multiple values per occurrence of the option.Setting
Args::number_of_values(1)in coordination withArgs::multiple(true)fixes it. It allows multiple occurrences of the option but only one value per occurrence1.