-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
command.go
86 lines (78 loc) · 2.14 KB
/
command.go
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
// Copyright (c) 2019 The Jaeger Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package docs
import (
"flag"
"fmt"
"log"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
"github.com/spf13/viper"
)
const (
formatFlag = "format"
dirFlag = "dir"
)
var (
formats = []string{"md", "man", "rst", "yaml"}
)
// Command for generating flags/commands documentation.
// It generates the documentation for all commands starting at parent.
func Command(v *viper.Viper) *cobra.Command {
c := &cobra.Command{
Use: "docs",
Short: "Generates documentation",
Long: `Generates command and flags documentation`,
RunE: func(cmd *cobra.Command, args []string) error {
for cmd.Parent() != nil {
cmd = cmd.Parent()
}
dir := v.GetString(dirFlag)
log.Printf("Generating documentation in %v", dir)
switch v.GetString(formatFlag) {
case "md":
return doc.GenMarkdownTree(cmd, dir)
case "man":
return genMan(cmd, dir)
case "rst":
return doc.GenReSTTree(cmd, dir)
case "yaml":
return doc.GenYamlTree(cmd, dir)
default:
return fmt.Errorf("undefined value of %v, possible values are: %v", formatFlag, formats)
}
},
}
c.Flags().AddGoFlagSet(flags(&flag.FlagSet{}))
v.BindPFlags(c.Flags())
return c
}
func flags(flagSet *flag.FlagSet) *flag.FlagSet {
flagSet.String(
formatFlag,
formats[0],
fmt.Sprintf("Supported formats: %v.", formats))
flagSet.String(
dirFlag,
"./",
"Directory where generate the documentation.")
return flagSet
}
func genMan(cmd *cobra.Command, dir string) error {
header := &doc.GenManHeader{
Title: cmd.Use,
Section: "1",
}
return doc.GenManTree(cmd, header, dir)
}