-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #83 from juju/JUJU-2217_support_extended_help
[JUJU-2217] Extended help documentation command
- Loading branch information
Showing
6 changed files
with
274 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,229 @@ | ||
| // Copyright 2012-2022 Canonical Ltd. | ||
| // Licensed under the LGPLv3, see LICENSE file for details. | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "fmt" | ||
| "os" | ||
| "sort" | ||
| "strings" | ||
|
|
||
| "github.com/juju/gnuflag" | ||
| ) | ||
|
|
||
| var doc string = ` | ||
| This command generates a markdown formatted document with all the commands, their descriptions, arguments, and examples. | ||
| ` | ||
|
|
||
| type documentationCommand struct { | ||
| CommandBase | ||
| super *SuperCommand | ||
| out string | ||
| noIndex bool | ||
| } | ||
|
|
||
| func newDocumentationCommand(s *SuperCommand) *documentationCommand { | ||
| return &documentationCommand{super: s} | ||
| } | ||
|
|
||
| func (c *documentationCommand) Info() *Info { | ||
| return &Info{ | ||
| Name: "documentation", | ||
| Args: "--out <target-file> --noindex", | ||
| Purpose: "Generate the documentation for all commands", | ||
| Doc: doc, | ||
| } | ||
| } | ||
|
|
||
| // SetFlags adds command specific flags to the flag set. | ||
| func (c *documentationCommand) SetFlags(f *gnuflag.FlagSet) { | ||
| f.StringVar(&c.out, "out", "", "Documentation output file") | ||
| f.BoolVar(&c.noIndex, "no-index", false, "Do not generate the commands index") | ||
| } | ||
|
|
||
| func (c *documentationCommand) Run(ctx *Context) error { | ||
| var writer *bufio.Writer | ||
| if c.out != "" { | ||
| f, err := os.Create(c.out) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer f.Close() | ||
| writer = bufio.NewWriter(f) | ||
| } else { | ||
| writer = bufio.NewWriter(ctx.Stdout) | ||
| } | ||
| return c.dumpEntries(writer) | ||
| } | ||
|
|
||
| func (c *documentationCommand) dumpEntries(writer *bufio.Writer) error { | ||
| if len(c.super.subcmds) == 0 { | ||
| fmt.Printf("No commands found for %s", c.super.Name) | ||
| return nil | ||
| } | ||
|
|
||
| // sort the commands | ||
| sorted := make([]string, len(c.super.subcmds)) | ||
| i := 0 | ||
| for k := range c.super.subcmds { | ||
| sorted[i] = k | ||
| i++ | ||
| } | ||
| sort.Strings(sorted) | ||
|
|
||
| if !c.noIndex { | ||
| _, err := writer.WriteString(c.commandsIndex(sorted)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| var err error | ||
| for _, nameCmd := range sorted { | ||
| _, err = writer.WriteString(c.formatCommand(c.super.subcmds[nameCmd])) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (c *documentationCommand) commandsIndex(listCommands []string) string { | ||
| index := "# Index\n" | ||
| for id, name := range listCommands { | ||
| index += fmt.Sprintf("%d. [%s](#%s)\n", id, name, name) | ||
| } | ||
| index += "---\n\n" | ||
| return index | ||
| } | ||
|
|
||
| func (c *documentationCommand) formatCommand(ref commandReference) string { | ||
| formatted := "# " + strings.ToUpper(ref.name) + "\n" | ||
| if ref.alias != "" { | ||
| formatted += "**Alias:** " + ref.alias + "\n" | ||
| } | ||
| if ref.check != nil && ref.check.Obsolete() { | ||
| formatted += "*This command is deprecated*\n" | ||
| } | ||
| formatted += "\n" | ||
|
|
||
| // Description | ||
| formatted += "## Summary\n" + ref.command.Info().Purpose + "\n\n" | ||
|
|
||
| // Usage | ||
| if ref.command.Info().Args != "" { | ||
| formatted += "## Usage\n```" + ref.command.Info().Args + "```\n\n" | ||
| } | ||
|
|
||
| // Options | ||
| formattedFlags := c.formatFlags(ref.command) | ||
| if len(formattedFlags) > 0 { | ||
| formatted += "## Options\n" + formattedFlags + "\n" | ||
| } | ||
|
|
||
| // Description | ||
| doc := ref.command.Info().Doc | ||
| if doc != "" { | ||
| formatted += "## Description\n" + ref.command.Info().Doc + "\n\n" | ||
| } | ||
|
|
||
| // Examples | ||
| if len(ref.command.Info().Examples) > 0 { | ||
| formatted += "## Examples\n" | ||
| for _, e := range ref.command.Info().Examples { | ||
| formatted += "`" + e + "`\n" | ||
| } | ||
| formatted += "\n" | ||
| } | ||
|
|
||
| // See Also | ||
| if len(ref.command.Info().SeeAlso) > 0 { | ||
| formatted += "## See Also\n" | ||
| for _, s := range ref.command.Info().SeeAlso { | ||
| formatted += fmt.Sprintf("[%s](#%s)\n", s, s) | ||
| } | ||
| formatted += "\n" | ||
| } | ||
|
|
||
| formatted += "---\n" | ||
|
|
||
| return formatted | ||
|
|
||
| } | ||
|
|
||
| // formatFlags is an internal formatting solution similar to | ||
| // the gnuflag.PrintDefaults. The code is extended here | ||
| // to permit additional formatting without modifying the | ||
| // gnuflag package. | ||
| func (d *documentationCommand) formatFlags(c Command) string { | ||
| flagsAlias := FlagAlias(c, "") | ||
| if flagsAlias == "" { | ||
| // For backward compatibility, the default is 'flag'. | ||
| flagsAlias = "flag" | ||
| } | ||
| f := gnuflag.NewFlagSetWithFlagKnownAs(c.Info().Name, gnuflag.ContinueOnError, flagsAlias) | ||
| c.SetFlags(f) | ||
|
|
||
| // group together all flags for a given value | ||
| flags := make(map[interface{}]flagsByLength) | ||
| f.VisitAll(func(f *gnuflag.Flag) { | ||
| flags[f.Value] = append(flags[f.Value], f) | ||
| }) | ||
|
|
||
| // sort the output flags by shortest name for each group. | ||
| var byName flagsByName | ||
| for _, fl := range flags { | ||
| sort.Sort(fl) | ||
| byName = append(byName, fl) | ||
| } | ||
| sort.Sort(byName) | ||
|
|
||
| formatted := "| Flag | Default | Usage |\n" | ||
| formatted += "| --- | --- | --- |\n" | ||
| for _, fs := range byName { | ||
| theFlags := "" | ||
| for i, f := range fs { | ||
| if i > 0 { | ||
| theFlags += ", " | ||
| } | ||
| theFlags += fmt.Sprintf("`--%s`", f.Name) | ||
| } | ||
| formatted += fmt.Sprintf("| %s | %s | %s |\n", theFlags, fs[0].DefValue, fs[0].Usage) | ||
| } | ||
| return formatted | ||
| } | ||
|
|
||
| // flagsByLength is a slice of flags implementing sort.Interface, | ||
| // sorting primarily by the length of the flag, and secondarily | ||
| // alphabetically. | ||
| type flagsByLength []*gnuflag.Flag | ||
|
|
||
| func (f flagsByLength) Less(i, j int) bool { | ||
| s1, s2 := f[i].Name, f[j].Name | ||
| if len(s1) != len(s2) { | ||
| return len(s1) < len(s2) | ||
| } | ||
| return s1 < s2 | ||
| } | ||
| func (f flagsByLength) Swap(i, j int) { | ||
| f[i], f[j] = f[j], f[i] | ||
| } | ||
| func (f flagsByLength) Len() int { | ||
| return len(f) | ||
| } | ||
|
|
||
| // flagsByName is a slice of slices of flags implementing sort.Interface, | ||
| // alphabetically sorting by the name of the first flag in each slice. | ||
| type flagsByName [][]*gnuflag.Flag | ||
|
|
||
| func (f flagsByName) Less(i, j int) bool { | ||
| return f[i][0].Name < f[j][0].Name | ||
| } | ||
| func (f flagsByName) Swap(i, j int) { | ||
| f[i], f[j] = f[j], f[i] | ||
| } | ||
| func (f flagsByName) Len() int { | ||
| return len(f) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters