FilesExpand file tree

main

/

docs.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

130 lines (104 loc) · 2.95 KB

main

/

docs.go

Copy path

Top

File metadata and controls

• Code
• Blame

130 lines (104 loc) · 2.95 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

package cmd

import (

"crypto/sha256"

"fmt"

"io"

"io/fs"

"os"

"path/filepath"

"strings"

"github.com/spf13/cobra"

"github.com/spf13/cobra/doc"

"github.com/updatecli/updatecli/pkg/core/log"

)

// The docs command is a hidden sub-command that generates the documentation for www.updatecli.io

var (

docPrepender = func(s string) string {

header := "---\n"

name := filepath.Base(s)

name = strings.ReplaceAll(name, "_", " ")

name = strings.TrimSuffix(name, ".md")

header = header + fmt.Sprintf("title: %v\n", name)

header = header + fmt.Sprintf("description: Documentation for the command `%v`\n", name)

header = header + fmt.Sprintf("lead: Documentation for the command `%v`\n", name)

header = header + "draft: false\n"

header = header + "images: []\n"

header = header + "menu:\n docs:\n parent: \"commands\"\n"

header = header + "weight: 130\n"

header = header + "toc: true\n"

header = header + "---\n\n"

return header

}

linkhandler = func(s string) string {

s = strings.ToLower(s)

s = strings.TrimSuffix(s, ".md")

s = "/docs/commands/" + s

return s

}

docsDir string

docsCmd = &cobra.Command{

Use: "docs",

Hidden: true,

Short: "Generate updatecli documentation",

RunE: func(cmd *cobra.Command, args []string) error {

rootCmd.DisableAutoGenTag = true

before, err := snapshotDir(docsDir)

if err != nil {

return err

}

if err = doc.GenMarkdownTreeCustom(rootCmd, docsDir, docPrepender, linkhandler); err != nil {

return err

}

after, err := snapshotDir(docsDir)

if err != nil {

return err

}

for path, hash := range after {

if prev, exists := before[path]; !exists || prev != hash {

log.Infof("Documentation files updated in %q", docsDir)

os.Exit(2)

}

}

log.Infof("Documentation files already up to date in %q", docsDir)

return nil

},

}

)

func init() {

docsCmd.Flags().StringVarP(&docsDir, "docs", "d", "./docs", "Specify the directory where to generate documentation files")

}

// snapshotDir returns a map of file paths (relative to dir) to their SHA-256 hash.

// If the directory does not exist yet, an empty map is returned.

func snapshotDir(dir string) (map[string][sha256.Size]byte, error) {

hashes := make(map[string][sha256.Size]byte)

if _, err := os.Stat(dir); os.IsNotExist(err) {

return hashes, nil

}

// Opening dir as a root scopes every file access below to it, so a symlink

// swapped in while walking cannot make us read a file outside of dir.

root, err := os.OpenRoot(dir)

if err != nil {

return hashes, err

}

defer root.Close()

err = fs.WalkDir(root.FS(), ".", func(path string, d fs.DirEntry, err error) error {

if err != nil {

return err

}

if d.IsDir() {

return nil

}

f, err := root.Open(path)

if err != nil {

return err

}

defer f.Close()

h := sha256.New()

if _, err = io.Copy(h, f); err != nil {

return err

}

hashes[path] = [sha256.Size]byte(h.Sum(nil))

return nil

})

return hashes, err

}