p4u1/docker-cli
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #28751 from ijc25/wrap-help-output

Browse Source 
Wrap CLI --help output to terminal width
Upstream-commit: bba31c3f04
Component: cli
This commit is contained in:
Sebastiaan van Stijn
2017-02-03 23:04:11 -08:00
committed by GitHub
parent 1ecc83f981 7b7e8e4da1
commit d73850cfbf
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
components/cli/cobra.go
View File

@ -4,6 +4,7 @@ import (
"fmt"
"strings"
"github.com/docker/docker/pkg/term"
"github.com/spf13/cobra"
)
@ -14,6 +15,7 @@ func SetupRootCommand(rootCmd *cobra.Command) {
cobra.AddTemplateFunc("hasManagementSubCommands", hasManagementSubCommands)
cobra.AddTemplateFunc("operationSubCommands", operationSubCommands)
cobra.AddTemplateFunc("managementSubCommands", managementSubCommands)
cobra.AddTemplateFunc("wrappedFlagUsages", wrappedFlagUsages)
rootCmd.SetUsageTemplate(usageTemplate)
rootCmd.SetHelpTemplate(helpTemplate)
@ -76,6 +78,14 @@ func operationSubCommands(cmd *cobra.Command) []*cobra.Command {
return cmds
}
func wrappedFlagUsages(cmd *cobra.Command) string {
width := 80
if ws, err := term.GetWinsize(0); err == nil {
width = int(ws.Width)
}
return cmd.Flags().FlagUsagesWrapped(width - 1)
}
func managementSubCommands(cmd *cobra.Command) []*cobra.Command {
cmds := []*cobra.Command{}
for _, sub := range cmd.Commands() {
@ -108,7 +118,7 @@ Examples:
{{- if .HasFlags}}
Options:
{{.Flags.FlagUsages | trimRightSpace}}
{{ wrappedFlagUsages . | trimRightSpace}}
{{- end}}
{{- if hasManagementSubCommands . }}