Merge pull request #31 from thaJeztah/full_alias

use full command as aliases

Author: thaJeztah

clidocstool.go

@@ -97,3 +97,19 @@ func copyFile(src string, dst string) error {
 	_, err = io.Copy(df, sf)
 	return err
 }
+
+func getAliases(cmd *cobra.Command) []string {
+	if len(cmd.Aliases) == 0 {
+		return cmd.Aliases
+	}
+
+	var parentPath string
+	if cmd.HasParent() {
+		parentPath = cmd.Parent().CommandPath() + " "
+	}
+	aliases := []string{cmd.CommandPath()}
+	for _, a := range cmd.Aliases {
+		aliases = append(aliases, parentPath+a)
+	}
+	return aliases
+}

clidocstool_md.go

@@ -155,11 +155,9 @@ func mdCmdOutput(cmd *cobra.Command, old string) (string, error) {
 		fmt.Fprintf(b, "%s\n\n", desc)
 	}
 
-	if len(cmd.Aliases) != 0 {
-		fmt.Fprintf(b, "### Aliases\n\n`%s`", cmd.Name())
-		for _, a := range cmd.Aliases {
-			fmt.Fprintf(b, ", `%s`", a)
-		}
+	if aliases := getAliases(cmd); len(aliases) != 0 {
+		fmt.Fprint(b, "### Aliases\n\n")
+		fmt.Fprint(b, "`"+strings.Join(aliases, "`, `")+"`")
 		fmt.Fprint(b, "\n\n")
 	}
 

clidocstool_yaml.go

@@ -150,7 +150,7 @@ func (c *Client) genYamlCustom(cmd *cobra.Command, w io.Writer) error {
 
 	cliDoc := cmdDoc{
 		Name:       cmd.CommandPath(),
-		Aliases:    strings.Join(cmd.Aliases, ", "),
+		Aliases:    strings.Join(getAliases(cmd), ", "),
 		Short:      forceMultiLine(cmd.Short, shortMaxWidth),
 		Long:       forceMultiLine(cmd.Long, longMaxWidth),
 		Example:    cmd.Example,

fixtures/buildx_build.md

@@ -5,7 +5,7 @@ Start a build
 
 ### Aliases
 
-`build`, `b`
+`docker buildx build`, `docker buildx b`
 
 ### Options
 

fixtures/docker_buildx_build.yaml

@@ -1,5 +1,5 @@
 command: docker buildx build
-aliases: b
+aliases: docker buildx build, docker buildx b
 short: Start a build
 long: Start a build
 usage: docker buildx build [OPTIONS] PATH | URL | -