fix: stability, command separation, cleaner commit message

removed the Changelog header as I think it's unnecessary
and cleaned up the remaining commit messages to remove the
key being used for classification also updated
readme with the needed changes

Author: barelyhuman

.gitignore

@@ -1,2 +1,3 @@
 CHANGELOG.md
 ./commitlog
+.DS_Store

README.md

@@ -98,17 +98,18 @@ Usage of commitlog:
 
 ```sh
 > commitlog 
+# which is the shorthand of 
+> commitlog log -p .
 ```
 
-```markdown
-# Changelog
+**As of 0.0.6 there's an experimental release subcommand that can be used for version tagging**
 
+```markdown
 ## Fixes
+97c582b3eb5a6796ef9c250d9653ad90dce63cbe - example fix
 
-97c582b3eb5a6796ef9c250d9653ad90dce63cbe - fix: example fix
 
 ## Other Changes
-
 da6d837eb3134f836bfbe401de7882f2e0818ba8 - Create LICENSE
 b0f1b1d2bc4265cb72b70b3ae5b60f8e65f47b12 - initial commit
 ```

assets/header.png

@@ -9,6 +9,7 @@ import (
 
 // Init - initializes the commands and also handles the classification
 func Init() {
+
 	// Install the needed commands from the cmd package
 	releaseCmd.Install()
 	commitlogCmd.Install()
@@ -21,9 +22,14 @@ func Init() {
 				releaseCmd.Run(os.Args[2:])
 				return
 			}
+		case "log":
+			{
+				commitlogCmd.Run(os.Args[2:])
+				return
+			}
 		}
 	}
 
 	// Default Command, parse all flags
-	commitlogCmd.Run(os.Args)
+	commitlogCmd.Run(os.Args[1:])
 }

cmd/cmd.go

@@ -17,7 +17,7 @@ var skipClassification *bool
 
 // Install - add flags and other options
 func Install() {
-	clogCmd = flag.NewFlagSet("release", flag.ExitOnError)
+	clogCmd = flag.NewFlagSet("commitlog", flag.ExitOnError)
 	repoPath = clogCmd.String("p", ".", "path to the repository, points to the current working directory by default")
 	startCommit = clogCmd.String("s", "", "commit hash string / revision (ex. HEAD, HEAD^, HEAD~2) \n to start collecting commit messages from")
 	endCommit = clogCmd.String("e", "", "commit hash string / revision (ex. HEAD, HEAD^, HEAD~2) \n to stop collecting commit message at")
@@ -27,11 +27,17 @@ func Install() {
 
 // Run - execute the command
 func Run(args []string) {
-	clogCmd.Parse(args)
-	changelog, err := clog.CommitLog(*repoPath, *startCommit, *endCommit, *inclusionFlags, *skipClassification)
 
-	if err.Err != nil {
-		log.Fatal(err.Message, err.Err)
+	err := clogCmd.Parse(args)
+
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	changelog, clogErr := clog.CommitLog(*repoPath, *startCommit, *endCommit, *inclusionFlags, *skipClassification)
+
+	if clogErr.Err != nil {
+		log.Fatal(clogErr.Message, clogErr.Err)
 	}
 
 	fmt.Println(changelog)

cmd/commitlog/commitlog.go

@@ -61,7 +61,10 @@ func Run(args []string) {
 	var tagToUse = *tag
 
 	isBeta := needsQuestionnaire(args)
-	releaseCmd.Parse(args)
+	err := releaseCmd.Parse(args)
+	if err != nil {
+		log.Fatal(err)
+	}
 
 	if tagToUse == "" {
 		tagToUse = getTagString()

cmd/release/release.go

@@ -97,15 +97,17 @@ func isCommitToNearestTag(repo *git.Repository, commit *object.Commit) bool {
 }
 
 // normalizeCommit - reduces the commit message to the first line and ignore the description text of the commit
-func normalizeCommit(commitMessage string) string {
+func normalizeCommit(commitMessage string, key string) string {
 	var message string
 	for i, msg := range strings.Split(commitMessage, "\n") {
 		if i == 0 {
 			message = msg
 			break
 		}
 	}
-	return strings.TrimSuffix(message, "\n")
+
+	removedPrefix := strings.TrimPrefix(strings.TrimSuffix(message, "\n"), key)
+	return strings.TrimSpace(strings.TrimSuffix(removedPrefix, "\n"))
 }
 
 // OpenRepository - open the git repository and return repository reference

log/gitutils.go

@@ -75,8 +75,6 @@ func (container logContainer) printLog(out *strings.Builder, title string, skipp
 func (logs *logsByCategory) ToMarkdown(skipped bool) string {
 	var markdownString strings.Builder
 
-	markdownString.WriteString("# Changelog \n")
-
 	if !skipped {
 		logs.FEATURE.printLog(&markdownString, "Features", skipped)
 		logs.FIX.printLog(&markdownString, "Fixes", skipped)
@@ -187,9 +185,10 @@ func CommitLog(path string, startCommitString string, endCommitString string, in
 	logContainer.OTHER.include = inclusions.checkInclusion("other")
 
 	for _, c := range commits {
-		normalizedHash := c.Hash.String() + " - " + normalizeCommit(c.Message)
-		key := findKeyInCommit(SupportedKeys, c.Message)
+		key, scopedKey := findKeyInCommit(SupportedKeys, c.Message)
+		fmt.Printf("key: %v,scopedKey:%v \n", key, scopedKey)
 		key = strings.SplitN(strings.TrimSpace(key), ":", 2)[0]
+		normalizedHash := c.Hash.String() + " - " + normalizeCommit(c.Message, scopedKey)
 
 		logContainer.AddCommit(key, normalizedHash, skipClassification)
 
@@ -214,15 +213,20 @@ func (inclusions *commitTypeInclusions) checkInclusion(flagToCheck string) bool
 	return false
 }
 
-func findKeyInCommit(key string, commitMessage string) string {
+func findKeyInCommit(key string, commitMessage string) (string, string) {
 	re := regexp.MustCompile(`^(` + key + `)[:]|^((` + key + `)\((\w+[, /\\]*)+\)[:])`)
-	if len(re.FindAllStringSubmatch(commitMessage, -1)) > 0 {
-		keyCheckOne := re.FindAllStringSubmatch(commitMessage, -1)[0][3]
-		if keyCheckOne == "" {
-			keyCheckTwo := re.FindAllStringSubmatch(commitMessage, -1)[0][1]
-			return keyCheckTwo
-		}
-		return keyCheckOne
+	keyMatches := re.FindAllStringSubmatch(commitMessage, -1)
+	fmt.Printf("%v", keyMatches)
+	if len(keyMatches) == 0 {
+		return "", ""
+	}
+
+	scopedKey := keyMatches[0][0]
+	scopelessKey := keyMatches[0][3]
+
+	if scopelessKey == "" {
+		scopelessKey = keyMatches[0][1]
 	}
-	return ""
+
+	return scopelessKey, scopedKey
 }