chore: Cleanup and format code. (#153)

* chore: Cleanup and format code.

* chore: Cleanup and format code.

Author: Renni771

cli/root.go

@@ -5,17 +5,18 @@ import (
 	gogit "github.com/go-git/go-git/v5"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
-	"golang.org/x/exp/slices"
-
 	"github.com/thenativeweb/get-next-version/git"
 	"github.com/thenativeweb/get-next-version/target"
 	"github.com/thenativeweb/get-next-version/util"
 	"github.com/thenativeweb/get-next-version/versioning"
+	"golang.org/x/exp/slices"
 )
 
-var rootRepositoryFlag string
-var rootTargetFlag string
-var rootPrefixFlag string
+var (
+	rootRepositoryFlag string
+	rootTargetFlag     string
+	rootPrefixFlag     string
+)
 
 func init() {
 	RootCommand.Flags().StringVarP(&rootRepositoryFlag, "repository", "r", ".", "sets the path to the repository")

conventionalcommits/commit_message.go

@@ -9,9 +9,11 @@ import (
 	"github.com/thenativeweb/get-next-version/util"
 )
 
-var bodyRegex *regexp.Regexp
-var breakingFooterTokens = []string{"BREAKING CHANGE", "BREAKING-CHANGE"}
-var footerTokenSeperators = []string{": ", " #"}
+var (
+	bodyRegex             *regexp.Regexp
+	breakingFooterTokens  = []string{"BREAKING CHANGE", "BREAKING-CHANGE"}
+	footerTokenSeparators = []string{": ", " #"}
+)
 
 func initCommitMessage() {
 	typesRegexString := ""
@@ -60,8 +62,8 @@ func CommitMessageToType(message string) (Type, error) {
 
 	var breakingFooterPrefixes []string
 	for _, token := range breakingFooterTokens {
-		for _, seperator := range footerTokenSeperators {
-			breakingFooterPrefixes = append(breakingFooterPrefixes, token+seperator)
+		for _, separator := range footerTokenSeparators {
+			breakingFooterPrefixes = append(breakingFooterPrefixes, token+separator)
 		}
 	}
 	for _, footer := range footers {
@@ -70,18 +72,18 @@ func CommitMessageToType(message string) (Type, error) {
 		}
 	}
 
-	parsedMesageBody := bodyRegex.FindStringSubmatch(body)
-	if parsedMesageBody == nil {
+	parsedMessageBody := bodyRegex.FindStringSubmatch(body)
+	if parsedMessageBody == nil {
 		return Chore, errors.New("invalid message body for conventional commit message")
 	}
 
 	breakingIndicatorIndex := util.MustFind(bodyRegex.SubexpNames(), "breaking")
-	breakingIndicator := parsedMesageBody[breakingIndicatorIndex]
+	breakingIndicator := parsedMessageBody[breakingIndicatorIndex]
 	if breakingIndicator == "!" {
 		return BreakingChange, nil
 	}
 
 	typeIndex := util.MustFind(bodyRegex.SubexpNames(), "type")
 
-	return StringToType(parsedMesageBody[typeIndex])
+	return StringToType(parsedMessageBody[typeIndex])
 }

conventionalcommits/commit_message_test.go

@@ -28,7 +28,7 @@ func TestCommitMessageToType(t *testing.T) {
 		{message: "chore:\n\nSome-Token: ", doExpectError: false, expectedCommitType: conventionalcommits.Chore},
 		{message: "Chore:", doExpectError: false, expectedCommitType: conventionalcommits.Chore},
 		{message: "", doExpectError: true, expectedCommitType: conventionalcommits.Chore},
-		{message: "invaild:", doExpectError: true, expectedCommitType: conventionalcommits.Chore},
+		{message: "invalid:", doExpectError: true, expectedCommitType: conventionalcommits.Chore},
 	}
 
 	for _, test := range tests {

conventionalcommits/type.go

@@ -2,6 +2,7 @@ package conventionalcommits
 
 import (
 	"errors"
+	"slices"
 	"strings"
 )
 
@@ -14,10 +15,12 @@ const (
 	BreakingChange
 )
 
-var choreTypes = []string{"build", "chore", "ci", "docs", "style", "refactor", "perf", "test"}
-var fixTypes = []string{"fix"}
-var featureTypes = []string{"feat"}
-var allTypes []string
+var (
+	choreTypes   = []string{"build", "chore", "ci", "docs", "style", "refactor", "perf", "test"}
+	fixTypes     = []string{"fix"}
+	featureTypes = []string{"feat"}
+	allTypes     []string
+)
 
 func initType() {
 	for _, types := range [][]string{choreTypes, fixTypes, featureTypes} {
@@ -26,22 +29,16 @@ func initType() {
 }
 
 func StringToType(s string) (Type, error) {
-	for _, choreType := range choreTypes {
-		if strings.ToLower(s) == choreType {
-			return Chore, nil
-		}
+	if slices.Contains(choreTypes, strings.ToLower(s)) {
+		return Chore, nil
 	}
 
-	for _, fixType := range fixTypes {
-		if strings.ToLower(s) == fixType {
-			return Fix, nil
-		}
+	if slices.Contains(fixTypes, strings.ToLower(s)) {
+		return Fix, nil
 	}
 
-	for _, featureType := range featureTypes {
-		if strings.ToLower(s) == featureType {
-			return Feature, nil
-		}
+	if slices.Contains(featureTypes, strings.ToLower(s)) {
+		return Feature, nil
 	}
 
 	return Chore, errors.New("invalid string for conventional commit type")

git/tags_test.go

@@ -43,6 +43,7 @@ func TestGetAllSemVerTags(t *testing.T) {
 			expectedTagNames: []string{"1.0.0", "2.0.0"},
 		},
 		{
+			// The 'v' prefix in 'vsomething-else' is intentionally used here because it is the prefix for 'version'.
 			tagsPerBranch:    map[string][][]string{"main": {{"1.0.0"}, {"v2.0.0"}, {"vsomething-else"}}},
 			doesExpectError:  false,
 			expectedTagNames: []string{"1.0.0", "2.0.0"},

target/format.go

@@ -2,6 +2,7 @@ package target
 
 import (
 	"fmt"
+
 	"github.com/Masterminds/semver"
 )
 

target/format_test.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/Masterminds/semver"
 	"github.com/stretchr/testify/assert"
-
 	"github.com/thenativeweb/get-next-version/target"
 )
 

target/write_output_test.go

@@ -8,7 +8,6 @@ import (
 
 	"github.com/Masterminds/semver"
 	"github.com/stretchr/testify/assert"
-
 	"github.com/thenativeweb/get-next-version/target"
 )
 

version/version.go

@@ -5,8 +5,10 @@ import (
 	"runtime/debug"
 )
 
-var Version = "(version unavailable)"
-var GitVersion = "(version unavailable)"
+var (
+	Version    = "(version unavailable)"
+	GitVersion = "(version unavailable)"
+)
 
 func init() {
 	info, ok := debug.ReadBuildInfo()