feat!: allow characters in header as per spec

muthukrishnan24 · muthukrishnan24 · commit fd8c1c744f8c · 2021-08-11T19:22:09.000+05:30
allowed characters for type, scope and description as per spec test: add internal test case for parseHeader https://github.com/conventional-commits/parser#the-grammar
diff --git a/parser.go b/parser.go
@@ -44,7 +44,8 @@ func newFooterNote(token, value string) FooterNote {
 
 // Parse attempts to parse a commit message to a conventional commit
 func Parse(message string) (*Commit, error) {
-	messageLines := strings.Split(strings.TrimRight(message, "\n\t "), "\n")
+	message = strings.TrimRight(message, "\n\t ")
+	messageLines := strings.Split(message, "\n")
 
 	commit := &Commit{
 		FullCommit: message,
@@ -135,10 +136,14 @@ func parseLineAsFooter(line string) (key, value string) {
 
 // parseHeader attempts to parse the commit description line and set the appropriate values in the the given commit
 func parseHeader(header string, commit *Commit) error {
-	// allows /, \ in scope
-	headerRegexp := regexp.MustCompile(`^(?P<type>[A-Za-z]+)(?:\((?P<scope>[A-Za-z\/\\]+)\))?(?P<breaking>!)?: (?P<description>[\w| ]+)(?:\n\s*\n(?P<body>(?:.|\n)*)(?:\n\s+\n(?P<footers>(?:[A-Za-z-]+: (?:.|\n)*)|(?:BREAKING CHANGE: (?:.|\n)*)|(?:[A-Za-z]+ \#(?:.|\n)*)))?)?$`)
-	// TODO: comma separated multiple scopes?
+	// from https://github.com/conventional-commits/parser#the-grammar
+
+	// <header/summary> ::= <type>, "(", <scope>, ")", ["!"], ":", <whitespace>*, <text> <type>, ["!"], ":", <whitespace>*, <text>
+	// <type>  ::= <any UTF8-octets except newline or parens or ":" or "!:" or whitespace>+
+	// <scope> ::= <any UTF8-octets except newline or parens>+
 
+	headerRegexp := regexp.MustCompile(`^(?P<type>[^\n\(\)(:|!:| )]+)(?:\((?P<scope>[^\n\(\)]+)\))?(?P<breaking>!)?: (?P<description>[^\n]+)(?:\n\s*\n(?P<body>(?:.|\n)*)(?:\n\s+\n(?P<footers>(?:[A-Za-z-]+: (?:.|\n)*)|(?:BREAKING CHANGE: (?:.|\n)*)|(?:[A-Za-z]+ \#(?:.|\n)*)))?)?$`)
+	// TODO: comma separated multiple scopes?
 	matches := headerRegexp.FindStringSubmatch(header)
 	if matches == nil {
 		return fmt.Errorf("unable to parse commit header: %s", header)
diff --git a/parser_internal_test.go b/parser_internal_test.go
@@ -0,0 +1,55 @@
+package parser
+
+import (
+	"strconv"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestParseHeaderValid(t *testing.T) {
+	var validCases = []string{
+		`feat: description with name.txt`,
+		`feat: description with question?`,
+		`feat: description with numbers 1, 2, 3 and 4?`,
+		"feat: !@#$%^&*() ??>?///||| /\\", // just characters. why ?
+		"feat: 123 description \n\n body 1, 2, 3 and 4?",
+		"feat: ?123 description \n\n body 1, 2, 3 and 4?",
+		"feat: description with body 1, \n\n2, 3 and 4?",
+		"feat1234(@scope/scope1,scope2): description, \n\n body 1 2, 3 and 4?",
+		"1245#feat1234(@scope/scope1,scope2): description, \n\n body 1 2, 3 and 4?",
+	}
+
+	for index, validCase := range validCases {
+		testName := "case#" + strconv.Itoa(index+1)
+		t.Run(testName, func(innerT *testing.T) {
+			commit := &Commit{}
+			err := parseHeader(validCase, commit)
+			assert.NoError(innerT, err, validCase)
+		})
+	}
+}
+
+func TestParseHeaderInvalid(t *testing.T) {
+	var validCases = []string{
+		`feat:() description with name.txt`,
+		`feat:1 description with name.txt`,
+		`feat:! description with name.txt`,
+		`feat:A description with name.txt`,
+		`feat123:A description with name.txt`,
+		`feat!:A description with name.txt`,
+		`feat())!:A description with name.txt`,
+		`feat(scope1)!:A description with name.txt`,
+		`!feat(scope1)!:A description with name.txt`,
+		`feat(scope))!: A description with name.txt`,
+	}
+
+	for index, validCase := range validCases {
+		testName := "case#" + strconv.Itoa(index+1)
+		t.Run(testName, func(innerT *testing.T) {
+			commit := &Commit{}
+			err := parseHeader(validCase, commit)
+			assert.Error(innerT, err, validCase)
+		})
+	}
+}
