FilesExpand file tree

 trunk

/

github_template.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

135 lines (120 loc) · 3.52 KB

 trunk

/

github_template.go

Copy path

Top

File metadata and controls

• Code
• Blame

135 lines (120 loc) · 3.52 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

131

132

133

134

135

package githubtemplate

import (

"fmt"

"io/fs"

"os"

"path"

"regexp"

"sort"

"strings"

"gopkg.in/yaml.v3"

)

// FindNonLegacy returns the list of template file paths from the template folder (according to the "upgraded multiple template builder")

func FindNonLegacy(rootDir string, name string) []string {

results := []string{}

// https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

candidateDirs := []string{

path.Join(rootDir, ".github"),

rootDir,

path.Join(rootDir, "docs"),

}

mainLoop:

for _, dir := range candidateDirs {

files, err := os.ReadDir(dir)

if err != nil {

continue

}

// detect multiple templates in a subdirectory

for _, file := range files {

if strings.EqualFold(file.Name(), name) && file.IsDir() {

templates, err := os.ReadDir(path.Join(dir, file.Name()))

if err != nil {

break

}

for _, tf := range templates {

if strings.HasSuffix(tf.Name(), ".md") &&

file.Type() != fs.ModeSymlink {

results = append(results, path.Join(dir, file.Name(), tf.Name()))

}

}

if len(results) > 0 {

break mainLoop

}

break

}

}

}

sort.Strings(results)

return results

}

// FindLegacy returns the file path of the default(legacy) template

func FindLegacy(rootDir string, name string) string {

namePattern := regexp.MustCompile(fmt.Sprintf(`(?i)^%s(\.|$)`, strings.ReplaceAll(name, "_", "[_-]")))

// https://help.github.com/en/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

candidateDirs := []string{

path.Join(rootDir, ".github"),

rootDir,

path.Join(rootDir, "docs"),

}

for _, dir := range candidateDirs {

files, err := os.ReadDir(dir)

if err != nil {

continue

}

// detect a single template file

for _, file := range files {

if namePattern.MatchString(file.Name()) &&

!file.IsDir() &&

file.Type() != fs.ModeSymlink {

return path.Join(dir, file.Name())

}

}

}

return ""

}

// ExtractName returns the name of the template from YAML front-matter

func ExtractName(filePath string) string {

contents, err := os.ReadFile(filePath)

frontmatterBoundaries := detectFrontmatter(contents)

if err == nil && frontmatterBoundaries[0] == 0 {

templateData := struct {

Name string

}{}

if err := yaml.Unmarshal(contents[0:frontmatterBoundaries[1]], &templateData); err == nil && templateData.Name != "" {

return templateData.Name

}

}

return path.Base(filePath)

}

// ExtractTitle returns the title of the template from YAML front-matter

func ExtractTitle(filePath string) string {

contents, err := os.ReadFile(filePath)

frontmatterBoundaries := detectFrontmatter(contents)

if err == nil && frontmatterBoundaries[0] == 0 {

templateData := struct {

Title string

}{}

if err := yaml.Unmarshal(contents[0:frontmatterBoundaries[1]], &templateData); err == nil && templateData.Title != "" {

return templateData.Title

}

}

return ""

}

// ExtractContents returns the template contents without the YAML front-matter

func ExtractContents(filePath string) []byte {

contents, err := os.ReadFile(filePath)

if err != nil {

return []byte{}

}

if frontmatterBoundaries := detectFrontmatter(contents); frontmatterBoundaries[0] == 0 {

return contents[frontmatterBoundaries[1]:]

}

return contents

}

var yamlPattern = regexp.MustCompile(`(?m)^---\r?\n(\s*\r?\n)?`)

func detectFrontmatter(c []byte) []int {

if matches := yamlPattern.FindAllIndex(c, 2); len(matches) > 1 {

return []int{matches[0][0], matches[1][1]}

}

return []int{-1, -1}

}