From d4cc366cdba4d2d6ef61abf1b68c7bc7ec1d4591 Mon Sep 17 00:00:00 2001 From: commit111 Date: Fri, 25 Apr 2025 09:28:20 -0700 Subject: [PATCH 1/6] print aliases --- doc/md_docs.go | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/md_docs.go b/doc/md_docs.go index 12592223..a25498cf 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -29,6 +29,16 @@ import ( const markdownExtension = ".md" +func printAliases(buf *bytes.Buffer, cmd *cobra.Command) { + if len(cmd.Aliases) > 0 { + buf.WriteString("### Aliases\n\n") + for _, alias := range cmd.Aliases { + buf.WriteString(fmt.Sprintf("* `%s`\n", alias)) + } + buf.WriteString("\n") + } +} + func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error { flags := cmd.NonInheritedFlags() flags.SetOutput(buf) From 763bf029e31e403066e023dc37b0b3b358e0c70d Mon Sep 17 00:00:00 2001 From: commit111 Date: Fri, 25 Apr 2025 10:06:38 -0700 Subject: [PATCH 2/6] update to not use seperate fn --- doc/md_docs.go | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/doc/md_docs.go b/doc/md_docs.go index a25498cf..06ea0071 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -29,16 +29,6 @@ import ( const markdownExtension = ".md" -func printAliases(buf *bytes.Buffer, cmd *cobra.Command) { - if len(cmd.Aliases) > 0 { - buf.WriteString("### Aliases\n\n") - for _, alias := range cmd.Aliases { - buf.WriteString(fmt.Sprintf("* `%s`\n", alias)) - } - buf.WriteString("\n") - } -} - func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error { flags := cmd.NonInheritedFlags() flags.SetOutput(buf) @@ -82,6 +72,14 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.UseLine())) } + if len(cmd.Aliases) > 0 { + buf.WriteString("### Aliases\n\n") + for _, alias := range cmd.Aliases { + buf.WriteString(fmt.Sprintf("* `%s`\n", alias)) + } + buf.WriteString("\n") + } + if len(cmd.Example) > 0 { buf.WriteString("### Examples\n\n") buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example)) From b228800365d92f1932b3fff7f29a1695c926fe07 Mon Sep 17 00:00:00 2001 From: commit111 Date: Fri, 25 Apr 2025 11:03:46 -0700 Subject: [PATCH 3/6] add parent path --- doc/md_docs.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/md_docs.go b/doc/md_docs.go index 06ea0071..fcc0ea72 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -75,7 +75,10 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) if len(cmd.Aliases) > 0 { buf.WriteString("### Aliases\n\n") for _, alias := range cmd.Aliases { - buf.WriteString(fmt.Sprintf("* `%s`\n", alias)) + if cmd.HasParent() { + alias = cmd.Parent().CommandPath() + " " + alias + } + buf.WriteString(fmt.Sprintf("```\n%s\n```\n", alias)) } buf.WriteString("\n") } From b500586eda5f544a1e69d7c600031fddaaed5138 Mon Sep 17 00:00:00 2001 From: commit111 Date: Fri, 25 Apr 2025 11:20:29 -0700 Subject: [PATCH 4/6] print on one line, and remove parent path --- doc/md_docs.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/md_docs.go b/doc/md_docs.go index fcc0ea72..989996a1 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -73,12 +73,12 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) } if len(cmd.Aliases) > 0 { - buf.WriteString("### Aliases\n\n") + buf.WriteString("Aliases: ") for _, alias := range cmd.Aliases { - if cmd.HasParent() { - alias = cmd.Parent().CommandPath() + " " + alias + buf.WriteString(fmt.Sprintf("`%s`", alias)) + if alias != cmd.Aliases[len(cmd.Aliases)-1] { + buf.WriteString(", ") } - buf.WriteString(fmt.Sprintf("```\n%s\n```\n", alias)) } buf.WriteString("\n") } From 659f06eeb7d6bf4172857be14bb207929d0516cf Mon Sep 17 00:00:00 2001 From: "Linda L." Date: Fri, 25 Apr 2025 13:40:02 -0700 Subject: [PATCH 5/6] Update doc/md_docs.go Co-authored-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com> --- doc/md_docs.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/md_docs.go b/doc/md_docs.go index 989996a1..40ae06bf 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -74,11 +74,11 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) if len(cmd.Aliases) > 0 { buf.WriteString("Aliases: ") - for _, alias := range cmd.Aliases { - buf.WriteString(fmt.Sprintf("`%s`", alias)) - if alias != cmd.Aliases[len(cmd.Aliases)-1] { + for i, alias := range cmd.Aliases { + if i > 0 { buf.WriteString(", ") } + buf.WriteString(fmt.Sprintf("`%s`", alias)) } buf.WriteString("\n") } From d3dbb4251fbec02299d08d89d61286d0675a8b4a Mon Sep 17 00:00:00 2001 From: "Linda L." Date: Fri, 25 Apr 2025 15:04:05 -0700 Subject: [PATCH 6/6] Update doc/md_docs.go Co-authored-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com> --- doc/md_docs.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/md_docs.go b/doc/md_docs.go index 40ae06bf..140d1523 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -73,14 +73,14 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) } if len(cmd.Aliases) > 0 { - buf.WriteString("Aliases: ") + buf.WriteString("Aliases: `") for i, alias := range cmd.Aliases { if i > 0 { - buf.WriteString(", ") + buf.WriteString("`, `") } - buf.WriteString(fmt.Sprintf("`%s`", alias)) + buf.WriteString(alias) } - buf.WriteString("\n") + buf.WriteString("`\n") } if len(cmd.Example) > 0 {