Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2884 from thaJeztah/format_help_link 

Help link: remove color, add "bold" style, and white-space
This commit is contained in:
Tibor Vass 2020-12-14 18:27:14 -08:00 committed by GitHub
parent 42d4489992 fa3e0bcdaf
commit 831ebeae96
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
cli/cobra.go
View File

@ -10,6 +10,7 @@ import (
cliconfig "github.com/docker/cli/cli/config" cliconfig "github.com/docker/cli/cli/config"
cliflags "github.com/docker/cli/cli/flags" cliflags "github.com/docker/cli/cli/flags"
"github.com/moby/term" "github.com/moby/term"
"github.com/morikuni/aec"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/pflag" "github.com/spf13/pflag"
@ -49,7 +50,7 @@ func setupCommonRootCommand(rootCmd *cobra.Command) (*cliflags.ClientOptions, *p
rootCmd.PersistentFlags().MarkShorthandDeprecated("help", "please use --help") rootCmd.PersistentFlags().MarkShorthandDeprecated("help", "please use --help")
rootCmd.PersistentFlags().Lookup("help").Hidden = true rootCmd.PersistentFlags().Lookup("help").Hidden = true
rootCmd.Annotations = map[string]string{"additionalHelp": brightCyan("To get more help with docker, check out guides at https://docs.docker.com/go/guides/")} rootCmd.Annotations = map[string]string{"additionalHelp": "To get more help with docker, check out our guides at https://docs.docker.com/go/guides/"}
return opts, flags, helpCommand return opts, flags, helpCommand
} }
@ -210,7 +211,8 @@ func isExperimental(cmd *cobra.Command) bool {
func additionalHelp(cmd *cobra.Command) string { func additionalHelp(cmd *cobra.Command) string {
if additionalHelp, ok := cmd.Annotations["additionalHelp"]; ok { if additionalHelp, ok := cmd.Annotations["additionalHelp"]; ok {
return additionalHelp style := aec.EmptyBuilder.Bold().ANSI
return style.Apply(additionalHelp)
} }
return "" return ""
} }
@ -219,16 +221,6 @@ func hasAdditionalHelp(cmd *cobra.Command) bool {
return additionalHelp(cmd) != "" return additionalHelp(cmd) != ""
} }
var brightCyan = color("\033[1;96m%s\033[0m")
func color(colorString string) func(...interface{}) string {
sprint := func(args ...interface{}) string {
return fmt.Sprintf(colorString,
fmt.Sprint(args...))
}
return sprint
}
func isPlugin(cmd *cobra.Command) bool { func isPlugin(cmd *cobra.Command) bool {
return cmd.Annotations[pluginmanager.CommandAnnotationPlugin] == "true" return cmd.Annotations[pluginmanager.CommandAnnotationPlugin] == "true"
} }
@ -385,6 +377,7 @@ Invalid Plugins:
Run '{{.CommandPath}} COMMAND --help' for more information on a command. Run '{{.CommandPath}} COMMAND --help' for more information on a command.
{{- end}} {{- end}}
{{- if hasAdditionalHelp .}} {{- if hasAdditionalHelp .}}
{{ additionalHelp . }} {{ additionalHelp . }}
{{- end}} {{- end}}
` `