bee/vendor/github.com/derekparker/delve/terminal/docgen.go

55 lines
1.2 KiB
Go

package terminal
import (
"fmt"
"io"
"strings"
)
func replaceDocPath(s string) string {
const docpath = "$GOPATH/src/github.com/derekparker/delve/"
for {
start := strings.Index(s, docpath)
if start < 0 {
return s
}
var end int
for end = start + len(docpath); end < len(s); end++ {
if s[end] == ' ' {
break
}
}
text := s[start+len(docpath) : end]
s = s[:start] + fmt.Sprintf("[%s](//github.com/derekparker/delve/tree/master/%s)", text, text) + s[end:]
}
}
func (commands *Commands) WriteMarkdown(w io.Writer) {
fmt.Fprintf(w, "# Commands\n\n")
fmt.Fprintf(w, "Command | Description\n")
fmt.Fprintf(w, "--------|------------\n")
for _, cmd := range commands.cmds {
h := cmd.helpMsg
if idx := strings.Index(h, "\n"); idx >= 0 {
h = h[:idx]
}
fmt.Fprintf(w, "[%s](#%s) | %s\n", cmd.aliases[0], cmd.aliases[0], h)
}
fmt.Fprintf(w, "\n")
for _, cmd := range commands.cmds {
fmt.Fprintf(w, "## %s\n%s\n\n", cmd.aliases[0], replaceDocPath(cmd.helpMsg))
if len(cmd.aliases) > 1 {
fmt.Fprintf(w, "Aliases:")
for _, alias := range cmd.aliases[1:] {
fmt.Fprintf(w, " %s", alias)
}
fmt.Fprintf(w, "\n")
}
fmt.Fprintf(w, "\n")
}
}