glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-24 14:47:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix markdownlint errors at 'doc'

Browse source 
Fixed rules:
* MD010 - Hard tabs
* MD040 - Fenced code blocks should have a language specified
* MD041 - First line in a file should be a top-level heading

see: https://github.com/DavidAnson/markdownlint#rules--aliases
This commit is contained in:
Erdal TAŞKESEN 2022-07-03 17:45:45 +03:00
parent 69083f81b2
commit f8b8914b8b
No known key found for this signature in database
GPG key ID: 59A48E85C4A36006
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/md_docs.go
View file

@ -30,7 +30,7 @@ func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error {
flags := cmd.NonInheritedFlags() flags := cmd.NonInheritedFlags()
flags.SetOutput(buf) flags.SetOutput(buf)
if flags.HasAvailableFlags() { if flags.HasAvailableFlags() {
buf.WriteString("### Options\n\n```\n") buf.WriteString("## Options\n\n```sh\n")
flags.PrintDefaults() flags.PrintDefaults()
buf.WriteString("```\n\n") buf.WriteString("```\n\n")
} }
@ -38,7 +38,7 @@ func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error {
parentFlags := cmd.InheritedFlags() parentFlags := cmd.InheritedFlags()
parentFlags.SetOutput(buf) parentFlags.SetOutput(buf)
if parentFlags.HasAvailableFlags() { if parentFlags.HasAvailableFlags() {
buf.WriteString("### Options inherited from parent commands\n\n```\n") buf.WriteString("### Options inherited from parent commands\n\n```sh\n")
parentFlags.PrintDefaults() parentFlags.PrintDefaults()
buf.WriteString("```\n\n") buf.WriteString("```\n\n")
} }
@ -58,33 +58,33 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
buf := new(bytes.Buffer) buf := new(bytes.Buffer)
name := cmd.CommandPath() name := cmd.CommandPath()
buf.WriteString("## " + name + "\n\n") buf.WriteString("# " + name + "\n\n")
buf.WriteString(cmd.Short + "\n\n") buf.WriteString(cmd.Short + "\n\n")
if len(cmd.Long) > 0 { if len(cmd.Long) > 0 {
buf.WriteString("### Synopsis\n\n") buf.WriteString("## Synopsis\n\n")
buf.WriteString(cmd.Long + "\n\n") buf.WriteString(cmd.Long + "\n\n")
} }
if cmd.Runnable() { if cmd.Runnable() {
buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.UseLine())) buf.WriteString(fmt.Sprintf("```sh\n%s\n```\n\n", cmd.UseLine()))
} }
if len(cmd.Example) > 0 { if len(cmd.Example) > 0 {
buf.WriteString("### Examples\n\n") buf.WriteString("## Examples\n\n")
buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example)) buf.WriteString(fmt.Sprintf("```sh\n%s\n```\n\n", cmd.Example))
} }
if err := printOptions(buf, cmd, name); err != nil { if err := printOptions(buf, cmd, name); err != nil {
return err return err
} }
if hasSeeAlso(cmd) { if hasSeeAlso(cmd) {
buf.WriteString("### SEE ALSO\n\n") buf.WriteString("## SEE ALSO\n\n")
if cmd.HasParent() { if cmd.HasParent() {
parent := cmd.Parent() parent := cmd.Parent()
pname := parent.CommandPath() pname := parent.CommandPath()
link := pname + ".md" link := pname + ".md"
link = strings.ReplaceAll(link, " ", "_") link = strings.ReplaceAll(link, " ", "_")
buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short)) buf.WriteString(fmt.Sprintf("* [%s](%s) - %s\n", pname, linkHandler(link), parent.Short))
cmd.VisitParents(func(c *cobra.Command) { cmd.VisitParents(func(c *cobra.Command) {
if c.DisableAutoGenTag { if c.DisableAutoGenTag {
cmd.DisableAutoGenTag = c.DisableAutoGenTag cmd.DisableAutoGenTag = c.DisableAutoGenTag
@ -102,9 +102,8 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string)
cname := name + " " + child.Name() cname := name + " " + child.Name()
link := cname + ".md" link := cname + ".md"
link = strings.ReplaceAll(link, " ", "_") link = strings.ReplaceAll(link, " ", "_")
buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short)) buf.WriteString(fmt.Sprintf("* [%s](%s) - %s\n", cname, linkHandler(link), child.Short))
} }
buf.WriteString("\n")
} }
if !cmd.DisableAutoGenTag { if !cmd.DisableAutoGenTag {
buf.WriteString("###### Auto generated by spf13/cobra on " + time.Now().Format("2-Jan-2006") + "\n") buf.WriteString("###### Auto generated by spf13/cobra on " + time.Now().Format("2-Jan-2006") + "\n")