/
gen-cli-doc.go
102 lines (85 loc) · 2.9 KB
/
gen-cli-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
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
90
91
92
93
94
95
96
97
98
99
100
101
102
// Copyright 2019 The Operator-SDK 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 main
import (
"fmt"
"os"
"path"
"path/filepath"
"strings"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
"github.com/operator-framework/operator-sdk/internal/cmd/operator-sdk/cli"
)
const fmTemplate = `---
title: "%s"
---
`
func main() {
currentDir, err := os.Getwd()
if err != nil {
log.Fatalf("Failed to get current directory: %v", err)
}
cliDocsPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli")
_, cliRoot := cli.GetPluginsCLIAndRoot()
cliRoot.DisableAutoGenTag = true
recreateDocDir(cliRoot, cliDocsPath)
}
// htmlFormatter will replace angular brackets (`<` and `>`) with its character entitites
// `<` and `>`
func htmlFormatter(rootCmd *cobra.Command) {
for _, cmds := range rootCmd.Commands() {
if len(cmds.Commands()) > 0 {
htmlFormatter(cmds)
}
cmds.Long = strings.ReplaceAll(cmds.Long, "<", "<")
cmds.Long = strings.ReplaceAll(cmds.Long, ">", ">")
}
}
// recreateDocDir removes and recreates the CLI doc directory for rootCmd
// at docPath to ensure that stale files (e.g. from renamed or removed CLI subcommands)
// are removed.
func recreateDocDir(rootCmd *cobra.Command, docPath string) {
currentDir, err := os.Getwd()
if err != nil {
log.Fatalf("Failed to get current directory: %v", err)
}
if err := os.Rename(docPath+"/_index.md", currentDir+"/tmp_index.md"); err != nil {
log.Fatalf("Failed to move existing index: %v", err)
}
if err := os.RemoveAll(docPath); err != nil {
log.Fatalf("Failed to remove existing generated docs: %v", err)
}
if err := os.MkdirAll(docPath, 0755); err != nil {
log.Fatalf("Failed to re-create docs directory: %v", err)
}
filePrepender := func(filename string) string {
name := filepath.Base(filename)
base := strings.TrimSuffix(name, path.Ext(name))
return fmt.Sprintf(fmTemplate, strings.Replace(base, "_", " ", -1))
}
linkHandler := func(name string) string {
base := strings.TrimSuffix(name, path.Ext(name))
return "../" + base
}
htmlFormatter(rootCmd)
err = doc.GenMarkdownTreeCustom(rootCmd, docPath, filePrepender, linkHandler)
if err != nil {
log.Fatalf("Failed to generate documentation: %v", err)
}
if err := os.Rename(currentDir+"/tmp_index.md", docPath+"/_index.md"); err != nil {
log.Fatalf("Failed to move existing index: %v", err)
}
}