/
gen_doc.go
64 lines (55 loc) · 1.78 KB
/
gen_doc.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
// Copyright © 2021 Alibaba Group Holding Ltd.
//
// 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 cmd
import (
"fmt"
"os"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
// GenDocCommand is used to implement 'gen-doc' command.
type GenDocCommand struct {
cmd *cobra.Command
// path is the destination path of generated markdown documents.
path string
}
func init() {
genDocCommand := &GenDocCommand{}
genDocCommand.cmd = &cobra.Command{
Use: "gen-doc",
Short: "Generate document for sealer CLI with MarkDown format",
Args: cobra.NoArgs,
SilenceErrors: true,
SilenceUsage: true,
RunE: func(cmd *cobra.Command, args []string) error {
return genDocCommand.runGenDoc()
},
}
genDocCommand.addFlags()
rootCmd.AddCommand(genDocCommand.cmd)
}
// addFlags adds flags for specific command.
func (g *GenDocCommand) addFlags() {
flagSet := g.cmd.Flags()
flagSet.StringVarP(&g.path, "path", "p", "/tmp", "destination path of generated markdown documents")
}
func (g *GenDocCommand) runGenDoc() error {
if _, err := os.Stat(g.path); err != nil {
if os.IsNotExist(err) {
return fmt.Errorf("path %s does not exits, please check your gen-doc input flag --path", g.path)
}
return err
}
return doc.GenMarkdownTree(g.cmd.Parent(), g.path)
}