11package main
22
33import (
4+ "encoding/json"
45 "fmt"
56 "os"
6- "strings"
7- "encoding/json"
87 "regexp"
8+ "strings"
99
1010 "text/template"
1111 // "sort"
@@ -17,7 +17,7 @@ import (
1717
1818var fileName string
1919var rootCmd = & cobra.Command {
20- Use : "doc-gen" ,
20+ Use : "doc-gen" ,
2121 Short : "Generate the documentation for the sl plugin" ,
2222 RunE : func (Cmd * cobra.Command , args []string ) error {
2323 CliDocs ()
@@ -39,33 +39,31 @@ func checkError(err error) {
3939
4040// For top level commands, like `sl account` or `sl hardware`
4141type SlCmdGroup struct {
42- Name string
42+ Name string
4343 CommandShortLink string
44- Commands []SlCmdDoc
45- Help string
44+ Commands []SlCmdDoc
45+ Help string
4646}
4747
4848// For specific commands
4949type SlCmdDoc struct {
50- Name string
50+ Name string
5151 CommandShortLink string
52- Use string
53- Flags []SlCmdFlag
54- Help string
55- LongHelp string
56- Backtick string
57- CommandPath string
52+ Use string
53+ Flags []SlCmdFlag
54+ Help string
55+ LongHelp string
56+ Backtick string
57+ CommandPath string
5858}
5959
6060// For a commands flags
6161type SlCmdFlag struct {
62- Name string
63- Help string
62+ Name string
63+ Help string
6464 Default string
6565}
6666
67-
68-
6967// This function builds the documentation for IBMCLOUD docs
7068func CliDocs () {
7169 // fmt.Printf("IBMCLOUD SL Command Directory\n")
@@ -75,11 +73,10 @@ func CliDocs() {
7573 shortName := strings .ReplaceAll (iCmd .Name (), " " , "_" )
7674 shortName = strings .ReplaceAll (iCmd .Name (), "-" , "_" )
7775 thisCmdGroup := SlCmdGroup {
78- Name : iCmd .Name (),
76+ Name : iCmd .Name (),
7977 CommandShortLink : fmt .Sprintf ("sl_%v" , shortName ),
80- Commands : nil ,
81- Help : iCmd .Short ,
82-
78+ Commands : nil ,
79+ Help : iCmd .Short ,
8380 }
8481 if len (iCmd .Commands ()) > 0 {
8582 thisCmdGroup .Commands = buildSlCmdDoc (iCmd )
@@ -93,7 +90,7 @@ func CliDocs() {
9390 jOut , err := json .MarshalIndent (CmdGroups , "" , " " )
9491 checkError (err )
9592 err = os .WriteFile ("sl.json" , jOut , 0755 ) //#nosec G306 -- This is a false positive
96- checkError (err )
93+ checkError (err )
9794 // fmt.Println(string(jOut))
9895}
9996
@@ -172,14 +169,14 @@ func cobraToSl(iCmd *cobra.Command, tlcmd string) SlCmdDoc {
172169 shortName = strings .ReplaceAll (shortName , "-" , "_" )
173170 longHelp := getLongHelp (iCmd .Long )
174171 thisDoc := SlCmdDoc {
175- Name : iCmd .Name (),
172+ Name : iCmd .Name (),
176173 CommandShortLink : shortName ,
177- CommandPath : iCmd .CommandPath (),
178- Use : iCmd .UseLine (),
179- Flags : nil ,
180- Help : iCmd .Short ,
181- LongHelp : longHelp ,
182- Backtick : "```" ,
174+ CommandPath : iCmd .CommandPath (),
175+ Use : iCmd .UseLine (),
176+ Flags : nil ,
177+ Help : iCmd .Short ,
178+ LongHelp : longHelp ,
179+ Backtick : "```" ,
183180 }
184181 thisDoc .Flags = buildSlCmdFlag (iCmd )
185182
@@ -196,8 +193,8 @@ func buildSlCmdFlag(topCommand *cobra.Command) []SlCmdFlag {
196193 flagName = fmt .Sprintf ("%s, %s" , pflag .Shorthand , flagName )
197194 }
198195 thisFlag := SlCmdFlag {
199- Name :flagName ,
200- Help : getFlagHelp (pflag .Usage ),
196+ Name : flagName ,
197+ Help : getFlagHelp (pflag .Usage ),
201198 Default : pflag .DefValue ,
202199 }
203200 flags = append (flags , thisFlag )
0 commit comments