1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
package docs
import (
"fmt"
"log"
"net/url"
"os"
"strings"
"github.com/spf13/cobra"
"github.com/nicholas-fedor/shoutrrr/pkg/format"
"github.com/nicholas-fedor/shoutrrr/pkg/router"
"github.com/nicholas-fedor/shoutrrr/shoutrrr/cmd"
)
var (
serviceRouter router.ServiceRouter
services = serviceRouter.ListServices()
)
var Cmd = &cobra.Command{
Use: "docs",
Short: "Print documentation for services",
Run: Run,
Args: func(cmd *cobra.Command, args []string) error {
serviceList := strings.Join(services, ", ")
cmd.SetUsageTemplate(
cmd.UsageTemplate() + "\nAvailable services: \n " + serviceList + "\n",
)
return cobra.MinimumNArgs(1)(cmd, args)
},
ValidArgs: services,
}
func init() {
Cmd.Flags().StringP("format", "f", "console", "Output format")
}
func Run(cmd *cobra.Command, args []string) {
format, _ := cmd.Flags().GetString("format")
res := printDocs(format, args)
if res.ExitCode != 0 {
fmt.Fprintf(os.Stderr, "%s", res.Message)
}
os.Exit(res.ExitCode)
}
func printDocs(docFormat string, services []string) cmd.Result {
var renderer format.TreeRenderer
switch docFormat {
case "console":
renderer = format.ConsoleTreeRenderer{WithValues: false}
case "markdown":
renderer = format.MarkdownTreeRenderer{
HeaderPrefix: "### ",
PropsDescription: "Props can be either supplied using the params argument, or through the URL using \n`?key=value&key=value` etc.\n",
PropsEmptyMessage: "*The services does not support any query/param props*",
}
default:
return cmd.InvalidUsage("invalid format")
}
logger := log.New(os.Stderr, "", 0) // Concrete logger implementing types.StdLogger
for _, scheme := range services {
service, err := serviceRouter.NewService(scheme)
if err != nil {
return cmd.InvalidUsage("failed to init service: " + err.Error())
}
// Initialize the service to populate Config
dummyURL, _ := url.Parse(scheme + "://dummy@dummy.com")
if err := service.Initialize(dummyURL, logger); err != nil {
return cmd.InvalidUsage(
fmt.Sprintf("failed to initialize service %q: %v\n", scheme, err),
)
}
config := format.GetServiceConfig(service)
configNode := format.GetConfigFormat(config)
fmt.Fprint(os.Stdout, renderer.RenderTree(configNode, scheme), "\n")
}
return cmd.Success
}
|
