0
0
mirror of https://github.com/thegeeklab/git-sv.git synced 2024-11-28 16:40:36 +00:00
git-sv/sv/formatter/formatter.go

92 lines
2.2 KiB
Go
Raw Normal View History

package formatter
import (
"bytes"
"sort"
"text/template"
"time"
"github.com/Masterminds/semver/v3"
2023-10-16 19:41:33 +00:00
"github.com/thegeeklab/git-sv/sv"
)
type releaseNoteTemplateVariables struct {
Release string
Tag string
Version *semver.Version
Date time.Time
Sections []sv.ReleaseNoteSection
AuthorNames []string
}
// OutputFormatter output formatter interface.
type OutputFormatter interface {
FormatReleaseNote(releasenote sv.ReleaseNote) ([]byte, error)
FormatChangelog(releasenotes []sv.ReleaseNote) ([]byte, error)
}
// BaseOutputFormatter formater for release note and changelog.
type BaseOutputFormatter struct {
templates *template.Template
}
// NewOutputFormatter TemplateProcessor constructor.
func NewOutputFormatter(tpls *template.Template) *BaseOutputFormatter {
return &BaseOutputFormatter{templates: tpls}
}
// FormatReleaseNote format a release note.
func (p BaseOutputFormatter) FormatReleaseNote(releasenote sv.ReleaseNote) ([]byte, error) {
2020-02-02 03:49:54 +00:00
var b bytes.Buffer
if err := p.templates.ExecuteTemplate(&b, "releasenotes-md.tpl", releaseNoteVariables(releasenote)); err != nil {
return b.Bytes(), err
2021-07-31 20:34:40 +00:00
}
2023-10-12 14:18:25 +00:00
return b.Bytes(), nil
2020-02-02 03:49:54 +00:00
}
2021-07-31 19:03:58 +00:00
// FormatChangelog format a changelog.
func (p BaseOutputFormatter) FormatChangelog(releasenotes []sv.ReleaseNote) ([]byte, error) {
2021-07-31 19:35:28 +00:00
templateVars := make([]releaseNoteTemplateVariables, len(releasenotes))
for i, v := range releasenotes {
templateVars[i] = releaseNoteVariables(v)
2020-02-02 03:49:54 +00:00
}
var b bytes.Buffer
if err := p.templates.ExecuteTemplate(&b, "changelog-md.tpl", templateVars); err != nil {
return b.Bytes(), err
2021-07-31 20:34:40 +00:00
}
2023-10-12 14:18:25 +00:00
return b.Bytes(), nil
2020-02-02 03:49:54 +00:00
}
func releaseNoteVariables(releasenote sv.ReleaseNote) releaseNoteTemplateVariables {
release := releasenote.Tag
if releasenote.Version != nil {
release = "v" + releasenote.Version.String()
}
2023-10-12 14:18:25 +00:00
2020-02-02 03:49:54 +00:00
return releaseNoteTemplateVariables{
Release: release,
Tag: releasenote.Tag,
Version: releasenote.Version,
Date: releasenote.Date,
Sections: releasenote.Sections,
AuthorNames: toSortedArray(releasenote.AuthorsNames),
}
}
func toSortedArray(input map[string]struct{}) []string {
result := make([]string, len(input))
i := 0
2023-10-12 14:18:25 +00:00
for k := range input {
result[i] = k
i++
}
2023-10-12 14:18:25 +00:00
sort.Strings(result)
2023-10-12 14:18:25 +00:00
return result
}