refactor: merge message pkg with lint

Author: muthukrishnan24

lint/linter.go

@@ -1,10 +1,6 @@
 // Package lint provides a simple linter for conventional commits
 package lint
 
-import (
-	"github.com/conventionalcommit/commitlint/message"
-)
-
 // Linter is linter for commit message
 type Linter struct {
 	conf  *Config
@@ -18,7 +14,7 @@ func NewLinter(conf *Config, rules []Rule) (*Linter, error) {
 
 // Lint checks the given commitMsg string against rules
 func (l *Linter) Lint(commitMsg string) (*Result, error) {
-	msg, isHeaderErr, err := message.Parse(commitMsg)
+	msg, isHeaderErr, err := Parse(commitMsg)
 	if err != nil {
 		if isHeaderErr {
 			return l.headerErrorRule(commitMsg), nil
@@ -28,8 +24,8 @@ func (l *Linter) Lint(commitMsg string) (*Result, error) {
 	return l.LintCommit(msg)
 }
 
-// LintCommit checks the given message.Commit against rules
-func (l *Linter) LintCommit(msg *message.Commit) (*Result, error) {
+// LintCommit checks the given Commit against rules
+func (l *Linter) LintCommit(msg *Commit) (*Result, error) {
 	res := newResult(msg.FullCommit)
 
 	for _, rule := range l.rules {

lint/message.go

@@ -0,0 +1,7 @@
+package lint
+
+import "github.com/conventionalcommit/parser"
+
+// Commit represent a commit message
+// for now it is an alias of parser.Commit
+type Commit = parser.Commit

message/commit.go renamed to lint/parse.go

@@ -1,10 +1,8 @@
-// Package message contains commit message
-package message
+package lint
 
-import "github.com/conventionalcommit/parser"
-
-// Commit is alias for parser.Commit
-type Commit = parser.Commit
+import (
+	"github.com/conventionalcommit/parser"
+)
 
 // Parse parses given msg and checks for header error
 func Parse(msg string) (*Commit, bool, error) {

lint/rule.go

@@ -1,7 +1,5 @@
 package lint
 
-import "github.com/conventionalcommit/commitlint/message"
-
 // Rule represent a linter rule
 type Rule interface {
 	// Name returns name of the rule, it should be a unique identifier
@@ -15,5 +13,5 @@ type Rule interface {
 	// Validate validates the rule for given message
 	// if given message is valid, return true and result string is ignored
 	// if invalid, return a error result with false
-	Validate(msg *message.Commit) (result string, isValid bool)
+	Validate(msg *Commit) (result string, isValid bool)
 }

rule/charset.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/conventionalcommit/commitlint/message"
+	"github.com/conventionalcommit/commitlint/lint"
 )
 
 // ScopeCharsetRule to validate max length of header
@@ -16,7 +16,7 @@ type ScopeCharsetRule struct {
 func (r *ScopeCharsetRule) Name() string { return "scope-charset" }
 
 // Validate validates ScopeCharsetRule
-func (r *ScopeCharsetRule) Validate(msg *message.Commit) (string, bool) {
+func (r *ScopeCharsetRule) Validate(msg *lint.Commit) (string, bool) {
 	invalidChar, isValid := checkCharset(r.Charset, msg.Header.Scope)
 	if !isValid {
 		errMsg := fmt.Sprintf("scope contains invalid char '%s', allowed chars are [%s]", invalidChar, r.Charset)
@@ -39,7 +39,7 @@ type TypeCharsetRule struct {
 func (r *TypeCharsetRule) Name() string { return "type-charset" }
 
 // Validate validates TypeCharsetRule
-func (r *TypeCharsetRule) Validate(msg *message.Commit) (string, bool) {
+func (r *TypeCharsetRule) Validate(msg *lint.Commit) (string, bool) {
 	invalidChar, isValid := checkCharset(r.Charset, msg.Header.Type)
 	if !isValid {
 		errMsg := fmt.Sprintf("type contains invalid char '%s', allowed chars are [%s]", invalidChar, r.Charset)

rule/enum.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"sort"
 
-	"github.com/conventionalcommit/commitlint/message"
+	"github.com/conventionalcommit/commitlint/lint"
 )
 
 // ScopeEnumRule to validate max length of header
@@ -18,7 +18,7 @@ type ScopeEnumRule struct {
 func (r *ScopeEnumRule) Name() string { return "scope-enum" }
 
 // Validate validates ScopeEnumRule
-func (r *ScopeEnumRule) Validate(msg *message.Commit) (string, bool) {
+func (r *ScopeEnumRule) Validate(msg *lint.Commit) (string, bool) {
 	if msg.Header.Scope == "" {
 		if r.AllowEmpty {
 			return "", true
@@ -64,7 +64,7 @@ type TypeEnumRule struct {
 func (r *TypeEnumRule) Name() string { return "type-enum" }
 
 // Validate validates TypeEnumRule
-func (r *TypeEnumRule) Validate(msg *message.Commit) (string, bool) {
+func (r *TypeEnumRule) Validate(msg *lint.Commit) (string, bool) {
 	isFound := search(r.Types, msg.Header.Type)
 	if !isFound {
 		errMsg := fmt.Sprintf("type '%s' is not allowed, you can use one of %v", msg.Header.Type, r.Types)

rule/max_length.go

@@ -3,7 +3,7 @@ package rule
 import (
 	"fmt"
 
-	"github.com/conventionalcommit/commitlint/message"
+	"github.com/conventionalcommit/commitlint/lint"
 )
 
 // HeadMaxLenRule to validate max length of header
@@ -15,7 +15,7 @@ type HeadMaxLenRule struct {
 func (r *HeadMaxLenRule) Name() string { return "header-max-length" }
 
 // Validate validates HeadMaxLenRule
-func (r *HeadMaxLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *HeadMaxLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Header.FullHeader)
 }
 
@@ -33,7 +33,7 @@ type BodyMaxLenRule struct {
 func (r *BodyMaxLenRule) Name() string { return "body-max-length" }
 
 // Validate validates BodyMaxLenRule
-func (r *BodyMaxLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *BodyMaxLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Body)
 }
 
@@ -51,7 +51,7 @@ type FooterMaxLenRule struct {
 func (r *FooterMaxLenRule) Name() string { return "footer-max-length" }
 
 // Validate validates FooterMaxLenRule
-func (r *FooterMaxLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *FooterMaxLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Footer.FullFooter)
 }
 
@@ -69,7 +69,7 @@ type TypeMaxLenRule struct {
 func (r *TypeMaxLenRule) Name() string { return "type-max-length" }
 
 // Validate validates TypeMaxLenRule
-func (r *TypeMaxLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *TypeMaxLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Header.Type)
 }
 
@@ -87,7 +87,7 @@ type ScopeMaxLenRule struct {
 func (r *ScopeMaxLenRule) Name() string { return "scope-max-length" }
 
 // Validate validates ScopeMaxLenRule
-func (r *ScopeMaxLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *ScopeMaxLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Header.Scope)
 }
 
@@ -105,7 +105,7 @@ type DescriptionMaxLenRule struct {
 func (r *DescriptionMaxLenRule) Name() string { return "description-max-length" }
 
 // Validate validates DescriptionMaxLenRule
-func (r *DescriptionMaxLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *DescriptionMaxLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Header.Description)
 }
 

rule/max_line_length.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/conventionalcommit/commitlint/message"
+	"github.com/conventionalcommit/commitlint/lint"
 )
 
 // BodyMaxLineLenRule to validate max line length of body
@@ -16,7 +16,7 @@ type BodyMaxLineLenRule struct {
 func (r *BodyMaxLineLenRule) Name() string { return "body-max-line-length" }
 
 // Validate validates BodyMaxLineLenRule rule
-func (r *BodyMaxLineLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *BodyMaxLineLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMaxLineLength(r.CheckLen, msg.Body)
 }
 
@@ -34,7 +34,7 @@ type FooterMaxLineLenRule struct {
 func (r *FooterMaxLineLenRule) Name() string { return "footer-max-line-length" }
 
 // Validate validates FooterMaxLineLenRule rule
-func (r *FooterMaxLineLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *FooterMaxLineLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMaxLineLength(r.CheckLen, msg.Footer.FullFooter)
 }
 

rule/min_length.go

@@ -3,7 +3,7 @@ package rule
 import (
 	"fmt"
 
-	"github.com/conventionalcommit/commitlint/message"
+	"github.com/conventionalcommit/commitlint/lint"
 )
 
 // HeadMinLenRule to validate min length of header
@@ -15,7 +15,7 @@ type HeadMinLenRule struct {
 func (r *HeadMinLenRule) Name() string { return "header-min-length" }
 
 // Validate validates HeadMinLenRule
-func (r *HeadMinLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *HeadMinLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Header.FullHeader)
 }
 
@@ -33,7 +33,7 @@ type BodyMinLenRule struct {
 func (r *BodyMinLenRule) Name() string { return "body-min-length" }
 
 // Validate validates BodyMinLenRule
-func (r *BodyMinLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *BodyMinLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Body)
 }
 
@@ -51,7 +51,7 @@ type FooterMinLenRule struct {
 func (r *FooterMinLenRule) Name() string { return "footer-min-length" }
 
 // Validate validates FooterMinLenRule
-func (r *FooterMinLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *FooterMinLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Footer.FullFooter)
 }
 
@@ -69,7 +69,7 @@ type TypeMinLenRule struct {
 func (r *TypeMinLenRule) Name() string { return "type-min-length" }
 
 // Validate validates TypeMinLenRule
-func (r *TypeMinLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *TypeMinLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Header.Type)
 }
 
@@ -87,7 +87,7 @@ type ScopeMinLenRule struct {
 func (r *ScopeMinLenRule) Name() string { return "scope-min-length" }
 
 // Validate validates ScopeMinLenRule
-func (r *ScopeMinLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *ScopeMinLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Header.Scope)
 }
 
@@ -105,7 +105,7 @@ type DescriptionMinLenRule struct {
 func (r *DescriptionMinLenRule) Name() string { return "description-min-length" }
 
 // Validate validates DescriptionMinLenRule
-func (r *DescriptionMinLenRule) Validate(msg *message.Commit) (string, bool) {
+func (r *DescriptionMinLenRule) Validate(msg *lint.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Header.Description)
 }