-
Notifications
You must be signed in to change notification settings - Fork 260
fix: CLI consistency - usage paths, trial --quiet, pr verbose, secrets examples #18380
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+76
−3
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
|---|---|---|
|
|
@@ -466,6 +466,77 @@ func init() { | |
| // Set version template to match the version subcommand format | ||
| rootCmd.SetVersionTemplate(string(constants.CLIExtensionPrefix) + " version {{.Version}}\n") | ||
|
|
||
| // Fix usage lines so subcommands show "gh aw <cmd>" instead of "gh <cmd>". | ||
| // Cobra derives the root name from the first word of Use ("gh" from "gh aw"), | ||
| // so CommandPath() for subcommands omits "aw". We use SetUsageFunc to | ||
| // post-process the default output, replacing "gh " with "gh aw " in the | ||
| // two lines that reference the command path. | ||
| rootCmd.SetUsageFunc(func(cmd *cobra.Command) error { | ||
| fixPath := func(s string) string { | ||
| if s == "gh" { | ||
| return "gh aw" | ||
| } | ||
| if strings.HasPrefix(s, "gh ") && !strings.HasPrefix(s, "gh aw") { | ||
| return "gh aw " + s[3:] | ||
| } | ||
| return s | ||
| } | ||
| out := cmd.OutOrStderr() | ||
| fmt.Fprint(out, "Usage:") | ||
| if cmd.Runnable() { | ||
| fmt.Fprintf(out, "\n %s", fixPath(cmd.UseLine())) | ||
| } | ||
| if cmd.HasAvailableSubCommands() { | ||
| fmt.Fprintf(out, "\n %s [command]", fixPath(cmd.CommandPath())) | ||
| } | ||
| if len(cmd.Aliases) > 0 { | ||
| fmt.Fprintf(out, "\n\nAliases:\n %s", cmd.NameAndAliases()) | ||
| } | ||
| if cmd.HasExample() { | ||
| fmt.Fprintf(out, "\n\nExamples:\n%s", cmd.Example) | ||
| } | ||
| if cmd.HasAvailableSubCommands() { | ||
| cmds := cmd.Commands() | ||
| if len(cmd.Groups()) == 0 { | ||
| fmt.Fprint(out, "\n\nAvailable Commands:") | ||
| for _, sub := range cmds { | ||
| if sub.IsAvailableCommand() || sub.Name() == "help" { | ||
| fmt.Fprintf(out, "\n %-11s %s", sub.Name(), sub.Short) | ||
| } | ||
|
Comment on lines
+500
to
+505
|
||
| } | ||
| } else { | ||
| for _, group := range cmd.Groups() { | ||
| fmt.Fprintf(out, "\n\n%s", group.Title) | ||
| for _, sub := range cmds { | ||
| if sub.GroupID == group.ID && (sub.IsAvailableCommand() || sub.Name() == "help") { | ||
| fmt.Fprintf(out, "\n %-11s %s", sub.Name(), sub.Short) | ||
| } | ||
| } | ||
| } | ||
| if !cmd.AllChildCommandsHaveGroup() { | ||
| fmt.Fprint(out, "\n\nAdditional Commands:") | ||
| for _, sub := range cmds { | ||
| if sub.GroupID == "" && (sub.IsAvailableCommand() || sub.Name() == "help") { | ||
| fmt.Fprintf(out, "\n %-11s %s", sub.Name(), sub.Short) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| if cmd.HasAvailableLocalFlags() { | ||
| fmt.Fprintf(out, "\n\nFlags:\n%s", strings.TrimRight(cmd.LocalFlags().FlagUsages(), " \t\n")) | ||
| } | ||
| if cmd.HasAvailableInheritedFlags() { | ||
| fmt.Fprintf(out, "\n\nGlobal Flags:\n%s", strings.TrimRight(cmd.InheritedFlags().FlagUsages(), " \t\n")) | ||
| } | ||
| if cmd.HasAvailableSubCommands() { | ||
| fmt.Fprintf(out, "\n\nUse \"%s [command] --help\" for more information about a command.\n", fixPath(cmd.CommandPath())) | ||
| } else { | ||
| fmt.Fprintln(out) | ||
| } | ||
| return nil | ||
| }) | ||
|
Comment on lines
+469
to
+538
|
||
|
|
||
| // Create custom help command that supports "all" subcommand | ||
| customHelpCmd := &cobra.Command{ | ||
| Use: "help [command]", | ||
|
|
||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment says this “post-process[es] the default output”, but the implementation fully re-renders the usage output (Available Commands/Flags/etc.) rather than modifying Cobra’s default output. This is misleading and also makes it easy for this usage text to drift from upstream Cobra behavior; either update the comment to match what the code does, or prefer wrapping the existing usage output and only rewriting the affected command-path substrings.