Skip to content

fix: Wrap help flags at 100 chars #2893

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

Merged
merged 1 commit into from
Jul 11, 2022
Merged

fix: Wrap help flags at 100 chars #2893

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
fix: Wrap help flags at 100 chars 
Because the actual flags take quite a bit of space, wrapping at 80
characters creates a very cramped output for e.g. `coder server`, for
this reasons, flags are wrapped at 100 chars (vs. standard 80).

The `Consumes $ENV_FLAG` message was put on a newline for consistency,
this should allow users to learn where to look for the informations.

Side note: we should perhaps stop adding period (`.`) at the end of flag
descriptions to be consistent, for instance, command helps usually don't
have one.

This change fixes the biggest issue in #2363, but not all `--help`
output is guaranteed (yet) to wrap at 80-100 chars.

Fixes #2363
  • Loading branch information
@mafredri
mafredri committed Jul 11, 2022
commit dccc82ca305c8df83328b757f71f6f2a0be7a09b
11 changes: 8 additions & 3 deletions cli/cliflag/cliflag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,14 @@ func DurationVarP(flagset *pflag.FlagSet, ptr *time.Duration, name string, short
}

func fmtUsage(u string, env string) string {
if env == "" {
return fmt.Sprintf("%s.", u)
if env != "" {
// Avoid double dotting.
dot := "."
if strings.HasSuffix(u, ".") {
dot = ""
}
u = fmt.Sprintf("%s%s\nConsumes $%s", u, dot, env)
}

return fmt.Sprintf("%s - consumes $%s.", u, env)
return u
}
12 changes: 6 additions & 6 deletions cli/cliflag/cliflag_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func TestCliflag(t *testing.T) {
require.NoError(t, err)
require.Equal(t, def, got)
require.Contains(t, flagset.FlagUsages(), usage)
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf(" - consumes $%s", env))
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
})

t.Run("StringEnvVar", func(t *testing.T) {
Expand All @@ -48,7 +48,7 @@ func TestCliflag(t *testing.T) {
require.NoError(t, err)
require.Equal(t, def, got)
require.Contains(t, flagset.FlagUsages(), usage)
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf(" - consumes $%s", env))
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
})

t.Run("StringVarPEnvVar", func(t *testing.T) {
Expand All @@ -74,7 +74,7 @@ func TestCliflag(t *testing.T) {
require.NoError(t, err)
require.Equal(t, def, got)
require.Contains(t, flagset.FlagUsages(), usage)
require.NotContains(t, flagset.FlagUsages(), " - consumes")
require.NotContains(t, flagset.FlagUsages(), "Consumes")
})

t.Run("StringArrayDefault", func(t *testing.T) {
Expand Down Expand Up @@ -117,7 +117,7 @@ func TestCliflag(t *testing.T) {
require.NoError(t, err)
require.Equal(t, uint8(def), got)
require.Contains(t, flagset.FlagUsages(), usage)
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf(" - consumes $%s", env))
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
})

t.Run("IntEnvVar", func(t *testing.T) {
Expand Down Expand Up @@ -156,7 +156,7 @@ func TestCliflag(t *testing.T) {
require.NoError(t, err)
require.Equal(t, def, got)
require.Contains(t, flagset.FlagUsages(), usage)
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf(" - consumes $%s", env))
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
})

t.Run("BoolEnvVar", func(t *testing.T) {
Expand Down Expand Up @@ -195,7 +195,7 @@ func TestCliflag(t *testing.T) {
require.NoError(t, err)
require.Equal(t, def, got)
require.Contains(t, flagset.FlagUsages(), usage)
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf(" - consumes $%s", env))
require.Contains(t, flagset.FlagUsages(), fmt.Sprintf("Consumes $%s", env))
})

t.Run("DurationEnvVar", func(t *testing.T) {
Expand Down
4 changes: 2 additions & 2 deletions cli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,12 +348,12 @@ func usageTemplate() string {

{{- if .HasAvailableLocalFlags}}
{{usageHeader "Flags:"}}
{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}
{{.LocalFlags.FlagUsagesWrapped 100}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL 👍

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, we have pflag to thank ❤️! 😄

{{end}}

{{- if .HasAvailableInheritedFlags}}
{{usageHeader "Global Flags:"}}
{{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}
{{.InheritedFlags.FlagUsagesWrapped 100}}
{{end}}

{{- if .HasHelpSubCommands}}
Expand Down