refactor: extract some code into functions to improve readability

and remove revert/Revert from the type list,
since they are already treated as special cases.

Author: JayceChant

validator/config.go

@@ -44,8 +44,6 @@ var (
 		"build":    {}, // build process 构建过程
 		"ci":       {}, // continuous integration 持续集成相关
 		"docker":   {}, // 容器相关
-		"revert":   {}, // 撤销以前的 commit
-		"Revert":   {}, // 有些工具生成的 revert 首字母大写
 	}
 	// TypesStr ...
 	TypesStr string

validator/validate.go

@@ -41,7 +41,7 @@ func getMsg(path string) string {
 	}
 
 	f, err := os.Stat(path)
-	if err != nil {
+	if err != nil && !os.IsExist(err) {
 		log.Println(err)
 		state.FileMissing.LogAndExit(path)
 	}
@@ -60,48 +60,55 @@ func getMsg(path string) string {
 	return string(buf)
 }
 
-func checkEmpty(str string) bool {
-	return strings.TrimSpace(str) == ""
-}
-
-func checkType(typ string) {
-	for t := range TypeSet {
-		if typ == t {
-			return
-		}
+func validateMsg(msg string, config *globalConfig) {
+	if isEmpty(msg) {
+		state.EmptyMessage.LogAndExit()
 	}
-	state.WrongType.LogAndExit(typ, TypesStr)
-}
 
-func checkScope(scope string, config *globalConfig) {
-	if checkEmpty(scope) {
-		if config.ScopeRequired {
-			state.ScopeMissing.LogAndExit()
-		}
-		return
+	isMergeCommit(msg)
+
+	sections := strings.SplitN(msg, "\n", 2)
+
+	if config.LineLimit <= 0 {
+		config.LineLimit = 80
 	}
 
-	if len(config.Scopes) == 0 {
-		return
+	checkHeader(sections[0], config)
+
+	if len(sections) == 2 {
+		checkBody(sections[1], config)
+	} else if config.BodyRequired {
+		state.BodyMissing.LogAndExit()
 	}
 
-	for _, s := range config.Scopes {
-		if scope == s {
-			return
-		}
+	state.Validated.LogAndExit()
+}
+
+func isEmpty(str string) bool {
+	return strings.TrimSpace(str) == ""
+}
+
+func isMergeCommit(msg string) {
+	if strings.HasPrefix(msg, mergePrefix) {
+		state.Merge.LogAndExit()
 	}
-	state.WrongScope.LogAndExit(scope, strings.Join(config.Scopes, ", "))
 }
 
 func checkHeader(header string, config *globalConfig) {
-	if checkEmpty(header) {
+	if isEmpty(header) {
 		state.EmptyHeader.LogAndExit()
 	}
 
+	if isRevertHeader(header) {
+		// skip revert header checking
+		return
+		// but later body check is still required
+	}
+
 	re := regexp.MustCompile(headerPattern)
 	groups := re.FindStringSubmatch(header)
 
-	if groups == nil || checkEmpty(groups[5]) {
+	if groups == nil || isEmpty(groups[5]) {
 		state.BadHeaderFormat.LogAndExit(header)
 	}
 
@@ -115,60 +122,64 @@ func checkHeader(header string, config *globalConfig) {
 	// TODO: 根据规则对subject检查
 	// subject := groups[5]
 
-	if config.LineLimit <= 0 {
-		config.LineLimit = 80
-	}
 	length := len(header)
 	if length > config.LineLimit &&
 		!(isFixupOrSquash || typ == "revert" || typ == "Revert") {
 		state.LineOverLong.LogAndExit(length, config.LineLimit, header)
 	}
 }
 
+func isRevertHeader(header string) bool {
+	m, _ := regexp.MatchString(revertPattern, header)
+	return m
+}
+
+func checkType(typ string) {
+	for t := range TypeSet {
+		if typ == t {
+			return
+		}
+	}
+	state.WrongType.LogAndExit(typ, TypesStr)
+}
+
+func checkScope(scope string, config *globalConfig) {
+	if isEmpty(scope) {
+		if config.ScopeRequired {
+			state.ScopeMissing.LogAndExit()
+		}
+		return
+	}
+
+	if len(config.Scopes) == 0 {
+		return
+	}
+
+	for _, s := range config.Scopes {
+		if scope == s {
+			return
+		}
+	}
+	state.WrongScope.LogAndExit(scope, strings.Join(config.Scopes, ", "))
+}
+
 func checkBody(body string, config *globalConfig) {
-	if checkEmpty(body) {
+	if isEmpty(body) {
 		if config.BodyRequired {
 			state.BodyMissing.LogAndExit()
 		} else {
 			state.Validated.LogAndExit()
 		}
 	}
 
-	if !checkEmpty(strings.SplitN(body, "\n", 2)[0]) {
+	if !isEmpty(strings.SplitN(body, "\n", 2)[0]) {
 		state.NoBlankLineBeforeBody.LogAndExit()
 	}
 
-	if config.LineLimit <= 0 {
-		config.LineLimit = 80
-	}
 	for _, line := range strings.Split(body, "\n") {
 		length := len(line)
 		if length > config.LineLimit {
 			state.LineOverLong.LogAndExit(length, config.LineLimit, line)
 		}
 	}
 }
-
-func validateMsg(msg string, config *globalConfig) {
-	if checkEmpty(msg) {
-		state.EmptyMessage.LogAndExit()
-	}
-
-	if strings.HasPrefix(msg, mergePrefix) {
-		state.Merge.LogAndExit()
-	}
-
-	sections := strings.SplitN(msg, "\n", 2)
-
-	if m, _ := regexp.MatchString(revertPattern, sections[0]); !m {
-		checkHeader(sections[0], config)
-	}
-
-	if len(sections) == 2 {
-		checkBody(sections[1], config)
-	} else if config.BodyRequired {
-		state.BodyMissing.LogAndExit()
-	}
-
-	state.Validated.LogAndExit()
-}

validator/validate_test.go

@@ -80,7 +80,7 @@ func TestCheckEmpty(t *testing.T) {
 	}
 	for _, tt := range emptyCases {
 		t.Run("checkEmpty", func(t *testing.T) {
-			if got := checkEmpty(tt.text); got != tt.want {
+			if got := isEmpty(tt.text); got != tt.want {
 				t.Errorf(`checkEmpty("%s")=%v, want %v`, tt.text, got, tt.want)
 			}
 		})