2024-08-13 14:53:26 +01:00
|
|
|
package usage
|
2024-05-23 18:06:49 +01:00
|
|
|
|
|
|
|
import (
|
|
|
|
"flag"
|
2024-06-25 12:39:39 +01:00
|
|
|
"slices"
|
2024-05-23 18:06:49 +01:00
|
|
|
"strings"
|
2024-08-23 02:35:30 +01:00
|
|
|
|
|
|
|
"codeflow.dananglin.me.uk/apollo/enbas/internal/info"
|
2024-05-23 18:06:49 +01:00
|
|
|
)
|
|
|
|
|
2024-08-13 14:53:26 +01:00
|
|
|
// ExecutorUsageFunc returns the function used to print a command's help page.
|
|
|
|
func ExecutorUsageFunc(name, summary string, flagset *flag.FlagSet) func() {
|
2024-05-23 18:06:49 +01:00
|
|
|
return func() {
|
|
|
|
var builder strings.Builder
|
|
|
|
|
2024-06-25 12:39:39 +01:00
|
|
|
builder.WriteString("SUMMARY:")
|
|
|
|
builder.WriteString("\n " + name + " - " + summary)
|
|
|
|
builder.WriteString("\n\nUSAGE:")
|
2024-08-23 02:35:30 +01:00
|
|
|
builder.WriteString("\n " + info.ApplicationName + " " + name)
|
2024-06-25 12:39:39 +01:00
|
|
|
|
|
|
|
flagMap := make(map[string]string)
|
2024-05-23 18:06:49 +01:00
|
|
|
|
|
|
|
flagset.VisitAll(func(f *flag.Flag) {
|
2024-06-25 12:39:39 +01:00
|
|
|
flagMap[f.Name] = f.Usage
|
2024-05-23 18:06:49 +01:00
|
|
|
})
|
|
|
|
|
2024-06-25 12:39:39 +01:00
|
|
|
if len(flagMap) > 0 {
|
|
|
|
flags := make([]string, len(flagMap))
|
|
|
|
ind := 0
|
|
|
|
|
|
|
|
for f := range flagMap {
|
|
|
|
flags[ind] = f
|
|
|
|
ind++
|
|
|
|
}
|
|
|
|
|
|
|
|
slices.Sort(flags)
|
|
|
|
|
|
|
|
builder.WriteString(" [flags]")
|
|
|
|
builder.WriteString("\n\nFLAGS:")
|
|
|
|
|
|
|
|
for _, value := range flags {
|
|
|
|
builder.WriteString("\n --" + value)
|
|
|
|
builder.WriteString("\n " + flagMap[value])
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-05-23 18:06:49 +01:00
|
|
|
builder.WriteString("\n")
|
|
|
|
|
|
|
|
w := flag.CommandLine.Output()
|
|
|
|
|
2024-06-25 12:39:39 +01:00
|
|
|
_, _ = w.Write([]byte(builder.String()))
|
2024-05-23 18:06:49 +01:00
|
|
|
}
|
|
|
|
}
|