style: rename some functions

Author: JayceChant

validator/validate.go

@@ -69,10 +69,10 @@ func validateMsg(msg string, config *globalConfig) {
 
 	sections := strings.SplitN(msg, "\n", 2)
 
-	checkHeader(sections[0], config)
+	validateHeader(sections[0], config)
 
 	if len(sections) == 2 {
-		checkBody(sections[1], config)
+		validateBody(sections[1], config)
 	} else if config.BodyRequired {
 		state.BodyMissing.LogAndExit()
 	}
@@ -86,11 +86,14 @@ func isEmpty(str string) bool {
 
 func isMergeCommit(msg string) {
 	if strings.HasPrefix(msg, mergePrefix) {
+		// merge commit is auto generated by git or other tool,
+		// cannot be modified in most cases.
+		// just skip the rest validation.
 		state.Merge.LogAndExit()
 	}
 }
 
-func checkHeader(header string, config *globalConfig) {
+func validateHeader(header string, config *globalConfig) {
 	if isEmpty(header) {
 		state.EmptyHeader.LogAndExit()
 	}
@@ -109,11 +112,11 @@ func checkHeader(header string, config *globalConfig) {
 	}
 
 	typ := groups[3]
-	checkType(typ)
+	validateType(typ)
 
 	isFixupOrSquash := (groups[2] != "")
 
-	checkScope(groups[4], config)
+	validateScope(groups[4], config)
 
 	// TODO: 根据规则对subject检查
 	// subject := groups[5]
@@ -131,7 +134,7 @@ func isRevertHeader(header string) bool {
 	return m
 }
 
-func checkType(typ string) {
+func validateType(typ string) {
 	for t := range TypeSet {
 		if typ == t {
 			return
@@ -140,7 +143,7 @@ func checkType(typ string) {
 	state.WrongType.LogAndExit(typ, TypesStr)
 }
 
-func checkScope(scope string, config *globalConfig) {
+func validateScope(scope string, config *globalConfig) {
 	if isEmpty(scope) {
 		if config.ScopeRequired {
 			state.ScopeMissing.LogAndExit()
@@ -160,7 +163,7 @@ func checkScope(scope string, config *globalConfig) {
 	state.WrongScope.LogAndExit(scope, strings.Join(config.Scopes, ", "))
 }
 
-func checkBody(body string, config *globalConfig) {
+func validateBody(body string, config *globalConfig) {
 	if isEmpty(body) {
 		if config.BodyRequired {
 			state.BodyMissing.LogAndExit()

validator/validate_test.go

@@ -68,7 +68,7 @@ func TestGetMsg(t *testing.T) {
 	}, "Normal", 0)
 }
 
-func TestCheckEmpty(t *testing.T) {
+func TestValidateEmpty(t *testing.T) {
 	var emptyCases = []struct {
 		text string
 		want bool
@@ -88,21 +88,21 @@ func TestCheckEmpty(t *testing.T) {
 	}
 }
 
-func TestCheckType(t *testing.T) {
+func TestValidateType(t *testing.T) {
 	assertExitCode(t, func() {
-		checkType("feat")
+		validateType("feat")
 	}, "feat", 0)
 
 	assertExitCode(t, func() {
-		checkType("")
+		validateType("")
 	}, "no_type", int(state.WrongType))
 
 	assertExitCode(t, func() {
-		checkType("Feat")
+		validateType("Feat")
 	}, "wrong_type", int(state.WrongType))
 }
 
-func TestCheckHeader(t *testing.T) {
+func TestValidateHeader(t *testing.T) {
 	var headerCases = []struct {
 		text   string
 		name   string
@@ -122,12 +122,12 @@ func TestCheckHeader(t *testing.T) {
 	}
 	for _, tt := range headerCases {
 		assertExitCode(t, func() {
-			checkHeader(tt.text, tt.config)
+			validateHeader(tt.text, tt.config)
 		}, tt.name, tt.want)
 	}
 }
 
-func TestCheckBody(t *testing.T) {
+func TestValidateBody(t *testing.T) {
 	var bodyCases = []struct {
 		text   string
 		name   string
@@ -142,7 +142,7 @@ func TestCheckBody(t *testing.T) {
 	}
 	for _, tt := range bodyCases {
 		assertExitCode(t, func() {
-			checkBody(tt.text, tt.config)
+			validateBody(tt.text, tt.config)
 		}, tt.name, tt.want)
 	}
 }
@@ -165,7 +165,7 @@ This reverts commit 1234567890abcdef1234567890abcdef12345678.`, defaultCfg)
 	}, "Revert", 0)
 }
 
-func TestCheckScope(t *testing.T) {
+func TestValidateScope(t *testing.T) {
 	var scopeCases = []struct {
 		text   string
 		name   string
@@ -180,7 +180,7 @@ func TestCheckScope(t *testing.T) {
 	}
 	for _, tt := range scopeCases {
 		assertExitCode(t, func() {
-			checkScope(tt.text, tt.config)
+			validateScope(tt.text, tt.config)
 		}, tt.name, tt.want)
 	}
 }