Remove parent command's flags from subcommand usage #44
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
|
Found this issue, too. Both on my personal programs and Jekyll. @parkr would you mind reviewing and merging this to fix the issue? |
Closed
Issue jekyll#42 introduced the ability for subcommands to print help output that includes its parent's flags. Unfortunately, this duplicated some flags, such as `-h`, `-v`, and `-t`, that are also considered to be a part of the subcommand. This makes the usage output look a bit odd, as these flags are printed twice. This commit removes that duplication; it does not print help output for flags that are also part of the parent command's flags.
mdippery
force-pushed
the
parent-flags
branch
from
44b6c7f
to
6e6f85a
Compare
ashmaroli
requested changes
Dec 7, 2018
spec/command_spec.rb
Outdated
| it "can tell whether it is a parent command or not" do | ||
| expect(command.root?).to be true | ||
| expect(command_with_parent.root?).to be false | ||
| end |
There was a problem hiding this comment.
You should ideally be testing the issue at hand (which is in Presenter)
There was a problem hiding this comment.
I removed this test for the time being and will write a better one.
There was a problem hiding this comment.
Take your time. Don't forget to remove Command#root? if it no longer has a role..
There was a problem hiding this comment.
Added tests and removed Command#root?.
It is more direct to just check the truthiness of Command#parent instead.
mdippery
force-pushed
the
parent-flags
branch
from
5aafdc1
to
3b4647b
Compare
mdippery
force-pushed
the
parent-flags
branch
from
7822632
to
e80351f
Compare
DirtyF
approved these changes
Dec 14, 2018
|
@jekyllbot: merge +minor
|
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.
A change related to #42 allowed subcommands to inherit flags from their parent. Unfortunately, this change has resulted in some duplication of flags. As shown in the example above, the flags
-h,-v, and-twere printed twice in the help output when help for subcommands are shown, which is unexpected and looks a bit odd. It's especially pronounced in subcommands in which the parent command does not have any flags; two blocks for-h,-v, and-tare printed consecutively now, like this:This change corrects that so that flags for subcommands are only printed once.