Hide help flag from help output #645
Merged
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
Signed-off-by: Daniel Nephin <dnephin@docker.com>
Codecov Report
@@ Coverage Diff @@
## master #645 +/- ##
==========================================
- Coverage 49.4% 49.39% -0.01%
==========================================
Files 208 208
Lines 17194 17195 +1
==========================================
Hits 8494 8494
- Misses 8267 8268 +1
Partials 433 433 |
thaJeztah
reviewed
Oct 26, 2017
| @@ -26,6 +26,7 @@ func SetupRootCommand(rootCmd *cobra.Command) { | |||
|
|
|||
| rootCmd.PersistentFlags().BoolP("help", "h", false, "Print usage") | |||
| rootCmd.PersistentFlags().MarkShorthandDeprecated("help", "please use --help") | |||
| rootCmd.PersistentFlags().Lookup("help").Hidden = true | |||
There was a problem hiding this comment.
hm, didn't the .golden file need to be updated? https://github.com/docker/cli/pull/642/files#r147009761
There was a problem hiding this comment.
I expected it would, but it doesn't because of how the flags are applied.
This help flag is applied as a persistent flag to the root command, so when commands are added to the root, they inherit this version of the flag, and don't add the default.
In the test we are testing directly against the swarm update command, so the root command is not there to provide this flag. Cobra adds its own default help flag that is not hidden, so the test output still contains the --help flag.
thaJeztah
approved these changes
Oct 27, 2017
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.
Follow up to #642