BlueGit

timfa bluegit

Files

bluegit / internal / desctpl / desctpl.go

desctpl.go

feat: lees .bluegit-sjablonen en klikbare takenlijsten
timfa project_87923614_bot_3aff574f6f98414b945a8799374f9092 · pushed by timfa · 3 weeks ago
79722e46 History
desctpl.go 5.3 KiB Download Raw
1// Package desctpl leest beschrijvingssjablonen uit de standaardbranch
2// en vult de variabelen van een merge request in.
3package desctpl
4
5import (
6 "context"
7 "regexp"
8 "sort"
9 "strings"
10
11 "gitlab.com/Timfa/bluegit/internal/gitrepo"
12)
13
14// Template is één Markdown-bestand zonder het achtervoegsel .md.
15type Template struct {
16 Name string
17 Body string
18}
19
20// Commit is een bericht op de bronbranch, oudste eerst.
21type Commit struct {
22 Subject string
23 Body string
24 Author string
25 Email string
26 Merge bool
27}
28
29// Vars zijn de waarden voor %{...} bij het aanmaken van een merge request.
30type Vars struct {
31 Source string
32 Target string
33 Commits []Commit
34}
35
36const hugeBody = 10000
37
38var (
39 closesBranch = regexp.MustCompile(`^(\d+)-`)
40 coAuthor = regexp.MustCompile(`(?m)^Co-authored-by: .+$`)
41)
42
43// List leest .bluegit/<kind>_templates en valt terug op .gitlab/.
44// Een gelijke naam uit .bluegit wint. kind is issue of mr.
45func List(ctx context.Context, gitBin, dir, rev, kind string) ([]Template, error) {
46 sub, err := subdir(kind)
47 if err != nil {
48 return nil, err
49 }
50 found := map[string]Template{}
51 var order []string
52 for _, root := range []string{".bluegit", ".gitlab"} {
53 entries, err := gitrepo.Tree(ctx, gitBin, dir, rev, root+"/"+sub)
54 if err != nil {
55 continue
56 }
57 for _, e := range entries {
58 if e.Type != "blob" || !strings.HasSuffix(e.Name, ".md") {
59 continue
60 }
61 name := strings.TrimSuffix(e.Name, ".md")
62 if !validName(name) {
63 continue
64 }
65 if _, ok := found[name]; ok {
66 continue
67 }
68 text, binary, err := gitrepo.Blob(ctx, gitBin, dir, rev, root+"/"+sub+"/"+e.Name, 100000)
69 if err != nil || binary {
70 continue
71 }
72 if len(text) > 20000 {
73 text = text[:20000]
74 }
75 found[name] = Template{Name: name, Body: text}
76 order = append(order, name)
77 }
78 }
79 list := make([]Template, 0, len(order))
80 for _, name := range order {
81 list = append(list, found[name])
82 }
83 sort.SliceStable(list, func(i, j int) bool {
84 di := strings.EqualFold(list[i].Name, "Default")
85 dj := strings.EqualFold(list[j].Name, "Default")
86 if di != dj {
87 return di
88 }
89 return strings.ToLower(list[i].Name) < strings.ToLower(list[j].Name)
90 })
91 return list, nil
92}
93
94// Find zoekt een sjabloon op naam. Een hoofdletterverschil telt alleen als er één kandidaat is.
95func Find(list []Template, name string) (Template, bool) {
96 name = strings.TrimSpace(name)
97 if name == "" {
98 return Template{}, false
99 }
100 for _, t := range list {
101 if t.Name == name {
102 return t, true
103 }
104 }
105 var hit Template
106 n := 0
107 for _, t := range list {
108 if strings.EqualFold(t.Name, name) {
109 hit = t
110 n++
111 }
112 }
113 if n == 1 {
114 return hit, true
115 }
116 return Template{}, false
117}
118
119// Default is Default.md, ongeacht hoofdletters. Een exacte naam wint.
120func Default(list []Template) (Template, bool) {
121 var loose Template
122 looseOK := false
123 for _, t := range list {
124 if t.Name == "Default" {
125 return t, true
126 }
127 if !looseOK && strings.EqualFold(t.Name, "Default") {
128 loose = t
129 looseOK = true
130 }
131 }
132 return loose, looseOK
133}
134
135// Expand vervangt de variabelen. Een merge-commit en een heel lang bericht
136// tellen niet mee voor de commitlijsten. Er worden hooguit 100 commits gebruikt.
137func Expand(body string, v Vars) string {
138 commits := v.Commits
139 if len(commits) > 100 {
140 commits = commits[:100]
141 }
142 repl := map[string]string{
143 "%{source_branch}": v.Source,
144 "%{target_branch}": v.Target,
145 "%{first_commit}": firstCommit(commits),
146 "%{all_commits}": allCommits(commits),
147 "%{co_authored_by}": coAuthored(commits),
148 "%{first_multiline_commit}": firstMultiline(commits),
149 "%{closes_issue}": closesIssue(v.Source),
150 }
151 for token, value := range repl {
152 body = strings.ReplaceAll(body, token, value)
153 }
154 return body
155}
156
157func closesIssue(branch string) string {
158 m := closesBranch.FindStringSubmatch(branch)
159 if m == nil {
160 return ""
161 }
162 return "Closes #" + m[1]
163}
164
165func usable(c Commit) bool {
166 return !c.Merge && len(c.Subject) <= hugeBody && len(c.Body) <= hugeBody
167}
168
169func message(c Commit) string {
170 if c.Body == "" {
171 return c.Subject
172 }
173 return c.Subject + "\n\n" + c.Body
174}
175
176func firstCommit(commits []Commit) string {
177 for _, c := range commits {
178 if usable(c) {
179 return message(c)
180 }
181 }
182 return ""
183}
184
185func firstMultiline(commits []Commit) string {
186 for _, c := range commits {
187 if usable(c) && c.Body != "" {
188 return message(c)
189 }
190 }
191 return ""
192}
193
194func allCommits(commits []Commit) string {
195 var parts []string
196 for _, c := range commits {
197 if !usable(c) {
198 continue
199 }
200 parts = append(parts, message(c))
201 }
202 return strings.Join(parts, "\n\n")
203}
204
205func coAuthored(commits []Commit) string {
206 seen := map[string]bool{}
207 var lines []string
208 for _, c := range commits {
209 if len(c.Body) > hugeBody {
210 continue
211 }
212 for _, line := range coAuthor.FindAllString(c.Body, -1) {
213 if seen[line] {
214 continue
215 }
216 seen[line] = true
217 lines = append(lines, line)
218 }
219 }
220 return strings.Join(lines, "\n")
221}
222
223func subdir(kind string) (string, error) {
224 switch kind {
225 case "issue":
226 return "issue_templates", nil
227 case "mr":
228 return "merge_request_templates", nil
229 default:
230 return "", errKind
231 }
232}
233
234type kindError struct{}
235
236func (kindError) Error() string { return "onbekend sjabloon" }
237
238var errKind kindError
239
240func validName(name string) bool {
241 if name == "" || name == "." || name == ".." {
242 return false
243 }
244 return !strings.ContainsAny(name, "/\\")
245}