glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-24 14:47:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

Hide deprecated shorthand flags in man page generation.

Browse source
This commit is contained in:
Daniel Nephin 2016-06-20 17:29:54 -04:00
parent 29c0a1f42e
commit 112c7dca3a
2 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/man_docs.go
View file

@ -131,10 +131,10 @@ func manPrintFlags(out io.Writer, flags *pflag.FlagSet) {
return return
} }
format := "" format := ""
if len(flag.Shorthand) > 0 { if len(flag.Shorthand) > 0 && len(flag.ShorthandDeprecated) == 0 {
format = "**-%s**, **--%s**" format = fmt.Sprintf("**-%s**, **--%s**", flag.Shorthand, flag.Name)
} else { } else {
format = "%s**--%s**" format = fmt.Sprintf("**--%s**", flag.Name)
} }
if len(flag.NoOptDefVal) > 0 { if len(flag.NoOptDefVal) > 0 {
format = format + "[" format = format + "["
@ -149,7 +149,7 @@ func manPrintFlags(out io.Writer, flags *pflag.FlagSet) {
format = format + "]" format = format + "]"
} }
format = format + "\n\t%s\n\n" format = format + "\n\t%s\n\n"
fmt.Fprintf(out, format, flag.Shorthand, flag.Name, flag.DefValue, flag.Usage) fmt.Fprintf(out, format, flag.DefValue, flag.Usage)
}) })
} }

15
doc/man_docs_test.go
View file

@ -129,6 +129,21 @@ func TestGenManSeeAlso(t *testing.T) {
} }
} }
func TestManPrintFlagsHidesShortDeperecated(t *testing.T) {
cmd := &cobra.Command{}
flags := cmd.Flags()
flags.StringP("foo", "f", "default", "Foo flag")
flags.MarkShorthandDeprecated("foo", "don't use it no more")
out := new(bytes.Buffer)
manPrintFlags(out, flags)
expected := "**--foo**=\"default\"\n\tFoo flag\n\n"
if out.String() != expected {
t.Fatalf("Expected %s, but got %s", expected, out.String())
}
}
func AssertLineFound(scanner *bufio.Scanner, expectedLine string) error { func AssertLineFound(scanner *bufio.Scanner, expectedLine string) error {
for scanner.Scan() { for scanner.Scan() {
line := scanner.Text() line := scanner.Text()