spf13--cobra/doc/man_docs.go

237 lines
6.7 KiB
Go
Raw Normal View History

2015-08-18 22:33:41 +00:00
// Copyright 2015 Red Hat Inc. All rights reserved.
//
// 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
2015-08-18 22:33:41 +00:00
import (
"bytes"
"fmt"
"io"
2015-08-18 22:33:41 +00:00
"os"
"path/filepath"
2015-08-18 22:33:41 +00:00
"sort"
"strings"
"time"
"github.com/cpuguy83/go-md2man/md2man"
"github.com/spf13/cobra"
2015-08-18 22:33:41 +00:00
"github.com/spf13/pflag"
)
2016-06-07 10:50:48 +00:00
// GenManTree will generate a man 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 GenManTree(cmd *cobra.Command, header *GenManHeader, dir string) error {
return GenManTreeFromOpts(cmd, GenManTreeOptions{
Header: header,
Path: dir,
CommandSeparator: "-",
})
}
// GenManTreeFromOpts generates a man page for the command and all descendants.
// The pages are written to the opts.Path directory.
func GenManTreeFromOpts(cmd *cobra.Command, opts GenManTreeOptions) error {
header := opts.Header
if header == nil {
header = &GenManHeader{}
}
2015-08-18 22:33:41 +00:00
for _, c := range cmd.Commands() {
if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() {
2015-08-18 22:33:41 +00:00
continue
}
if err := GenManTreeFromOpts(c, opts); err != nil {
return err
}
2015-08-18 22:33:41 +00:00
}
section := "1"
if header.Section != "" {
section = header.Section
}
separator := "_"
if opts.CommandSeparator != "" {
separator = opts.CommandSeparator
}
basename := strings.Replace(cmd.CommandPath(), " ", separator, -1)
filename := filepath.Join(opts.Path, basename+"."+section)
f, err := os.Create(filename)
2015-08-18 22:33:41 +00:00
if err != nil {
return err
2015-08-18 22:33:41 +00:00
}
defer f.Close()
headerCopy := *header
return GenMan(cmd, &headerCopy, f)
2015-08-18 22:33:41 +00:00
}
2017-05-09 09:14:48 +00:00
// GenManTreeOptions is the options for generating the man pages.
// Used only in GenManTreeFromOpts.
type GenManTreeOptions struct {
Header *GenManHeader
Path string
CommandSeparator string
}
// GenManHeader is a lot like the .TH header at the start of man pages. These
// include the title, section, date, source, and manual. We will use the
2018-08-20 17:45:24 +00:00
// current time if Date is unset and will use "Auto generated by spf13/cobra"
// if the Source is unset.
type GenManHeader struct {
Title string
Section string
Date *time.Time
date string
Source string
Manual string
2015-08-18 22:33:41 +00:00
}
// GenMan will generate a man page for the given command and write it to
// w. The header argument may be nil, however obviously w may not.
func GenMan(cmd *cobra.Command, header *GenManHeader, w io.Writer) error {
if header == nil {
header = &GenManHeader{}
}
fillHeader(header, cmd.CommandPath())
b := genMan(cmd, header)
_, err := w.Write(md2man.Render(b))
return err
2015-08-18 22:33:41 +00:00
}
func fillHeader(header *GenManHeader, name string) {
if header.Title == "" {
header.Title = strings.ToUpper(strings.Replace(name, " ", "\\-", -1))
}
if header.Section == "" {
header.Section = "1"
}
if header.Date == nil {
now := time.Now()
header.Date = &now
}
header.date = (*header.Date).Format("Jan 2006")
if header.Source == "" {
header.Source = "Auto generated by spf13/cobra"
}
}
func manPreamble(buf *bytes.Buffer, header *GenManHeader, cmd *cobra.Command, dashedName string) {
description := cmd.Long
if len(description) == 0 {
description = cmd.Short
}
buf.WriteString(fmt.Sprintf(`%% %s(%s)%s
%% %s
%% %s
2015-08-18 22:33:41 +00:00
# NAME
`, 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")
2015-08-18 22:33:41 +00:00
}
func manPrintFlags(buf *bytes.Buffer, flags *pflag.FlagSet) {
2015-08-18 22:33:41 +00:00
flags.VisitAll(func(flag *pflag.Flag) {
if len(flag.Deprecated) > 0 || flag.Hidden {
2015-08-18 22:33:41 +00:00
return
}
format := ""
if len(flag.Shorthand) > 0 && len(flag.ShorthandDeprecated) == 0 {
format = fmt.Sprintf("**-%s**, **--%s**", flag.Shorthand, flag.Name)
2015-08-18 22:33:41 +00:00
} else {
format = fmt.Sprintf("**--%s**", flag.Name)
2015-08-18 22:33:41 +00:00
}
if len(flag.NoOptDefVal) > 0 {
format += "["
2015-08-18 22:33:41 +00:00
}
if flag.Value.Type() == "string" {
// put quotes on the value
format += "=%q"
2015-08-18 22:33:41 +00:00
} else {
format += "=%s"
2015-08-18 22:33:41 +00:00
}
if len(flag.NoOptDefVal) > 0 {
format += "]"
2015-08-18 22:33:41 +00:00
}
format += "\n\t%s\n\n"
buf.WriteString(fmt.Sprintf(format, flag.DefValue, flag.Usage))
2015-08-18 22:33:41 +00:00
})
}
func manPrintOptions(buf *bytes.Buffer, command *cobra.Command) {
2015-08-18 22:33:41 +00:00
flags := command.NonInheritedFlags()
if flags.HasAvailableFlags() {
buf.WriteString("# OPTIONS\n")
manPrintFlags(buf, flags)
buf.WriteString("\n")
2015-08-18 22:33:41 +00:00
}
flags = command.InheritedFlags()
if flags.HasAvailableFlags() {
buf.WriteString("# OPTIONS INHERITED FROM PARENT COMMANDS\n")
manPrintFlags(buf, flags)
buf.WriteString("\n")
2015-08-18 22:33:41 +00:00
}
}
func genMan(cmd *cobra.Command, header *GenManHeader) []byte {
cmd.InitDefaultHelpCmd()
cmd.InitDefaultHelpFlag()
2015-08-18 22:33:41 +00:00
// something like `rootcmd-subcmd1-subcmd2`
dashCommandName := strings.Replace(cmd.CommandPath(), " ", "-", -1)
2015-08-18 22:33:41 +00:00
buf := new(bytes.Buffer)
manPreamble(buf, header, cmd, dashCommandName)
2015-08-18 22:33:41 +00:00
manPrintOptions(buf, cmd)
if len(cmd.Example) > 0 {
buf.WriteString("# EXAMPLE\n")
buf.WriteString(fmt.Sprintf("```\n%s\n```\n", cmd.Example))
2015-08-18 22:33:41 +00:00
}
if hasSeeAlso(cmd) {
buf.WriteString("# SEE ALSO\n")
seealsos := make([]string, 0)
2015-08-18 22:33:41 +00:00
if cmd.HasParent() {
parentPath := cmd.Parent().CommandPath()
dashParentPath := strings.Replace(parentPath, " ", "-", -1)
seealso := fmt.Sprintf("**%s(%s)**", dashParentPath, header.Section)
seealsos = append(seealsos, seealso)
cmd.VisitParents(func(c *cobra.Command) {
if c.DisableAutoGenTag {
cmd.DisableAutoGenTag = c.DisableAutoGenTag
}
})
2015-08-18 22:33:41 +00:00
}
children := cmd.Commands()
sort.Sort(byName(children))
for _, c := range children {
if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() {
2015-08-18 22:33:41 +00:00
continue
}
seealso := fmt.Sprintf("**%s-%s(%s)**", dashCommandName, c.Name(), header.Section)
seealsos = append(seealsos, seealso)
2015-08-18 22:33:41 +00:00
}
buf.WriteString(strings.Join(seealsos, ", ") + "\n")
2015-08-18 22:33:41 +00:00
}
if !cmd.DisableAutoGenTag {
buf.WriteString(fmt.Sprintf("# HISTORY\n%s Auto generated by spf13/cobra\n", header.Date.Format("2-Jan-2006")))
}
2015-08-18 22:33:41 +00:00
return buf.Bytes()
}