|
| 1 | +package main |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "os" |
| 6 | + "strings" |
| 7 | + "encoding/json" |
| 8 | + "regexp" |
| 9 | + |
| 10 | + "text/template" |
| 11 | + // "sort" |
| 12 | + "github.com/spf13/cobra" |
| 13 | + "github.com/spf13/pflag" |
| 14 | + // "github.com/IBM-Cloud/ibm-cloud-cli-sdk/plugin" |
| 15 | + sl_plugin "github.ibm.com/SoftLayer/softlayer-cli/plugin" |
| 16 | +) |
| 17 | + |
| 18 | +var fileName string |
| 19 | +var rootCmd = &cobra.Command{ |
| 20 | + Use: "doc-gen", |
| 21 | + Short: "Generate the documentation for the sl plugin", |
| 22 | + RunE: func(Cmd *cobra.Command, args []string) error { |
| 23 | + CliDocs() |
| 24 | + return nil |
| 25 | + }, |
| 26 | +} |
| 27 | + |
| 28 | +func main() { |
| 29 | + err := rootCmd.Execute() |
| 30 | + checkError(err) |
| 31 | + return |
| 32 | +} |
| 33 | + |
| 34 | +func checkError(err error) { |
| 35 | + if err != nil { |
| 36 | + panic(err) |
| 37 | + } |
| 38 | +} |
| 39 | + |
| 40 | +// For top level commands, like `sl account` or `sl hardware` |
| 41 | +type SlCmdGroup struct { |
| 42 | + Name string |
| 43 | + CommandShortLink string |
| 44 | + Commands []SlCmdDoc |
| 45 | + Help string |
| 46 | +} |
| 47 | + |
| 48 | +// For specific commands |
| 49 | +type SlCmdDoc struct { |
| 50 | + Name string |
| 51 | + CommandShortLink string |
| 52 | + Use string |
| 53 | + Flags []SlCmdFlag |
| 54 | + Help string |
| 55 | + LongHelp string |
| 56 | + Backtick string |
| 57 | + CommandPath string |
| 58 | +} |
| 59 | + |
| 60 | +// For a commands flags |
| 61 | +type SlCmdFlag struct { |
| 62 | + Name string |
| 63 | + Help string |
| 64 | + Default string |
| 65 | +} |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +// This function builds the documentation for IBMCLOUD docs |
| 70 | +func CliDocs() { |
| 71 | + // fmt.Printf("IBMCLOUD SL Command Directory\n") |
| 72 | + SlCommands := sl_plugin.GetTopCobraCommand(nil, nil) |
| 73 | + CmdGroups := []SlCmdGroup{} |
| 74 | + for _, iCmd := range SlCommands.Commands() { |
| 75 | + shortName := strings.ReplaceAll(iCmd.Name(), " ", "_") |
| 76 | + shortName = strings.ReplaceAll(iCmd.Name(), "-", "_") |
| 77 | + thisCmdGroup := SlCmdGroup{ |
| 78 | + Name: iCmd.Name(), |
| 79 | + CommandShortLink: fmt.Sprintf("sl_%v", shortName), |
| 80 | + Commands: nil, |
| 81 | + Help: iCmd.Short, |
| 82 | + |
| 83 | + } |
| 84 | + if len(iCmd.Commands()) > 0 { |
| 85 | + thisCmdGroup.Commands = buildSlCmdDoc(iCmd) |
| 86 | + } else { |
| 87 | + // This is a single command, like 'call-api' and doesn't have sub-commands |
| 88 | + thisCmdGroup.Commands = []SlCmdDoc{cobraToSl(iCmd, "")} |
| 89 | + } |
| 90 | + PrintMakrdown(thisCmdGroup) |
| 91 | + CmdGroups = append(CmdGroups, thisCmdGroup) |
| 92 | + } |
| 93 | + jOut, err := json.MarshalIndent(CmdGroups, "", " ") |
| 94 | + checkError(err) |
| 95 | + err = os.WriteFile("sl.json", jOut, 0755) //#nosec G306 -- This is a false positive |
| 96 | + checkError(err) |
| 97 | + // fmt.Println(string(jOut)) |
| 98 | +} |
| 99 | + |
| 100 | +// Generates the Markdown |
| 101 | +func PrintMakrdown(cmd SlCmdGroup) { |
| 102 | + |
| 103 | + var cmdTemplate = `<!-- THIS FILE IS AUTOMATICALLY GENERATED, DO NOT EDIT --> |
| 104 | +<!-- markdownlint-disable first-heading-h1 lastupdated-misformat-or-missing frontmatter-yaml --> |
| 105 | +{{range .Commands}} |
| 106 | +## ibmcloud {{.CommandPath}} |
| 107 | +{: #{{.CommandShortLink}}} |
| 108 | +
|
| 109 | +{{.Help}} |
| 110 | +
|
| 111 | +{{.LongHelp}} |
| 112 | +
|
| 113 | +{{.Backtick}}bash |
| 114 | +ibmcloud {{.Use}} |
| 115 | +{{.Backtick}} |
| 116 | +{: codeblock} |
| 117 | +
|
| 118 | +{{if .Flags}} |
| 119 | +**Command options**: |
| 120 | +{{range .Flags}} |
| 121 | +--{{.Name}} |
| 122 | +: {{.Help}} |
| 123 | +{{end}}{{end}}{{end}}` |
| 124 | + |
| 125 | + mdTemplate, err := template.New("cmd template").Parse(cmdTemplate) |
| 126 | + checkError(err) |
| 127 | + filename := fmt.Sprintf("%v.md", cmd.CommandShortLink) |
| 128 | + outfile, err := os.Create(filename) //#nosec G304 -- This is a false positive |
| 129 | + defer outfile.Close() |
| 130 | + err = mdTemplate.Execute(outfile, cmd) |
| 131 | + checkError(err) |
| 132 | + |
| 133 | +} |
| 134 | + |
| 135 | +func getLongHelp(helpString string) string { |
| 136 | + // Removes some ugly empty lines sometimes. |
| 137 | + empty_line := regexp.MustCompile(`(?m)^(\t)+$`) |
| 138 | + helpString = empty_line.ReplaceAllString(helpString, "") |
| 139 | + helpString = strings.ReplaceAll(helpString, "${COMMAND_NAME}", "ibmcloud") |
| 140 | + example_regex := regexp.MustCompile(`(?i)Example:+`) |
| 141 | + helpString = example_regex.ReplaceAllString(helpString, "**Examples**:\n") |
| 142 | + // for 'indented-by-two' |
| 143 | + indent_regex := regexp.MustCompile(`(?m)^ {2}(\S)`) |
| 144 | + helpString = indent_regex.ReplaceAllString(helpString, " $1") |
| 145 | + |
| 146 | + return getFlagHelp(helpString) |
| 147 | +} |
| 148 | + |
| 149 | +func getFlagHelp(helpString string) string { |
| 150 | + // for 'no-inline-html' errors |
| 151 | + fake_html_regex := regexp.MustCompile(`<([0-9A-Za-z_\-\.\s]+)>`) |
| 152 | + helpString = fake_html_regex.ReplaceAllString(helpString, "$1") |
| 153 | + // for 'no-reversed-links' |
| 154 | + fake_link_regex := regexp.MustCompile(`\)\[`) |
| 155 | + helpString = fake_link_regex.ReplaceAllString(helpString, ") [") |
| 156 | + return helpString |
| 157 | +} |
| 158 | + |
| 159 | +func buildSlCmdDoc(topCommand *cobra.Command) []SlCmdDoc { |
| 160 | + docs := []SlCmdDoc{} |
| 161 | + for _, iCmd := range topCommand.Commands() { |
| 162 | + thisDoc := cobraToSl(iCmd, topCommand.Name()) |
| 163 | + docs = append(docs, thisDoc) |
| 164 | + } |
| 165 | + return docs |
| 166 | +} |
| 167 | + |
| 168 | +func cobraToSl(iCmd *cobra.Command, tlcmd string) SlCmdDoc { |
| 169 | + |
| 170 | + shortName := fmt.Sprintf("sl_%s_%s", tlcmd, iCmd.Name()) |
| 171 | + shortName = strings.ReplaceAll(shortName, " ", "_") |
| 172 | + shortName = strings.ReplaceAll(shortName, "-", "_") |
| 173 | + longHelp := getLongHelp(iCmd.Long) |
| 174 | + thisDoc := SlCmdDoc{ |
| 175 | + Name: iCmd.Name(), |
| 176 | + CommandShortLink: shortName, |
| 177 | + CommandPath: iCmd.CommandPath(), |
| 178 | + Use: iCmd.UseLine(), |
| 179 | + Flags: nil, |
| 180 | + Help: iCmd.Short, |
| 181 | + LongHelp: longHelp, |
| 182 | + Backtick: "```", |
| 183 | + } |
| 184 | + thisDoc.Flags = buildSlCmdFlag(iCmd) |
| 185 | + |
| 186 | + return thisDoc |
| 187 | + |
| 188 | +} |
| 189 | + |
| 190 | +func buildSlCmdFlag(topCommand *cobra.Command) []SlCmdFlag { |
| 191 | + flags := []SlCmdFlag{} |
| 192 | + flagSet := topCommand.Flags() |
| 193 | + flagSet.VisitAll(func(pflag *pflag.Flag) { |
| 194 | + flagName := pflag.Name |
| 195 | + if pflag.Shorthand != "" { |
| 196 | + flagName = fmt.Sprintf("%s, %s", pflag.Shorthand, flagName) |
| 197 | + } |
| 198 | + thisFlag := SlCmdFlag{ |
| 199 | + Name:flagName, |
| 200 | + Help: getFlagHelp(pflag.Usage), |
| 201 | + Default: pflag.DefValue, |
| 202 | + } |
| 203 | + flags = append(flags, thisFlag) |
| 204 | + }) |
| 205 | + return flags |
| 206 | +} |
0 commit comments