fix(defaultlinter): remove strict commit types

somebadcode · somebadcode · commit a02f2d18f991 · 2025-06-15T01:38:46.000+02:00
Removed the set of allowed commit types. This is not part of the
conventional commits specifications. Any type is allowed now.

Made improvements to how rules work to make it more extensible.
diff --git a/internal/commitlinter/defaultlinter/defaultlinter.go b/internal/commitlinter/defaultlinter/defaultlinter.go
@@ -2,10 +2,7 @@ package defaultlinter
 
 import (
 	"errors"
-	"fmt"
 	"strings"
-	"unicode"
-	"unicode/utf8"
 
 	"github.com/go-git/go-git/v5/plumbing/object"
 
@@ -16,31 +13,22 @@ import (
 type Linter struct {
 	// AllowInitialCommit will cause the linter to ignore initial commit if it's written correctly.
 	AllowInitialCommit bool
-	// AllowedTypes is a set of commit types that should be allowed. Defaults to conventional commits and angular types.
-	AllowedTypes map[string]struct{}
+	// Rules is a list of rules to enforce on commit messages.
+	Rules []RuleFunc
 }
 
-var (
-	ErrUnconventionalType = errors.New("non-conforming commit type")
-	ErrInvalidSubject     = errors.New("invalid subject in commit message")
-	ErrInvalidCharacter   = errors.New("invalid character in commit message")
-)
-
-var (
-	conventionalCommitTypes = []string{"fix", "feat", "BREAKING CHANGE"}
-	angularCommitTypes      = []string{"docs", "ci", "chore", "style", "refactor", "improvement", "perf", "test"}
-)
-
 // New returns a commit linter that adheres to Conventional Commits 1.0.0 and Angular project's recommended scopes.
 func New(options ...Option) *Linter {
 	var linter Linter
+
 	for _, opt := range options {
 		opt(&linter)
 	}
 
-	if len(linter.AllowedTypes) == 0 {
-		WithCommitTypes(conventionalCommitTypes...)(&linter)
-		WithCommitTypes(angularCommitTypes...)(&linter)
+	if linter.Rules == nil {
+		linter.Rules = []RuleFunc{
+			RuleSubjectNoLeadingUpperCase,
+		}
 	}
 
 	return &linter
@@ -72,32 +60,12 @@ func (l *Linter) Lint(commit *object.Commit) error {
 		return nil
 	}
 
-	// Commit type must a known one.
-	if _, ok := l.AllowedTypes[msg.Type]; !ok {
-		return commitlinter.LintError{
-			Err:  ErrUnconventionalType,
-			Hash: commit.Hash,
-		}
-	}
-
-	// Subject must not start with an upper case letter.
-	first, size := utf8.DecodeRuneInString(msg.Subject)
-	if first == utf8.RuneError && size == 0 {
-		return commitlinter.LintError{
-			Err:  fmt.Errorf("no subject detected: %w", ErrInvalidSubject),
-			Hash: commit.Hash,
-		}
-	} else if first == utf8.RuneError && size == 1 {
-		return commitlinter.LintError{
-			Err:  fmt.Errorf("bad subject: %w", ErrInvalidCharacter),
-			Hash: commit.Hash,
-		}
-	}
-
-	if unicode.IsUpper(first) {
-		return commitlinter.LintError{
-			Err:  fmt.Errorf("subject must not start with upper case %q: %w", msg.Subject, ErrInvalidCharacter),
-			Hash: commit.Hash,
+	for _, rule := range l.Rules {
+		if err = rule(msg); err != nil {
+			return commitlinter.LintError{
+				Err:  err,
+				Hash: commit.Hash,
+			}
 		}
 	}
 
diff --git a/internal/commitlinter/defaultlinter/defaultlinter_test.go b/internal/commitlinter/defaultlinter/defaultlinter_test.go
@@ -102,7 +102,6 @@ func TestLinter_Lint(t *testing.T) {
 				Rev:    "HEAD",
 				Linter: defaultlinter.New(),
 			},
-			wantErr: true,
 		},
 		{
 			repoOps: []repobuilder.OperationFunc{
@@ -142,7 +141,7 @@ func TestLinter_Lint(t *testing.T) {
 			},
 			fields: fields{
 				Rev:    "HEAD",
-				Linter: defaultlinter.New(),
+				Linter: defaultlinter.New(defaultlinter.WithRule(defaultlinter.RuleSubjectNoLeadingUpperCase)),
 			},
 			wantErr: true,
 		},
diff --git a/internal/commitlinter/defaultlinter/options.go b/internal/commitlinter/defaultlinter/options.go
@@ -8,14 +8,8 @@ func AllowInitialCommit() Option {
 	}
 }
 
-func WithCommitTypes(types ...string) Option {
+func WithRule(rules ...RuleFunc) Option {
 	return func(l *Linter) {
-		if l.AllowedTypes == nil {
-			l.AllowedTypes = make(map[string]struct{})
-		}
-
-		for _, typ := range types {
-			l.AllowedTypes[typ] = struct{}{}
-		}
+		l.Rules = append(l.Rules, rules...)
 	}
 }
diff --git a/internal/commitlinter/defaultlinter/rules.go b/internal/commitlinter/defaultlinter/rules.go
@@ -0,0 +1,33 @@
+package defaultlinter
+
+import (
+	"errors"
+	"fmt"
+	"unicode"
+	"unicode/utf8"
+
+	"github.com/somebadcode/commit-tool/internal/commitmsg"
+)
+
+type RuleFunc func(message commitmsg.CommitMessage) error
+
+var (
+	ErrInvalidSubject   = errors.New("invalid subject in commit message")
+	ErrInvalidCharacter = errors.New("invalid character in commit message")
+)
+
+func RuleSubjectNoLeadingUpperCase(msg commitmsg.CommitMessage) error {
+	first, size := utf8.DecodeRuneInString(msg.Subject)
+	if first == utf8.RuneError && size == 0 {
+		return fmt.Errorf("no subject detected: %w", ErrInvalidSubject)
+	} else if first == utf8.RuneError && size == 1 {
+		return fmt.Errorf("bad subject: %w", ErrInvalidCharacter)
+
+	}
+
+	if unicode.IsUpper(first) {
+		return fmt.Errorf("subject must not start with upper case %q: %w", msg.Subject, ErrInvalidCharacter)
+	}
+
+	return nil
+}

Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,8 @@ func AllowInitialCommit() Option {`
`8`	`8`	`}`
`9`	`9`	`}`
`10`	`10`
`11`		`-func WithCommitTypes(types ...string) Option {`
	`11`	`+func WithRule(rules ...RuleFunc) Option {`
`12`	`12`	`return func(l *Linter) {`
`13`		`- if l.AllowedTypes == nil {`
`14`		`- l.AllowedTypes = make(map[string]struct{})`
`15`		`- }`
`16`		`-`
`17`		`- for _, typ := range types {`
`18`		`- l.AllowedTypes[typ] = struct{}{}`
`19`		`- }`
	`13`	`+ l.Rules = append(l.Rules, rules...)`
`20`	`14`	`}`
`21`	`15`	`}`