summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/spf13/cobra/doc
diff options
context:
space:
mode:
authorChristopher Speller <crspeller@gmail.com>2017-05-17 16:51:25 -0400
committerGitHub <noreply@github.com>2017-05-17 16:51:25 -0400
commitd103ed6ca97ca5a2669f6cf5fe4b3d2a9c945f26 (patch)
treedbde13123c6add150448f7b75753ac022d862475 /vendor/github.com/spf13/cobra/doc
parentcd23b8139a9463b67e3096744321f6f4eb0ca40a (diff)
downloadchat-d103ed6ca97ca5a2669f6cf5fe4b3d2a9c945f26.tar.gz
chat-d103ed6ca97ca5a2669f6cf5fe4b3d2a9c945f26.tar.bz2
chat-d103ed6ca97ca5a2669f6cf5fe4b3d2a9c945f26.zip
Upgrading server dependancies (#6431)
Diffstat (limited to 'vendor/github.com/spf13/cobra/doc')
-rw-r--r--vendor/github.com/spf13/cobra/doc/man_docs.go60
-rw-r--r--vendor/github.com/spf13/cobra/doc/man_docs_test.go17
-rw-r--r--vendor/github.com/spf13/cobra/doc/md_docs.go79
-rw-r--r--vendor/github.com/spf13/cobra/doc/md_docs_test.go17
-rw-r--r--vendor/github.com/spf13/cobra/doc/yaml_docs.go3
-rw-r--r--vendor/github.com/spf13/cobra/doc/yaml_docs_test.go17
6 files changed, 110 insertions, 83 deletions
diff --git a/vendor/github.com/spf13/cobra/doc/man_docs.go b/vendor/github.com/spf13/cobra/doc/man_docs.go
index 1f90c44f1..74b284d2d 100644
--- a/vendor/github.com/spf13/cobra/doc/man_docs.go
+++ b/vendor/github.com/spf13/cobra/doc/man_docs.go
@@ -23,7 +23,7 @@ import (
"strings"
"time"
- mangen "github.com/cpuguy83/go-md2man/md2man"
+ "github.com/cpuguy83/go-md2man/md2man"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
@@ -77,6 +77,8 @@ func GenManTreeFromOpts(cmd *cobra.Command, opts GenManTreeOptions) error {
return GenMan(cmd, &headerCopy, f)
}
+// GenManTreeOptions is the options for generating the man pages.
+// Used only in GenManTreeFromOpts.
type GenManTreeOptions struct {
Header *GenManHeader
Path string
@@ -105,7 +107,7 @@ func GenMan(cmd *cobra.Command, header *GenManHeader, w io.Writer) error {
fillHeader(header, cmd.CommandPath())
b := genMan(cmd, header)
- _, err := w.Write(mangen.Render(b))
+ _, err := w.Write(md2man.Render(b))
return err
}
@@ -126,25 +128,25 @@ func fillHeader(header *GenManHeader, name string) {
}
}
-func manPreamble(out io.Writer, header *GenManHeader, cmd *cobra.Command, dashedName string) {
+func manPreamble(buf *bytes.Buffer, header *GenManHeader, cmd *cobra.Command, dashedName string) {
description := cmd.Long
if len(description) == 0 {
description = cmd.Short
}
- fmt.Fprintf(out, `%% %s(%s)%s
+ buf.WriteString(fmt.Sprintf(`%% %s(%s)%s
%% %s
%% %s
# NAME
-`, header.Title, header.Section, header.date, header.Source, header.Manual)
- fmt.Fprintf(out, "%s \\- %s\n\n", dashedName, cmd.Short)
- fmt.Fprintf(out, "# SYNOPSIS\n")
- fmt.Fprintf(out, "**%s**\n\n", cmd.UseLine())
- fmt.Fprintf(out, "# DESCRIPTION\n")
- fmt.Fprintf(out, "%s\n\n", description)
+`, header.Title, header.Section, header.date, header.Source, header.Manual))
+ buf.WriteString(fmt.Sprintf("%s \\- %s\n\n", dashedName, cmd.Short))
+ buf.WriteString("# SYNOPSIS\n")
+ buf.WriteString(fmt.Sprintf("**%s**\n\n", cmd.UseLine()))
+ buf.WriteString("# DESCRIPTION\n")
+ buf.WriteString(description + "\n\n")
}
-func manPrintFlags(out io.Writer, flags *pflag.FlagSet) {
+func manPrintFlags(buf *bytes.Buffer, flags *pflag.FlagSet) {
flags.VisitAll(func(flag *pflag.Flag) {
if len(flag.Deprecated) > 0 || flag.Hidden {
return
@@ -156,34 +158,34 @@ func manPrintFlags(out io.Writer, flags *pflag.FlagSet) {
format = fmt.Sprintf("**--%s**", flag.Name)
}
if len(flag.NoOptDefVal) > 0 {
- format = format + "["
+ format += "["
}
if flag.Value.Type() == "string" {
// put quotes on the value
- format = format + "=%q"
+ format += "=%q"
} else {
- format = format + "=%s"
+ format += "=%s"
}
if len(flag.NoOptDefVal) > 0 {
- format = format + "]"
+ format += "]"
}
- format = format + "\n\t%s\n\n"
- fmt.Fprintf(out, format, flag.DefValue, flag.Usage)
+ format += "\n\t%s\n\n"
+ buf.WriteString(fmt.Sprintf(format, flag.DefValue, flag.Usage))
})
}
-func manPrintOptions(out io.Writer, command *cobra.Command) {
+func manPrintOptions(buf *bytes.Buffer, command *cobra.Command) {
flags := command.NonInheritedFlags()
if flags.HasFlags() {
- fmt.Fprintf(out, "# OPTIONS\n")
- manPrintFlags(out, flags)
- fmt.Fprintf(out, "\n")
+ buf.WriteString("# OPTIONS\n")
+ manPrintFlags(buf, flags)
+ buf.WriteString("\n")
}
flags = command.InheritedFlags()
if flags.HasFlags() {
- fmt.Fprintf(out, "# OPTIONS INHERITED FROM PARENT COMMANDS\n")
- manPrintFlags(out, flags)
- fmt.Fprintf(out, "\n")
+ buf.WriteString("# OPTIONS INHERITED FROM PARENT COMMANDS\n")
+ manPrintFlags(buf, flags)
+ buf.WriteString("\n")
}
}
@@ -196,11 +198,11 @@ func genMan(cmd *cobra.Command, header *GenManHeader) []byte {
manPreamble(buf, header, cmd, dashCommandName)
manPrintOptions(buf, cmd)
if len(cmd.Example) > 0 {
- fmt.Fprintf(buf, "# EXAMPLE\n")
- fmt.Fprintf(buf, "```\n%s\n```\n", cmd.Example)
+ buf.WriteString("# EXAMPLE\n")
+ buf.WriteString(fmt.Sprintf("```\n%s\n```\n", cmd.Example))
}
if hasSeeAlso(cmd) {
- fmt.Fprintf(buf, "# SEE ALSO\n")
+ buf.WriteString("# SEE ALSO\n")
seealsos := make([]string, 0)
if cmd.HasParent() {
parentPath := cmd.Parent().CommandPath()
@@ -222,10 +224,10 @@ func genMan(cmd *cobra.Command, header *GenManHeader) []byte {
seealso := fmt.Sprintf("**%s-%s(%s)**", dashCommandName, c.Name(), header.Section)
seealsos = append(seealsos, seealso)
}
- fmt.Fprintf(buf, "%s\n", strings.Join(seealsos, ", "))
+ buf.WriteString(strings.Join(seealsos, ", ") + "\n")
}
if !cmd.DisableAutoGenTag {
- fmt.Fprintf(buf, "# HISTORY\n%s Auto generated by spf13/cobra\n", header.Date.Format("2-Jan-2006"))
+ buf.WriteString(fmt.Sprintf("# HISTORY\n%s Auto generated by spf13/cobra\n", header.Date.Format("2-Jan-2006")))
}
return buf.Bytes()
}
diff --git a/vendor/github.com/spf13/cobra/doc/man_docs_test.go b/vendor/github.com/spf13/cobra/doc/man_docs_test.go
index 9b272917d..87991063e 100644
--- a/vendor/github.com/spf13/cobra/doc/man_docs_test.go
+++ b/vendor/github.com/spf13/cobra/doc/man_docs_test.go
@@ -197,3 +197,20 @@ func AssertNextLineEquals(scanner *bufio.Scanner, expectedLine string) error {
return fmt.Errorf("AssertNextLineEquals: hit EOF before finding %#v", expectedLine)
}
+
+func BenchmarkGenManToFile(b *testing.B) {
+ c := initializeWithRootCmd()
+ file, err := ioutil.TempFile("", "")
+ if err != nil {
+ b.Fatal(err)
+ }
+ defer os.Remove(file.Name())
+ defer file.Close()
+
+ b.ResetTimer()
+ for i := 0; i < b.N; i++ {
+ if err := GenMan(c, nil, file); err != nil {
+ b.Fatal(err)
+ }
+ }
+}
diff --git a/vendor/github.com/spf13/cobra/doc/md_docs.go b/vendor/github.com/spf13/cobra/doc/md_docs.go
index 408d2f74b..9bbfa36ff 100644
--- a/vendor/github.com/spf13/cobra/doc/md_docs.go
+++ b/vendor/github.com/spf13/cobra/doc/md_docs.go
@@ -14,6 +14,7 @@
package doc
import (
+ "bytes"
"fmt"
"io"
"os"
@@ -25,29 +26,21 @@ import (
"github.com/spf13/cobra"
)
-func printOptions(w io.Writer, cmd *cobra.Command, name string) error {
+func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error {
flags := cmd.NonInheritedFlags()
- flags.SetOutput(w)
+ flags.SetOutput(buf)
if flags.HasFlags() {
- if _, err := fmt.Fprintf(w, "### Options\n\n```\n"); err != nil {
- return err
- }
+ buf.WriteString("### Options\n\n```\n")
flags.PrintDefaults()
- if _, err := fmt.Fprintf(w, "```\n\n"); err != nil {
- return err
- }
+ buf.WriteString("```\n\n")
}
parentFlags := cmd.InheritedFlags()
- parentFlags.SetOutput(w)
+ parentFlags.SetOutput(buf)
if parentFlags.HasFlags() {
- if _, err := fmt.Fprintf(w, "### Options inherited from parent commands\n\n```\n"); err != nil {
- return err
- }
+ buf.WriteString("### Options inherited from parent commands\n\n```\n")
parentFlags.PrintDefaults()
- if _, err := fmt.Fprintf(w, "```\n\n"); err != nil {
- return err
- }
+ buf.WriteString("```\n\n")
}
return nil
}
@@ -59,6 +52,7 @@ func GenMarkdown(cmd *cobra.Command, w io.Writer) error {
// GenMarkdownCustom creates custom markdown output.
func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error {
+ buf := new(bytes.Buffer)
name := cmd.CommandPath()
short := cmd.Short
@@ -67,49 +61,31 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
long = short
}
- if _, err := fmt.Fprintf(w, "## %s\n\n", name); err != nil {
- return err
- }
- if _, err := fmt.Fprintf(w, "%s\n\n", short); err != nil {
- return err
- }
- if _, err := fmt.Fprintf(w, "### Synopsis\n\n"); err != nil {
- return err
- }
- if _, err := fmt.Fprintf(w, "\n%s\n\n", long); err != nil {
- return err
- }
+ buf.WriteString("## " + name + "\n\n")
+ buf.WriteString(short + "\n\n")
+ buf.WriteString("### Synopsis\n\n")
+ buf.WriteString("\n" + long + "\n\n")
if cmd.Runnable() {
- if _, err := fmt.Fprintf(w, "```\n%s\n```\n\n", cmd.UseLine()); err != nil {
- return err
- }
+ buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.UseLine()))
}
if len(cmd.Example) > 0 {
- if _, err := fmt.Fprintf(w, "### Examples\n\n"); err != nil {
- return err
- }
- if _, err := fmt.Fprintf(w, "```\n%s\n```\n\n", cmd.Example); err != nil {
- return err
- }
+ buf.WriteString("### Examples\n\n")
+ buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example))
}
- if err := printOptions(w, cmd, name); err != nil {
+ if err := printOptions(buf, cmd, name); err != nil {
return err
}
if hasSeeAlso(cmd) {
- if _, err := fmt.Fprintf(w, "### SEE ALSO\n"); err != nil {
- return err
- }
+ buf.WriteString("### SEE ALSO\n")
if cmd.HasParent() {
parent := cmd.Parent()
pname := parent.CommandPath()
link := pname + ".md"
link = strings.Replace(link, " ", "_", -1)
- if _, err := fmt.Fprintf(w, "* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short); err != nil {
- return err
- }
+ buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short))
cmd.VisitParents(func(c *cobra.Command) {
if c.DisableAutoGenTag {
cmd.DisableAutoGenTag = c.DisableAutoGenTag
@@ -127,20 +103,15 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
cname := name + " " + child.Name()
link := cname + ".md"
link = strings.Replace(link, " ", "_", -1)
- if _, err := fmt.Fprintf(w, "* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short); err != nil {
- return err
- }
- }
- if _, err := fmt.Fprintf(w, "\n"); err != nil {
- return err
+ buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short))
}
+ buf.WriteString("\n")
}
if !cmd.DisableAutoGenTag {
- if _, err := fmt.Fprintf(w, "###### Auto generated by spf13/cobra on %s\n", time.Now().Format("2-Jan-2006")); err != nil {
- return err
- }
+ buf.WriteString("###### Auto generated by spf13/cobra on " + time.Now().Format("2-Jan-2006") + "\n")
}
- return nil
+ _, err := buf.WriteTo(w)
+ return err
}
// GenMarkdownTree will generate a markdown page for this command and all
@@ -155,6 +126,8 @@ func GenMarkdownTree(cmd *cobra.Command, dir string) error {
return GenMarkdownTreeCustom(cmd, dir, emptyStr, identity)
}
+// GenMarkdownTreeCustom is the the same as GenMarkdownTree, but
+// with custom filePrepender and linkHandler.
func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error {
for _, c := range cmd.Commands() {
if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() {
diff --git a/vendor/github.com/spf13/cobra/doc/md_docs_test.go b/vendor/github.com/spf13/cobra/doc/md_docs_test.go
index f4f3bc149..ba6b9a46e 100644
--- a/vendor/github.com/spf13/cobra/doc/md_docs_test.go
+++ b/vendor/github.com/spf13/cobra/doc/md_docs_test.go
@@ -105,3 +105,20 @@ func TestGenMdTree(t *testing.T) {
t.Fatalf("Expected file 'do.md' to exist")
}
}
+
+func BenchmarkGenMarkdownToFile(b *testing.B) {
+ c := initializeWithRootCmd()
+ file, err := ioutil.TempFile("", "")
+ if err != nil {
+ b.Fatal(err)
+ }
+ defer os.Remove(file.Name())
+ defer file.Close()
+
+ b.ResetTimer()
+ for i := 0; i < b.N; i++ {
+ if err := GenMarkdown(c, file); err != nil {
+ b.Fatal(err)
+ }
+ }
+}
diff --git a/vendor/github.com/spf13/cobra/doc/yaml_docs.go b/vendor/github.com/spf13/cobra/doc/yaml_docs.go
index f5cd5a329..54c244d45 100644
--- a/vendor/github.com/spf13/cobra/doc/yaml_docs.go
+++ b/vendor/github.com/spf13/cobra/doc/yaml_docs.go
@@ -130,7 +130,8 @@ func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) str
fmt.Println(err)
os.Exit(1)
}
- if _, err := fmt.Fprintf(w, string(final)); err != nil {
+
+ if _, err := w.Write(final); err != nil {
return err
}
return nil
diff --git a/vendor/github.com/spf13/cobra/doc/yaml_docs_test.go b/vendor/github.com/spf13/cobra/doc/yaml_docs_test.go
index fb969da22..29e985e40 100644
--- a/vendor/github.com/spf13/cobra/doc/yaml_docs_test.go
+++ b/vendor/github.com/spf13/cobra/doc/yaml_docs_test.go
@@ -106,3 +106,20 @@ func TestGenYamlTree(t *testing.T) {
t.Fatalf("Expected file 'do.yaml' to exist")
}
}
+
+func BenchmarkGenYamlToFile(b *testing.B) {
+ c := initializeWithRootCmd()
+ file, err := ioutil.TempFile("", "")
+ if err != nil {
+ b.Fatal(err)
+ }
+ defer os.Remove(file.Name())
+ defer file.Close()
+
+ b.ResetTimer()
+ for i := 0; i < b.N; i++ {
+ if err := GenYaml(c, file); err != nil {
+ b.Fatal(err)
+ }
+ }
+}