Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
mafredri merged 1 commit intomainfrommafredri/wrap-help-flags
Jul 11, 2022
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
11 changes: 8 additions & 3 deletionscli/cliflag/cliflag.go
View file
Open in desktop
Original file line numberDiff line numberDiff 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)
}

returnfmt.Sprintf("%s - consumes $%s.", u, env)
returnu
}
12 changes: 6 additions & 6 deletionscli/cliflag/cliflag_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 deletionscli/root.go
View file
Open in desktop
Original file line numberDiff line numberDiff 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
MemberAuthor

Choose a reason for hiding this comment

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

Same here, we havepflag to thank ❤️! 😄

{{end}}

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

{{- if .HasHelpSubCommands}}
Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp