feat(log): Add --markdown option

BREAKING CHANGE: Rename `footer` property in --conventional-commits JSON object to `footers` to align with wording in conventional commits spec.

Author: PSanetra

README.md

@@ -68,7 +68,7 @@ commit 478bb9dfdca43216cda6cedcab27faf5c8fd68c0
 Author: John Doe <[email protected]>
 Date:   Wed Jun 03 20:17:23 2020 +0000
 
-    fix: Add fix
+    fix(some_component): Add fix
 
     Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc bibendum vulputate sapien vel mattis.
 
@@ -96,10 +96,11 @@ $ git-semver log --conventional-commits v1.0.0
 [
   {
     "type": "fix",
+    "scope": "some_component",
     "breaking_change": true,
     "description": "Add fix",
     "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc bibendum vulputate sapien vel mattis.\n\nVivamus faucibus leo id libero suscipit, varius tincidunt neque interdum. Mauris rutrum at velit vitae semper.",
-    "footer": {
+    "footers": {
       "BREAKING CHANGE": [
         "This commit is breaking some API."
       ],
@@ -115,6 +116,25 @@ $ git-semver log --conventional-commits v1.0.0
 ]
 ```
 
+Print changelog formatted as markdown.
+```bash
+$ git-semver log --markdown v1.0.0
+### BREAKING CHANGES
+
+* **some_component** This commit is breaking some API.
+
+### Features
+
+* Add feature
+
+### Bug Fixes
+
+* **some_component** Add fix
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc bibendum vulputate sapien vel mattis.
+
+Vivamus faucibus leo id libero suscipit, varius tincidunt neque interdum. Mauris rutrum at velit vitae semper.
+```
+
 ### compare
 
 The `compare` command is an utility command to compare two semantic versions.

cli/log/command.go

@@ -13,6 +13,7 @@ import (
 
 var excludePreReleases bool
 var outputAsConventionalCommits bool
+var markdownChangelog bool
 
 var Command = cobra.Command{
 	Use:   "log [<version>]",
@@ -41,7 +42,14 @@ var Command = cobra.Command{
 			logger.Logger.Fatalln(err)
 		}
 
-		if outputAsConventionalCommits {
+		if !outputAsConventionalCommits && !markdownChangelog {
+			for _, commit := range commits {
+				fmt.Print(commit)
+			}
+		} else if outputAsConventionalCommits && markdownChangelog {
+			logger.Logger.Fatalln("Flags --conventional-commits and --markdown-changelog are mutual exclusive")
+		} else {
+
 			var conventionalCommits []*conventional_commits.ConventionalCommitMessage
 
 			for _, commit := range commits {
@@ -55,16 +63,16 @@ var Command = cobra.Command{
 				conventionalCommits = append(conventionalCommits, conventionalCommit)
 			}
 
-			jsonResult, err := json.MarshalIndent(conventionalCommits, "", "  ")
+			if markdownChangelog {
+				fmt.Print(conventional_commits.ToMarkdown(conventionalCommits))
+			} else if outputAsConventionalCommits {
+				jsonResult, err := json.MarshalIndent(conventionalCommits, "", "  ")
 
-			if err != nil {
-				logger.Logger.Fatalln("Could not marshal json:", err)
-			}
+				if err != nil {
+					logger.Logger.Fatalln("Could not marshal json:", err)
+				}
 
-			fmt.Println(string(jsonResult))
-		} else {
-			for _, commit := range commits {
-				fmt.Print(commit)
+				fmt.Println(string(jsonResult))
 			}
 		}
 	},
@@ -73,4 +81,5 @@ var Command = cobra.Command{
 func init() {
 	Command.Flags().BoolVar(&excludePreReleases, "exclude-pre-releases", false, "Specifies if the log should exclude pre-release commits from the log.")
 	Command.Flags().BoolVar(&outputAsConventionalCommits, "conventional-commits", false, "Print only conventional commits, formatted as JSON. Non-parsable commits are omitted.")
+	Command.Flags().BoolVar(&markdownChangelog, "markdown", false, "Print changelog, formatted as markdown.")
 }

conventional_commits/change_type.go

@@ -10,36 +10,16 @@ const (
 	STYLE    ChangeType = "style"
 	DOCS     ChangeType = "docs"
 	REFACTOR ChangeType = "refactor"
+	CI       ChangeType = "ci"
 )
 
-func (c ChangeType) TriggersRelease() bool {
-	switch c {
-	case FEATURE:
-		return true
-	case FIX:
-		return true
-	}
-
-	return false
-}
-
-func (c ChangeType) ToChangelogString() string {
-	switch c {
-	case FEATURE:
-		return "Feature"
-	case FIX:
-		return "Fix"
-	case CHORE:
-		return "Maintenance"
-	case PERF:
-		return "Performance"
-	case STYLE:
-		return "Code style"
-	case DOCS:
-		return "Documentation"
-	case REFACTOR:
-		return "Refactoring"
-	}
-
-	return string(c)
+var ChangeTypePriorities = map[ChangeType]int{
+	FEATURE:  10,
+	FIX:      9,
+	PERF:     8,
+	DOCS:     7,
+	CHORE:    6,
+	CI:       5,
+	STYLE:    4,
+	REFACTOR: 3,
 }

conventional_commits/commit_message.go

@@ -19,7 +19,7 @@ type ConventionalCommitMessage struct {
 	ContainsBreakingChange bool                `json:"breaking_change,omitempty"`
 	Description            string              `json:"description"`
 	Body                   string              `json:"body,omitempty"`
-	Footer                 map[string][]string `json:"footer,omitempty"`
+	Footers                map[string][]string `json:"footers,omitempty"`
 }
 
 // inspired by https://www.conventionalcommits.org
@@ -61,7 +61,7 @@ func ParseCommitMessage(message string) (*ConventionalCommitMessage, error) {
 		ContainsBreakingChange: breakingChangeIndicator == "!",
 		Description:            match["Description"],
 		Body:                   body,
-		Footer:                 footer,
+		Footers:                footer,
 	}
 
 	commitMessage.ContainsBreakingChange = commitMessage.ContainsBreakingChange || commitMessage.footerHasBreakingChange()
@@ -108,11 +108,23 @@ func (c *ConventionalCommitMessage) Compare(other *ConventionalCommitMessage) in
 }
 
 func (c *ConventionalCommitMessage) footerHasBreakingChange() bool {
-	for key, _ := range c.Footer {
+	for key, _ := range c.Footers {
 		if breakingChangeRegex.MatchString(key) {
 			return true
 		}
 	}
 
 	return false
 }
+
+func (c *ConventionalCommitMessage) breakingChangeDescriptions() []string {
+	var ret []string
+
+	for key, value := range c.Footers {
+		if breakingChangeRegex.MatchString(key) {
+			ret = append(ret, value...)
+		}
+	}
+
+	return ret
+}

conventional_commits/commit_message_test.go

@@ -17,7 +17,7 @@ func TestParseCommitMessage_ParsesSimpleCommitMessage(t *testing.T) {
 			ChangeType:             "feat",
 			Description:            "my description",
 			ContainsBreakingChange: false,
-			Footer:                 map[string][]string{},
+			Footers:                map[string][]string{},
 		},
 		commitMessage,
 	)
@@ -36,7 +36,7 @@ func TestParseCommitMessage_ParsesSimpleCommitMessageWithCaseInsensitiveType(t *
 			ChangeType:             "feat",
 			Description:            "my description",
 			ContainsBreakingChange: false,
-			Footer:                 map[string][]string{},
+			Footers:                map[string][]string{},
 		},
 		commitMessage,
 	)
@@ -55,7 +55,7 @@ func TestParseCommitMessage_ParsesCommitMessageWithBreakingChangeIndicator(t *te
 			ChangeType:             "feat",
 			Description:            "my description",
 			ContainsBreakingChange: true,
-			Footer:                 map[string][]string{},
+			Footers:                map[string][]string{},
 		},
 		commitMessage,
 	)
@@ -75,7 +75,7 @@ func TestParseCommitMessage_ParsesCommitMessageWithBreakingChangeIndicatorAfterS
 			Scope:                  "scope",
 			Description:            "my description",
 			ContainsBreakingChange: true,
-			Footer:                 map[string][]string{},
+			Footers:                map[string][]string{},
 		},
 		commitMessage,
 	)
@@ -93,7 +93,7 @@ func TestParseCommitMessage_ParsesSimpleCommitMessageWithLineBreak(t *testing.T)
 		&ConventionalCommitMessage{
 			ChangeType:  "feat",
 			Description: "my description\nwith line break",
-			Footer: map[string][]string{},
+			Footers:     map[string][]string{},
 		},
 		commitMessage,
 	)
@@ -121,7 +121,7 @@ This is still the body
 			ChangeType:  "feat",
 			Description: "my description\nwith line break",
 			Body:        "and this is a body\n\nThis is still the body",
-			Footer: map[string][]string{},
+			Footers:     map[string][]string{},
 		},
 		commitMessage,
 	)
@@ -154,7 +154,7 @@ Custom-Token: Custom-Token-Value
 			ChangeType:  "feat",
 			Description: "my description\nwith line break",
 			Body:        "and this is a body\nwith line break\n\nthis is still the body",
-			Footer:      map[string][]string {
+			Footers:      map[string][]string {
 				"Fix": {"123", "http://example.com/123"},
 				"Custom-Token": {"Custom-Token-Value"},
 			},

conventional_commits/markdown.go

@@ -0,0 +1,125 @@
+package conventional_commits
+
+import (
+	"sort"
+	"strings"
+)
+
+func ToMarkdown(messages []*ConventionalCommitMessage) string {
+
+	var markDownParts []string
+
+	commitsContainingBreakingChanges := ByChangeTypeDesc(filterBreakingChanges(messages))
+	sort.Stable(commitsContainingBreakingChanges)
+
+	if len(commitsContainingBreakingChanges) > 0 {
+		markDownParts = append(markDownParts, markdownBreakingChanges(commitsContainingBreakingChanges))
+	}
+
+	features := filterByNonBreakingChangeType(FEATURE, messages)
+
+	if len(features) > 0 {
+		featuresString := "### Features\n\n"
+		featuresString += markdownSimpleChanges(features)
+		markDownParts = append(markDownParts, featuresString)
+	}
+
+	fixes := filterByNonBreakingChangeType(FIX, messages)
+
+	if len(fixes) > 0 {
+		fixesString := "### Bug Fixes\n\n"
+		fixesString += markdownSimpleChanges(fixes)
+		markDownParts = append(markDownParts, fixesString)
+	}
+
+	return strings.Join(markDownParts, "\n")
+}
+
+func markdownBreakingChanges(commitsContainingBreakingChanges ByChangeTypeDesc) string {
+	ret := "### BREAKING CHANGES\n\n"
+
+	for _, change := range commitsContainingBreakingChanges {
+
+		breakingChangeDescriptions := change.breakingChangeDescriptions()
+
+		if len(breakingChangeDescriptions) == 0 {
+			ret += "* "
+
+			if change.Scope != "" {
+				ret += "**" + change.Scope + "** "
+			}
+
+			ret += change.Description + "\n"
+
+			if change.Body != "" {
+				ret += "\n" + change.Body
+			}
+		} else {
+			for _, description := range breakingChangeDescriptions {
+
+				ret += "* "
+
+				if change.Scope != "" {
+					ret += "**" + change.Scope + "** "
+				}
+
+				ret += description + "\n"
+
+			}
+		}
+
+	}
+
+	return ret
+}
+
+func markdownSimpleChanges(changes []*ConventionalCommitMessage) string {
+	ret := ""
+
+	for _, change := range changes {
+		// skip breaking changes without separate description, because they are listed in another section
+		if change.ContainsBreakingChange && len(change.breakingChangeDescriptions()) == 0 {
+			continue
+		}
+
+		ret += "* "
+
+		if change.Scope != "" {
+			ret += "**" + change.Scope + "** "
+		}
+
+		ret += change.Description + "\n"
+
+		if change.Body != "" {
+			ret += change.Body
+			ret += "\n"
+		}
+
+	}
+
+	return ret
+}
+
+func filterBreakingChanges(messages []*ConventionalCommitMessage) []*ConventionalCommitMessage {
+	var ret []*ConventionalCommitMessage
+
+	for _, c := range messages {
+		if c.ContainsBreakingChange {
+			ret = append(ret, c)
+		}
+	}
+
+	return ret
+}
+
+func filterByNonBreakingChangeType(changeType ChangeType, messages []*ConventionalCommitMessage) []*ConventionalCommitMessage {
+	var ret []*ConventionalCommitMessage
+
+	for _, c := range messages {
+		if c.ChangeType == changeType {
+			ret = append(ret, c)
+		}
+	}
+
+	return ret
+}