Include flag descriptions when using zsh completion

[Toalaah]

What type of PR is this?

• feature

What this PR does / why we need it:

This PR ensures that flags' Usage fields are included when using zsh completion (if their description is non-empty). This functionality is in line with how this is handled for command completion, see

cli/help.go

Line 163 in 043b774

_, _ = fmt.Fprintf(writer, "%s:%s\n", command.Name, command.Usage)

Without Changes

With changes

Testing

I tested these changes locally against a CLI tool that I am migrating to urfave/cli/v3. I also ran make test and encountered no errors, but then again I also did not add any test cases (would be open to doing so if this feature is desired).

Release Notes

Flag usage fields are now included when using zsh completion

[bartekpacia]

Hi @Toalaah! Thank you very much for the contribution :)

[bartekpacia]

LGTM.

[bartekpacia]

@meatballhat @Juneezee What should be done when codecov fails, like in this PR?

[Juneezee]

@meatballhat @Juneezee What should be done when codecov fails, like in this PR?

@bartekpacia I think the simplest way would be adding a test case for zsh in TestDefaultCompleteWithFlags

cli/help_test.go

Lines 1079 to 1083 in 043b774

	func TestDefaultCompleteWithFlags(t *testing.T) {
	origArgv := os.Args
	t.Cleanup(func() { os.Args = origArgv })
	t.Setenv("SHELL", "bash")

[Toalaah]

Thanks for the hint, added some zsh-specific test cases. Looks like codecov is no longer complaining.

[bartekpacia]

Thanks a lot :-)