Grouped flags #2766
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| // Copyright (C) 2022, Ava Labs, Inc. All rights reserved. | ||
| // See the file LICENSE for licensing terms. | ||
| package flags | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/pflag" | ||
| ) | ||
|
|
||
| type GroupedFlags struct { | ||
| Name string | ||
| ShowFlag string | ||
| FlagSet *pflag.FlagSet | ||
| IsAlwaysVisible bool | ||
| } | ||
|
|
||
| // WithGroupedHelp returns a cobra Run function that shows help organized by groups. | ||
| // It first shows normal command usage, then prints grouped flags, hiding some unless explicitly requested. | ||
| func WithGroupedHelp(groups []GroupedFlags) func(cmd *cobra.Command, args []string) { | ||
| return func(cmd *cobra.Command, _ []string) { | ||
| shownGroups := determineShownGroups(groups) | ||
|
|
||
| printUsage(cmd) | ||
|
|
||
| for _, group := range groups { | ||
| printGroup(cmd, group, shownGroups[group.Name]) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // determineShownGroups decides which flag groups should be visible based on user input and group settings. | ||
| func determineShownGroups(groups []GroupedFlags) map[string]bool { | ||
| shown := make(map[string]bool) | ||
| for _, group := range groups { | ||
| if group.IsAlwaysVisible || flagExists(group.ShowFlag, os.Args) { | ||
| shown[group.Name] = true | ||
| } | ||
| } | ||
| return shown | ||
| } | ||
|
|
||
| // printUsage prints the general command usage/help text. | ||
| func printUsage(cmd *cobra.Command) { | ||
| if err := cmd.Root().UsageFunc()(cmd); err != nil { | ||
| fmt.Fprintf(cmd.ErrOrStderr(), "error showing command usage: %v\n", err) | ||
| } | ||
| } | ||
|
|
||
| // printGroup prints a specific group of flags, properly formatted and optionally hidden if not shown. | ||
| func printGroup(cmd *cobra.Command, group GroupedFlags, isShown bool) { | ||
| fmt.Fprintf(cmd.OutOrStdout(), "\n%s:\n", group.Name) | ||
|
|
||
| if !isShown { | ||
| fmt.Fprintf(cmd.OutOrStdout(), " (hidden) Use %s to show these options\n", group.ShowFlag) | ||
| return | ||
| } | ||
|
|
||
| flags, maxLen := collectFlags(group.FlagSet) | ||
|
|
||
| for _, flag := range flags { | ||
| padding := strings.Repeat(" ", maxLen-len(flag.nameAndType)+2) | ||
| fmt.Fprintf(cmd.OutOrStdout(), " %s%s%s\n", flag.nameAndType, padding, flag.usage) | ||
| } | ||
| } | ||
|
|
||
| // flagInfo holds the formatted flag name/type and its usage string. | ||
| type flagInfo struct { | ||
| nameAndType string | ||
| usage string | ||
| } | ||
|
|
||
| // collectFlags gathers all flags in a flag set, calculating the maximum width needed for alignment. | ||
| func collectFlags(flagSet *pflag.FlagSet) ([]flagInfo, int) { | ||
| var flags []flagInfo | ||
| maxLen := 0 | ||
|
|
||
| flagSet.VisitAll(func(flag *pflag.Flag) { | ||
| nameAndType := "--" + flag.Name | ||
| if flag.Value.Type() != "bool" { | ||
| nameAndType += " " + flag.Value.Type() | ||
| } | ||
| if len(nameAndType) > maxLen { | ||
| maxLen = len(nameAndType) | ||
| } | ||
| flags = append(flags, flagInfo{nameAndType, flag.Usage}) | ||
| }) | ||
|
|
||
| return flags, maxLen | ||
| } | ||
|
|
||
| func flagExists(target string, args []string) bool { | ||
| for _, arg := range args { | ||
| if arg == target { | ||
|
There was a problem hiding this comment. how do we handle option casing (upper case\lower case) in CLI in general?
Contributor
Author
There was a problem hiding this comment. good question, we always put lowercase for flags in CLI. Not sure if cobra (the CLI SDK that we use) automatically does this for us. There was a problem hiding this comment. found this https://github.com/spf13/pflag/blob/master/flag.go#L224 so i assume if we don't do anything special, the |
||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| func RegisterFlagGroup(cmd *cobra.Command, groupName string, showFlag string, isAlwaysVisible bool, defineFlags func(set *pflag.FlagSet)) GroupedFlags { | ||
| // Define the showFlag for controlling visibility | ||
| show := false | ||
| cmd.Flags().BoolVar(&show, showFlag, false, fmt.Sprintf("Show %s", groupName)) | ||
|
|
||
| // Always hide the showFlag itself | ||
| cmd.Flags().Lookup(showFlag).Hidden = true | ||
|
|
||
| // Create a new FlagSet for this group | ||
| flagSet := pflag.NewFlagSet(groupName, pflag.ContinueOnError) | ||
|
|
||
| // Caller defines the flags | ||
| defineFlags(flagSet) | ||
|
|
||
| // Add the flagSet to the cmd's global flag list | ||
| cmd.Flags().AddFlagSet(flagSet) | ||
|
|
||
| // Always hide the grouped flags globally | ||
| flagSet.VisitAll(func(f *pflag.Flag) { | ||
| cmd.Flags().Lookup(f.Name).Hidden = true | ||
| }) | ||
|
|
||
| // Return GroupedFlags | ||
| return GroupedFlags{ | ||
| Name: groupName, | ||
| ShowFlag: "--" + showFlag, | ||
| FlagSet: flagSet, | ||
| IsAlwaysVisible: isAlwaysVisible, | ||
| } | ||
| } | ||
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.