add skip flag

adds the ability to avoid categorization
when needed, also set a base for the inclusion flags

Author: barelyhuman

logcategory.go

@@ -24,29 +24,35 @@ type logsByCategory struct {
 }
 
 // printLog - loops through the collected logs to write them to string builder
-func (logs logContainer) printLog(out *strings.Builder, title string) {
+func (logs logContainer) printLog(out *strings.Builder, title string, skipped bool) {
 	if len(logs) > 0 {
-		out.WriteString(fmt.Sprintf("\n\n## %s  \n", title))
+		if !skipped {
+			out.WriteString(fmt.Sprintf("\n\n## %s  \n", title))
+		}
 		for _, item := range logs {
 			out.WriteString(item + "\n")
 		}
 	}
 }
 
 // ToMarkdown - Generate markdown output for the collected commits
-func (logs *logsByCategory) ToMarkdown() string {
+func (logs *logsByCategory) ToMarkdown(skipped bool) string {
 	var markdownString strings.Builder
 
 	markdownString.WriteString("# Changelog \n")
 
-	logs.FEATURE.printLog(&markdownString, "Features")
-	logs.FIX.printLog(&markdownString, "Fixes")
-	logs.REFACTOR.printLog(&markdownString, "Performance")
-	logs.CI.printLog(&markdownString, "CI")
-	logs.DOCS.printLog(&markdownString, "Docs")
-	logs.CHORE.printLog(&markdownString, "Chores")
-	logs.TEST.printLog(&markdownString, "Tests")
-	logs.OTHER.printLog(&markdownString, "Other Changes")
+	if !skipped {
+		logs.FEATURE.printLog(&markdownString, "Features", skipped)
+		logs.FIX.printLog(&markdownString, "Fixes", skipped)
+		logs.REFACTOR.printLog(&markdownString, "Performance", skipped)
+		logs.CI.printLog(&markdownString, "CI", skipped)
+		logs.DOCS.printLog(&markdownString, "Docs", skipped)
+		logs.CHORE.printLog(&markdownString, "Chores", skipped)
+		logs.TEST.printLog(&markdownString, "Tests", skipped)
+		logs.OTHER.printLog(&markdownString, "Other Changes", skipped)
+	} else {
+		logs.OTHER.printLog(&markdownString, "Other Changes", skipped)
+	}
 
 	return markdownString.String()
 }

main.go

@@ -23,20 +23,21 @@ func main() {
 	var startCommit = flag.String("s", "", "commit hash string start collecting commit messages from")
 	var endCommit = flag.String("e", "", "commit hash string to stop collecting commit message at")
 	var inclusionFlags = flag.String("i", "", "commit types to be includes, defaults to CI FIX REFACTOR FEATURE DOCS CHORE TEST OTHER")
+	var skipClassification = flag.Bool("skip", false, "if true will skip trying to classify and just give a list of changes")
 
 	flag.Parse()
 
 	path := repoPath
 
-	err := CommitLog(*path, *startCommit, *endCommit, *inclusionFlags)
+	err := CommitLog(*path, *startCommit, *endCommit, *inclusionFlags, *skipClassification)
 
 	if err.err != nil {
 		log.Fatal(err.message, err.err)
 	}
 }
 
 // CommitLog - Generate commit log
-func CommitLog(path string, startCommitString string, endCommitString string, inclusionFlags string) ErrMessage {
+func CommitLog(path string, startCommitString string, endCommitString string, inclusionFlags string, skipClassification bool) ErrMessage {
 	currentRepository := openRepository(path)
 	baseCommitReference, err := currentRepository.Head()
 	var startHash, endHash *object.Commit
@@ -79,22 +80,26 @@ func CommitLog(path string, startCommitString string, endCommitString string, in
 
 	for _, c := range commits {
 		normalizedHash := c.Hash.String() + " - " + normalizeCommit(c.Message)
-		switch strings.SplitN(strings.TrimSpace(c.Message), ":", 2)[0] {
-		case "ci":
-			logContainer.CI = append(logContainer.CI, normalizedHash)
-		case "fix":
-			logContainer.FIX = append(logContainer.FIX, normalizedHash)
-		case "refactor":
-			logContainer.REFACTOR = append(logContainer.REFACTOR, normalizedHash)
-		case "feat", "feature":
-			logContainer.FEATURE = append(logContainer.FEATURE, normalizedHash)
-		case "docs":
-			logContainer.DOCS = append(logContainer.DOCS, normalizedHash)
-		case "test":
-			logContainer.TEST = append(logContainer.TEST, normalizedHash)
-		case "chore":
-			logContainer.CHORE = append(logContainer.CHORE, normalizedHash)
-		default:
+		if !skipClassification {
+			switch strings.SplitN(strings.TrimSpace(c.Message), ":", 2)[0] {
+			case "ci":
+				logContainer.CI = append(logContainer.CI, normalizedHash)
+			case "fix":
+				logContainer.FIX = append(logContainer.FIX, normalizedHash)
+			case "refactor":
+				logContainer.REFACTOR = append(logContainer.REFACTOR, normalizedHash)
+			case "feat", "feature":
+				logContainer.FEATURE = append(logContainer.FEATURE, normalizedHash)
+			case "docs":
+				logContainer.DOCS = append(logContainer.DOCS, normalizedHash)
+			case "test":
+				logContainer.TEST = append(logContainer.TEST, normalizedHash)
+			case "chore":
+				logContainer.CHORE = append(logContainer.CHORE, normalizedHash)
+			default:
+				logContainer.OTHER = append(logContainer.OTHER, normalizedHash)
+			}
+		} else {
 			logContainer.OTHER = append(logContainer.OTHER, normalizedHash)
 		}
 
@@ -104,7 +109,7 @@ func CommitLog(path string, startCommitString string, endCommitString string, in
 			break
 		}
 	}
-	fmt.Println(logContainer.ToMarkdown())
+	fmt.Println(logContainer.ToMarkdown(skipClassification))
 
 	return ErrMessage{}
 }