feat: move register methods to internal

* move Version, FullVersion to internal
* rename DefaultConfig to GetDefaultConfig
* rename RuleFailures to Failures
* rename Messages to Message, RuleName to Name

Author: muthukrishnan24

.goreleaser.yml

@@ -11,7 +11,7 @@ builds:
       - windows
       - darwin
     ldflags:
-      - -s -w -X github.com/conventionalcommit/commitlint/config.version={{.Version}} -X github.com/conventionalcommit/commitlint/config.commit={{.FullCommit}} -X github.com/conventionalcommit/commitlint/config.buildTime={{.Date}}
+      - -s -w -X github.com/conventionalcommit/commitlint/internal.version={{.Version}} -X github.com/conventionalcommit/commitlint/internal.commit={{.FullCommit}} -X github.com/conventionalcommit/commitlint/internal.buildTime={{.Date}}
     ignore:
       - goos: darwin
         goarch: arm64

config/config.go

@@ -9,8 +9,10 @@ import (
 	"path/filepath"
 
 	"golang.org/x/mod/semver"
-	"gopkg.in/yaml.v3"
+	yaml "gopkg.in/yaml.v3"
 
+	"github.com/conventionalcommit/commitlint/internal"
+	"github.com/conventionalcommit/commitlint/internal/registry"
 	"github.com/conventionalcommit/commitlint/lint"
 )
 
@@ -75,6 +77,7 @@ func getConfigPath(confFilePath string) (confPath string, isDefault bool, retErr
 
 // Parse parse given file in confPath, and return Config instance, error if any
 func Parse(confPath string) (*lint.Config, error) {
+	confPath = filepath.Clean(confPath)
 	confBytes, err := os.ReadFile(confPath)
 	if err != nil {
 		return nil, err
@@ -98,7 +101,7 @@ func Validate(conf *lint.Config) []error {
 	if conf.Formatter == "" {
 		errs = append(errs, errors.New("formatter is empty"))
 	} else {
-		_, ok := globalRegistry.GetFormatter(conf.Formatter)
+		_, ok := registry.GetFormatter(conf.Formatter)
 		if !ok {
 			errs = append(errs, fmt.Errorf("unknown formatter '%s'", conf.Formatter))
 		}
@@ -119,7 +122,7 @@ func Validate(conf *lint.Config) []error {
 		}
 
 		// Check if rule is registered
-		ruleData, ok := globalRegistry.GetRule(ruleName)
+		ruleData, ok := registry.GetRule(ruleName)
 		if !ok {
 			errs = append(errs, fmt.Errorf("unknown rule '%s'", ruleName))
 			continue
@@ -135,22 +138,22 @@ func Validate(conf *lint.Config) []error {
 
 // WriteToFile util func to write config object to given file
 func WriteToFile(outFilePath string, conf *lint.Config) (retErr error) {
-	file, err := os.Create(outFilePath)
+	f, err := os.Create(outFilePath)
 	if err != nil {
 		return err
 	}
 	defer func() {
-		err1 := file.Close()
-		if retErr == nil && err1 != nil {
-			retErr = err1
+		err := f.Close()
+		if retErr == nil && err != nil {
+			retErr = err
 		}
 	}()
 
-	w := bufio.NewWriter(file)
+	w := bufio.NewWriter(f)
 	defer func() {
-		err1 := w.Flush()
-		if retErr == nil && err1 != nil {
-			retErr = err1
+		err := w.Flush()
+		if retErr == nil && err != nil {
+			retErr = err
 		}
 	}()
 
@@ -169,9 +172,9 @@ func checkVersion(versionNo string) error {
 }
 
 func checkIfMinVersion(versionNo string) error {
-	cmp := semver.Compare(Version(), versionNo)
+	cmp := semver.Compare(internal.Version(), versionNo)
 	if cmp != -1 {
 		return nil
 	}
-	return fmt.Errorf("min version required is %s. you have %s.\nupgrade commitlint", versionNo, Version())
+	return fmt.Errorf("min version required is %s. you have %s.\nupgrade commitlint", versionNo, internal.Version())
 }

config/default.go

@@ -2,12 +2,13 @@ package config
 
 import (
 	"github.com/conventionalcommit/commitlint/formatter"
+	"github.com/conventionalcommit/commitlint/internal"
 	"github.com/conventionalcommit/commitlint/lint"
 	"github.com/conventionalcommit/commitlint/rule"
 )
 
 var defConf = &lint.Config{
-	Version: Version(),
+	Version: internal.Version(),
 
 	Formatter: (&formatter.DefaultFormatter{}).Name(),
 
@@ -148,8 +149,8 @@ var defRuleConf = map[string]lint.RuleConfig{
 	},
 }
 
-// DefaultConfig writes default config to given file
-func DefaultConfig(onlyEnabled bool) *lint.Config {
+// GetDefaultConfig writes default config to given file
+func GetDefaultConfig(onlyEnabled bool) *lint.Config {
 	if !onlyEnabled {
 		return defConf
 	}

config/default_test.go

@@ -2,6 +2,8 @@ package config
 
 import (
 	"testing"
+
+	"github.com/conventionalcommit/commitlint/internal/registry"
 )
 
 func TestDefaultLint(t *testing.T) {
@@ -13,7 +15,7 @@ func TestDefaultLint(t *testing.T) {
 }
 
 func TestDefaultConf(t *testing.T) {
-	rules := globalRegistry.Rules()
+	rules := registry.Rules()
 	if len(rules) != len(defConf.Rules) {
 		t.Error("default conf does not have all rules", len(rules), len(defConf.Rules))
 		return

config/lint.go

@@ -3,6 +3,7 @@ package config
 import (
 	"fmt"
 
+	"github.com/conventionalcommit/commitlint/internal/registry"
 	"github.com/conventionalcommit/commitlint/lint"
 )
 
@@ -27,7 +28,7 @@ func GetFormatter(conf *lint.Config) (lint.Formatter, error) {
 		return nil, err
 	}
 
-	format, ok := globalRegistry.GetFormatter(conf.Formatter)
+	format, ok := registry.GetFormatter(conf.Formatter)
 	if !ok {
 		return nil, fmt.Errorf("config error: '%s' formatter not found", conf.Formatter)
 	}
@@ -41,7 +42,7 @@ func GetEnabledRules(conf *lint.Config) ([]lint.Rule, error) {
 	for ruleName, ruleConfig := range conf.Rules {
 		// Checking if rule is registered
 		// before checking if rule is enabled
-		r, ok := globalRegistry.GetRule(ruleName)
+		r, ok := registry.GetRule(ruleName)
 		if !ok {
 			return nil, fmt.Errorf("config error: '%s' rule not found", ruleName)
 		}

formatter/default.go

@@ -57,7 +57,7 @@ func writeRuleFailure(w *strings.Builder, sign, title string, resArr []*lint.Rul
 }
 
 func writeMessages(w *strings.Builder, ruleRes *lint.RuleFailure, sign string) {
-	msgs := ruleRes.Messages()
+	msgs := ruleRes.Message()
 
 	if len(msgs) == 0 {
 		return
@@ -68,15 +68,15 @@ func writeMessages(w *strings.Builder, ruleRes *lint.RuleFailure, sign string) {
 	if len(msgs) == 1 {
 		msg := msgs[0]
 		// ❌ rule-name: message
-		fmt.Fprintf(w, "\n%s %s: %s", space+sign, ruleRes.RuleName(), msg)
+		fmt.Fprintf(w, "\n%s %s: %s", space+sign, ruleRes.Name(), msg)
 		return
 	}
 
 	// ❌ rule-name:
 	//    - message1
 	//    - message2
-	fmt.Fprintf(w, "\n%s %s:", space+sign, ruleRes.RuleName())
-	for _, msg := range ruleRes.Messages() {
+	fmt.Fprintf(w, "\n%s %s:", space+sign, ruleRes.Name())
+	for _, msg := range ruleRes.Message() {
 		fmt.Fprintf(w, "\n%s - %s", space+space, msg)
 	}
 }

formatter/json.go

@@ -39,8 +39,8 @@ func (f *JSONFormatter) formRuleFailure(res []*lint.RuleFailure, includeSev bool
 	for _, r := range res {
 		output := make(map[string]interface{})
 
-		output["name"] = r.RuleName()
-		output["messages"] = r.Messages()
+		output["name"] = r.Name()
+		output["messages"] = r.Message()
 
 		if includeSev {
 			output["severity"] = r.Severity()

formatter/util.go

@@ -4,7 +4,7 @@ import "github.com/conventionalcommit/commitlint/lint"
 
 // bySeverity returns all messages with given severity
 func bySeverity(res *lint.Failure) (errs, warns, others []*lint.RuleFailure) {
-	for _, r := range res.RuleFailures() {
+	for _, r := range res.Failures() {
 		switch r.Severity() {
 		case lint.SeverityError:
 			errs = append(errs, r)

cmd/callback.go renamed to internal/cmd/callback.go

@@ -5,7 +5,7 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/urfave/cli/v2"
+	cli "github.com/urfave/cli/v2"
 
 	"github.com/conventionalcommit/commitlint/config"
 )
@@ -48,7 +48,7 @@ func hookCreate(confPath string, isReplace bool) error {
 
 // configCreate is the callback function for create config command
 func configCreate(onlyEnabled, isReplace bool) error {
-	defConf := config.DefaultConfig(onlyEnabled)
+	defConf := config.GetDefaultConfig(onlyEnabled)
 	outPath := filepath.Join(".", config.ConfigFile)
 	// if config file already exists skip creating or overwriting it
 	if _, err := os.Stat(outPath); !os.IsNotExist(err) {

cmd/cmd.go renamed to internal/cmd/cmd.go

@@ -5,11 +5,12 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/conventionalcommit/commitlint/config"
-	"github.com/urfave/cli/v2"
+	cli "github.com/urfave/cli/v2"
+
+	"github.com/conventionalcommit/commitlint/internal"
 )
 
-// Run runs the commandline with os.Args
+// Run runs commitlint cli with os.Args
 func Run() error {
 	return newCmd().Run(os.Args)
 }
@@ -27,7 +28,7 @@ func newCmd() *cli.App {
 		Name:     "commitlint",
 		Usage:    "linter for conventional commits",
 		Commands: cmds,
-		Version:  config.FullVersion(),
+		Version:  internal.FullVersion(),
 	}
 	return app
 }

cmd/errors.go renamed to internal/cmd/errors.go

@@ -72,7 +72,7 @@ func getCommitMsg(fileInput string) (string, error) {
 }
 
 func hasErrorSeverity(res *lint.Failure) bool {
-	for _, r := range res.RuleFailures() {
+	for _, r := range res.Failures() {
 		if r.Severity() == lint.SeverityError {
 			return true
 		}

cmd/hook.go renamed to internal/cmd/hook.go

@@ -1,4 +1,5 @@
-package config
+// Package registry contains registered rules and formatters
+package registry
 
 import (
 	"fmt"
@@ -23,6 +24,21 @@ func RegisterFormatter(format lint.Formatter) error {
 	return globalRegistry.RegisterFormatter(format)
 }
 
+// GetRule returns Rule with given name
+func GetRule(name string) (lint.Rule, bool) {
+	return globalRegistry.GetRule(name)
+}
+
+// GetFormatter returns Formatter with given name
+func GetFormatter(name string) (lint.Formatter, bool) {
+	return globalRegistry.GetFormatter(name)
+}
+
+// Rules returns all registered rules
+func Rules() []lint.Rule {
+	return globalRegistry.Rules()
+}
+
 type registry struct {
 	mut *sync.Mutex
 

cmd/lint.go renamed to internal/cmd/lint.go

@@ -1,4 +1,4 @@
-package config
+package registry
 
 import "testing"
 

cmd/util.go renamed to internal/cmd/util.go

@@ -1,4 +1,4 @@
-package config
+package internal
 
 import (
 	"fmt"
@@ -72,5 +72,6 @@ func formFullVersion() string {
 	} else {
 		versionInfo = unknownVersion
 	}
+
 	return fmt.Sprintf(versionTmpl, versionInfo, commitInfo, unknownBuildTime)
 }