mirror of
https://github.com/spf13/cobra
synced 2024-11-24 22:57:12 +00:00
137 lines
4 KiB
Go
137 lines
4 KiB
Go
// Copyright 2013-2022 The Cobra Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package doc
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
"sort"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// GenAsciidoc creates asciidoc output.
|
|
func GenAsciidoc(cmd *cobra.Command, w io.Writer) error {
|
|
return GenAsciidocCustom(cmd, w, func(s string) string { return s })
|
|
}
|
|
|
|
// GenAsciidocCustom creates custom asciidoc output.
|
|
func GenAsciidocCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error {
|
|
cmd.InitDefaultHelpCmd()
|
|
cmd.InitDefaultHelpFlag()
|
|
|
|
buf := new(bytes.Buffer)
|
|
name := cmd.CommandPath()
|
|
|
|
buf.WriteString("## " + name + "\n\n")
|
|
buf.WriteString(cmd.Short + "\n\n")
|
|
if len(cmd.Long) > 0 {
|
|
buf.WriteString("=== Synopsis\n\n")
|
|
buf.WriteString(cmd.Long + "\n\n")
|
|
}
|
|
|
|
if cmd.Runnable() {
|
|
buf.WriteString(fmt.Sprintf("----\n%s\n----\n\n", cmd.UseLine()))
|
|
}
|
|
|
|
if len(cmd.Example) > 0 {
|
|
buf.WriteString("=== Examples\n\n")
|
|
buf.WriteString(fmt.Sprintf("----\n%s\n----\n\n", cmd.Example))
|
|
}
|
|
|
|
if err := printOptions(buf, cmd, name); err != nil {
|
|
return err
|
|
}
|
|
if hasSeeAlso(cmd) {
|
|
buf.WriteString("=== SEE ALSO\n\n")
|
|
if cmd.HasParent() {
|
|
parent := cmd.Parent()
|
|
pname := parent.CommandPath()
|
|
link := pname + ".adoc"
|
|
link = strings.ReplaceAll(link, " ", "_")
|
|
buf.WriteString(fmt.Sprintf("* xref:%s[%s]\t - %s\n", linkHandler(link), pname, parent.Short))
|
|
cmd.VisitParents(func(c *cobra.Command) {
|
|
if c.DisableAutoGenTag {
|
|
cmd.DisableAutoGenTag = c.DisableAutoGenTag
|
|
}
|
|
})
|
|
}
|
|
|
|
children := cmd.Commands()
|
|
sort.Sort(byName(children))
|
|
|
|
for _, child := range children {
|
|
if !child.IsAvailableCommand() || child.IsAdditionalHelpTopicCommand() {
|
|
continue
|
|
}
|
|
cname := name + " " + child.Name()
|
|
link := cname + ".adoc"
|
|
link = strings.ReplaceAll(link, " ", "_")
|
|
buf.WriteString(fmt.Sprintf("* xref:%s[%s]\t - %s\n", linkHandler(link), cname, child.Short))
|
|
}
|
|
buf.WriteString("\n")
|
|
}
|
|
if !cmd.DisableAutoGenTag {
|
|
buf.WriteString("====== Auto generated by spf13/cobra on " + time.Now().Format("2-Jan-2006") + "\n")
|
|
}
|
|
_, err := buf.WriteTo(w)
|
|
return err
|
|
}
|
|
|
|
// GenAsciidocTree will generate a asciidoc page for this command and all
|
|
// descendants in the directory given. The header may be nil.
|
|
// This function may not work correctly if your command names have `-` in them.
|
|
// If you have `cmd` with two subcmds, `sub` and `sub-third`,
|
|
// and `sub` has a subcommand called `third`, it is undefined which
|
|
// help output will be in the file `cmd-sub-third.1`.
|
|
func GenAsciidocTree(cmd *cobra.Command, dir string) error {
|
|
identity := func(s string) string { return s }
|
|
emptyStr := func(s string) string { return "" }
|
|
return GenAsciidocTreeCustom(cmd, dir, emptyStr, identity)
|
|
}
|
|
|
|
// GenAsciidocTreeCustom is the the same as GenAsciidocTree, but
|
|
// with custom filePrepender and linkHandler.
|
|
func GenAsciidocTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error {
|
|
for _, c := range cmd.Commands() {
|
|
if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() {
|
|
continue
|
|
}
|
|
if err := GenAsciidocTreeCustom(c, dir, filePrepender, linkHandler); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
basename := strings.ReplaceAll(cmd.CommandPath(), " ", "_") + ".adoc"
|
|
filename := filepath.Join(dir, basename)
|
|
f, err := os.Create(filename)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer f.Close()
|
|
|
|
if _, err := io.WriteString(f, filePrepender(filename)); err != nil {
|
|
return err
|
|
}
|
|
if err := GenAsciidocCustom(cmd, f, linkHandler); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|