diff --git a/command.go b/command.go index bb2126a..11f51c3 100644 --- a/command.go +++ b/command.go @@ -571,7 +571,7 @@ func defaultHelp(cmd *Command) error { } s.WriteString(colour.Title("Options")) - s.WriteString(":\n") + s.WriteString(":\n\n") s.WriteString(usage) // Subcommand help @@ -643,7 +643,7 @@ func writeExamples(cmd *Command, s *strings.Builder) { s.WriteString(colour.Title("Examples")) s.WriteByte(':') - s.WriteByte('\n') + s.WriteString("\n\n") s.WriteString(" # ") s.WriteString(cmd.examples[0].comment) diff --git a/command_test.go b/command_test.go index 3ab6fef..d57cc26 100644 --- a/command_test.go +++ b/command_test.go @@ -607,7 +607,7 @@ func TestHelp(t *testing.T) { for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - snap := snapshot.New(t, snapshot.Update(*update)) + snap := snapshot.New(t, snapshot.Update(*update), snapshot.Color(os.Getenv("CI") == "")) stderr := &bytes.Buffer{} stdout := &bytes.Buffer{} diff --git a/testdata/snapshots/TestHelp/default_long.snap.txt b/testdata/snapshots/TestHelp/default_long.snap.txt index 2dd88a7..4fcf8da 100644 --- a/testdata/snapshots/TestHelp/default_long.snap.txt +++ b/testdata/snapshots/TestHelp/default_long.snap.txt @@ -3,5 +3,6 @@ A placeholder for something cool Usage: test [OPTIONS] ARGS... Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/default_short.snap.txt b/testdata/snapshots/TestHelp/default_short.snap.txt index 2dd88a7..4fcf8da 100644 --- a/testdata/snapshots/TestHelp/default_short.snap.txt +++ b/testdata/snapshots/TestHelp/default_short.snap.txt @@ -3,5 +3,6 @@ A placeholder for something cool Usage: test [OPTIONS] ARGS... Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/full_description_strip_whitespace.snap.txt b/testdata/snapshots/TestHelp/full_description_strip_whitespace.snap.txt index 78efc0a..9b2e332 100644 --- a/testdata/snapshots/TestHelp/full_description_strip_whitespace.snap.txt +++ b/testdata/snapshots/TestHelp/full_description_strip_whitespace.snap.txt @@ -5,5 +5,6 @@ A longer, probably multiline description Usage: test [OPTIONS] ARGS... Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/subcommands_different_lengths.snap.txt b/testdata/snapshots/TestHelp/subcommands_different_lengths.snap.txt index c28c1e7..27f444f 100644 --- a/testdata/snapshots/TestHelp/subcommands_different_lengths.snap.txt +++ b/testdata/snapshots/TestHelp/subcommands_different_lengths.snap.txt @@ -10,6 +10,7 @@ Commands: very-long-subcommand Wow so long Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/with_examples.snap.txt b/testdata/snapshots/TestHelp/with_examples.snap.txt index d11d470..5065c25 100644 --- a/testdata/snapshots/TestHelp/with_examples.snap.txt +++ b/testdata/snapshots/TestHelp/with_examples.snap.txt @@ -3,6 +3,7 @@ A placeholder for something cool Usage: test [OPTIONS] ARGS... Examples: + # Do a thing $ test do thing --now @@ -10,5 +11,6 @@ Examples: $ test do thing --different Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/with_full_description.snap.txt b/testdata/snapshots/TestHelp/with_full_description.snap.txt index 78efc0a..9b2e332 100644 --- a/testdata/snapshots/TestHelp/with_full_description.snap.txt +++ b/testdata/snapshots/TestHelp/with_full_description.snap.txt @@ -5,5 +5,6 @@ A longer, probably multiline description Usage: test [OPTIONS] ARGS... Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/with_named_arguments.snap.txt b/testdata/snapshots/TestHelp/with_named_arguments.snap.txt index bd354a5..31c9abf 100644 --- a/testdata/snapshots/TestHelp/with_named_arguments.snap.txt +++ b/testdata/snapshots/TestHelp/with_named_arguments.snap.txt @@ -8,5 +8,6 @@ Arguments: other Something else [default ""] Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/with_no_description.snap.txt b/testdata/snapshots/TestHelp/with_no_description.snap.txt index 2dd88a7..4fcf8da 100644 --- a/testdata/snapshots/TestHelp/with_no_description.snap.txt +++ b/testdata/snapshots/TestHelp/with_no_description.snap.txt @@ -3,5 +3,6 @@ A placeholder for something cool Usage: test [OPTIONS] ARGS... Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/with_subcommands.snap.txt b/testdata/snapshots/TestHelp/with_subcommands.snap.txt index 82530f2..2b924c0 100644 --- a/testdata/snapshots/TestHelp/with_subcommands.snap.txt +++ b/testdata/snapshots/TestHelp/with_subcommands.snap.txt @@ -9,6 +9,7 @@ Commands: sub2 Do another thing Options: + -h --help bool Show help for test -V --version bool Show version info for test diff --git a/testdata/snapshots/TestHelp/with_subcommands_and_flags.snap.txt b/testdata/snapshots/TestHelp/with_subcommands_and_flags.snap.txt index 5e88a4e..b30fb5f 100644 --- a/testdata/snapshots/TestHelp/with_subcommands_and_flags.snap.txt +++ b/testdata/snapshots/TestHelp/with_subcommands_and_flags.snap.txt @@ -9,6 +9,7 @@ Commands: sub2 Do another thing Options: + N/A --count int Count something [default: -1] -d --delete bool Delete something -h --help bool Show help for test diff --git a/testdata/snapshots/TestHelp/with_verbosity_count.snap.txt b/testdata/snapshots/TestHelp/with_verbosity_count.snap.txt index 4d69253..6d69ba7 100644 --- a/testdata/snapshots/TestHelp/with_verbosity_count.snap.txt +++ b/testdata/snapshots/TestHelp/with_verbosity_count.snap.txt @@ -7,6 +7,7 @@ Arguments: dest Destination to copy to [default ./dest] Options: + -h --help bool Show help for test -v --verbosity count Increase the verbosity level -V --version bool Show version info for test