init

Author: axetroy

README.md

@@ -0,0 +1,3 @@
+### Conventional Commit Parser
+
+This is a parser for [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

go.mod

@@ -0,0 +1,3 @@
+module github.com/release-lab/conventional-commit-parser
+
+go 1.17

parser.go

@@ -0,0 +1,224 @@
+package conventionalcommitparser
+
+// Conventional Commits specification
+// https://www.conventionalcommits.org/en/v1.0.0/
+
+import (
+	"regexp"
+	"strings"
+)
+
+type Message struct {
+	Header string
+	Body   string
+	Footer []string
+}
+
+type Header struct {
+	Type      string
+	Scope     string
+	Subject   string
+	Important bool
+}
+
+type Footer struct {
+	Tag     string
+	Title   string
+	Content string
+}
+
+var (
+	EMPTY_LINE_PATTERN    = regexp.MustCompile(`^\s*$`)
+	HEADER_PATTERN        = regexp.MustCompile(`^(?:fixup!\s*)?(\w*)(\(([\w\$\.\*/-]*)\))?(!?):\s(.*)$`)
+	FOOTER_PATTERN        = regexp.MustCompile(`^([\w\s\-]+):\s(.*)$`)
+	REVERT_HEADER_PATTERN = regexp.MustCompile(`^(?i)revert\s+(.*)$`)
+)
+
+func (m Message) GetHeader() Header {
+	headerMatchers := HEADER_PATTERN.FindStringSubmatch(m.Header)
+	revertHeaderMatchers := REVERT_HEADER_PATTERN.FindStringSubmatch(m.Header)
+	header := Header{}
+
+	if len(headerMatchers) != 0 { // conventional commit
+		header.Type = strings.ToLower(headerMatchers[1])
+		header.Scope = headerMatchers[3]
+		header.Important = headerMatchers[4] == "!"
+		header.Subject = headerMatchers[5]
+	} else if len(revertHeaderMatchers) != 0 { // revert commit
+		subject := strings.Trim(revertHeaderMatchers[1], "\"")
+		subject = strings.Trim(subject, "'")
+		header.Type = "revert"
+		header.Subject = subject
+	} else { // commom commit
+		header.Type = ""
+		header.Scope = ""
+		header.Subject = m.Header
+	}
+
+	return header
+}
+
+func (m Message) GetFooter() []Footer {
+	footers := make([]Footer, 0)
+
+	for _, m := range m.Footer {
+		lines := strings.Split(strings.ReplaceAll(m, "\r\n", "\n"), "\n")
+
+		footer := Footer{}
+
+		contents := make([]string, 0)
+
+	lineLoop:
+		for index, line := range lines {
+			if index == 0 {
+				matcher := FOOTER_PATTERN.FindStringSubmatch(line)
+
+				if len(matcher) == 0 {
+					footer.Tag = ""
+					footer.Title = line
+				} else {
+					footer.Tag = matcher[1]
+					footer.Title = matcher[2]
+				}
+				continue lineLoop
+			} else {
+				contents = append(contents, line)
+			}
+		}
+
+		footer.Content = strings.TrimSpace(strings.Join(contents, "\n"))
+
+		footers = append(footers, footer)
+	}
+
+	return footers
+}
+
+func (m Message) GetFooterField(tags ...string) *Footer {
+	footers := m.GetFooter()
+
+	for _, tag := range tags {
+		for _, f := range footers {
+			if strings.ToLower(f.Tag) == tag {
+				return &f
+			}
+		}
+	}
+
+	return nil
+}
+
+/**
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+
+fix: prevent racing of requests
+
+Introduce a request id and a reference to latest request. Dismiss
+incoming responses other than from latest request.
+
+Remove timeouts which were used to mitigate the racing issue but are
+obsolete now.
+
+BREAKING CHANGE: use `.use()` instea of `.load()`
+
+before:
+```javascript
+app.load({})
+```
+
+after:
+```javascript
+app.use({})
+```
+
+Reviewed-by: Z
+Refs: #123
+*/
+func ParseMessage(message string) Message {
+	var (
+		msg    Message
+		header string   = ""
+		body   []string = make([]string, 0)
+		footer []string = make([]string, 0)
+	)
+
+	lines := strings.Split(message, "\n")
+	index := 0
+
+	for {
+		// last break
+		if index >= len(lines) {
+			break
+		}
+
+		line := lines[index]
+
+		// The first line should be header
+		if index == 0 {
+			header = line
+			index++
+			continue
+		}
+
+		// The second line should be blank
+		if index == 1 {
+			index++
+			continue
+		}
+
+		previousLine := lines[index-1]
+
+		// parse body
+		if !FOOTER_PATTERN.MatchString(line) {
+			body = append(body, line)
+			index++
+			continue
+		} else {
+			// if previous line is blank. then should be body block end
+			// or previous line is a footer
+			if EMPTY_LINE_PATTERN.MatchString(previousLine) || FOOTER_PATTERN.MatchString(previousLine) {
+				footerContent := []string{line}
+
+				index++
+
+				// if this line is last line
+				if index >= len(lines) {
+					footer = append(footer, strings.TrimSpace(strings.Join(footerContent, "\n")))
+					continue
+				}
+
+			innerLoop:
+				for {
+					if index >= len(lines) {
+						break innerLoop
+					}
+
+					line := lines[index]
+
+					if !FOOTER_PATTERN.MatchString(line) {
+						footerContent = append(footerContent, line)
+						index++
+						continue innerLoop
+					} else {
+						footer = append(footer, strings.TrimSpace(strings.Join(footerContent, "\n")))
+						break innerLoop
+					}
+				}
+			} else {
+				body = append(body, line)
+				index++
+				continue
+			}
+		}
+	}
+
+	msg.Header = header
+	msg.Body = strings.TrimSpace(strings.Join(body, "\n"))
+	msg.Footer = footer
+
+	return msg
+}