Skip to content

Add option to specify in usage alias command name #1482

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add option to specify in usage alias command name #1482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion plugins/components/conversionlayer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,11 @@ func createCommandUsages(cmd Command, convertedStringFlags map[string]StringFlag
}

func getCmdUsageString(cmd Command, namespaces ...string) string {
return strings.Join(append(removeEmptyValues(namespaces), cmd.Name), " ")
name := cmd.Name
if cmd.UsageOptions != nil && cmd.UsageOptions.CommandName != "" {
name = cmd.UsageOptions.CommandName
}
return strings.Join(append(removeEmptyValues(namespaces), name), " ")
}

// Generated usages are based on the command's flags and arguments:
Expand Down
2 changes: 2 additions & 0 deletions plugins/components/structure.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ type Command struct {
}

type UsageOptions struct {
// Command name to be used in the usage instead of the actual command name.
CommandName string
// Special cases, each of these will be created as command usage option and the value appended as suffix for the command name.
Usage []string
// If true then the given usages will replace the auto generated usage. Otherwise the given usages will be appended to the auto generated usage.
Expand Down