summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/spf13/cobra/doc/md_docs.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/spf13/cobra/doc/md_docs.go')
-rw-r--r--vendor/github.com/spf13/cobra/doc/md_docs.go79
1 files changed, 26 insertions, 53 deletions
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() {