Merge pull request #14 from artem-y/feat/wrap-each-issue-with-prefix-and-suffix

Wrap each issue with prefix and suffix

Author: artem-y

.commit.json

@@ -1,5 +1,7 @@
 {
     "issueRegex": "[0-9]+",
     "outputIssuePrefix": "#",
-    "outputIssueSuffix": ": "
+    "outputIssueSuffix": "",
+    "outputStringPrefix": "[",
+    "outputStringSuffix": "]: "
 }

Makefile

@@ -1,7 +1,7 @@
 # Build the current machine
 .PHONY: build
 build:
-	@go build -o bin/commit ./cmd/commit/
+	@go build -o bin/ ./cmd/commit/
 
 # Build for all platforms
 .PHONY: all
@@ -10,24 +10,31 @@ all: windows linux macos
 # Build for MacOS
 .PHONY: macos
 macos:
-	@GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w" -o bin/macos-amd64/commit ./cmd/commit/
-	@GOOS=darwin GOARCH=arm64 go build -ldflags "-s -w" -o bin/macos-arm64/commit ./cmd/commit/
+	@GOOS=darwin GOARCH=amd64 go build -ldflags "-s -w" -o bin/macos-amd64/ ./cmd/commit/
+	@GOOS=darwin GOARCH=arm64 go build -ldflags "-s -w" -o bin/macos-arm64/ ./cmd/commit/
 
 # Build for Linux
 .PHONY: linux
 linux:
-	@GOOS=linux GOARCH=386 go build -ldflags "-s -w" -o bin/linux-386/commit ./cmd/commit/
-	@GOOS=linux GOARCH=amd64 go build -ldflags "-s -w" -o bin/linux-amd64/commit ./cmd/commit/
-	@GOOS=linux GOARCH=arm go build -ldflags "-s -w" -o bin/linux-arm/commit ./cmd/commit/
-	@GOOS=linux GOARCH=arm64 go build -ldflags "-s -w" -o bin/linux-arm64/commit ./cmd/commit/
+	@GOOS=linux GOARCH=386 go build -ldflags "-s -w" -o bin/linux-386/ ./cmd/commit/
+	@GOOS=linux GOARCH=amd64 go build -ldflags "-s -w" -o bin/linux-amd64/ ./cmd/commit/
+	@GOOS=linux GOARCH=arm go build -ldflags "-s -w" -o bin/linux-arm/ ./cmd/commit/
+	@GOOS=linux GOARCH=arm64 go build -ldflags "-s -w" -o bin/linux-arm64/ ./cmd/commit/
 
 # Build for Windows
 .PHONY: windows
 windows:
-	@GOOS=windows GOARCH=386 go build -ldflags "-s -w" -o bin/windows-386/commit ./cmd/commit/
-	@GOOS=windows GOARCH=amd64 go build -ldflags "-s -w" -o bin/windows-amd64/commit ./cmd/commit/
-	@GOOS=windows GOARCH=arm go build -ldflags "-s -w" -o bin/windows-arm/commit ./cmd/commit/
-	@GOOS=windows GOARCH=arm64 go build -ldflags "-s -w" -o bin/windows-arm64/commit ./cmd/commit/
+	@GOOS=windows GOARCH=386 go build -ldflags "-s -w" -o bin/windows-386/ ./cmd/commit/
+	@GOOS=windows GOARCH=amd64 go build -ldflags "-s -w" -o bin/windows-amd64/ ./cmd/commit/
+	@GOOS=windows GOARCH=arm go build -ldflags "-s -w" -o bin/windows-arm/ ./cmd/commit/
+	@GOOS=windows GOARCH=arm64 go build -ldflags "-s -w" -o bin/windows-arm64/ ./cmd/commit/
+
+# Build and prepare a release archive for all platforms
+.PHONY: release
+release:
+	@make clean
+	@make all
+	@zip -r bin/bin.zip bin/
 
 # Clean the build artifacts
 .PHONY: clean

cmd/commit/main.go

@@ -19,13 +19,21 @@ import (
 
 func main() {
 	var configFilePath string
-
 	flag.StringVar(
 		&configFilePath,
 		"config-path",
 		helpers.DEFAULT_CONFIG_FILE_PATH,
 		"Path to the config json file",
 	)
+
+	var dryRun bool
+	flag.BoolVar(
+		&dryRun,
+		"dry-run",
+		false,
+		"Prints the commit message without making the actual commit",
+	)
+
 	flag.Parse()
 
 	commitMessage := getCommitMessage()
@@ -40,17 +48,12 @@ func main() {
 		matches := findIssueMatchesInBranch(cfg.IssueRegex, branchName)
 
 		if len(matches) > 0 {
-			joinedIssues := strings.Join(matches, ", ")
-			commitMessage = fmt.Sprintf(
-				"%s%s%s%s",
-				*cfg.OutputIssuePrefix,
-				joinedIssues,
-				*cfg.OutputIssueSuffix,
-				commitMessage,
-			)
+			commitMessage = generateCommitMessageWithMatches(matches, cfg, commitMessage)
 		}
 
-		commitChanges(repo, commitMessage)
+		if !dryRun {
+			commitChanges(repo, commitMessage)
+		}
 
 		fmt.Println(commitMessage)
 
@@ -117,6 +120,30 @@ func findIssueMatchesInBranch(rgxRaw string, branchName string) []string {
 	return matches
 }
 
+// Generates a commit message with the issue number matches and config settings
+func generateCommitMessageWithMatches(matches []string, cfg config.CommitConfig, commitMessage string) string {
+	mappedMatches := make([]string, len(matches))
+
+	for index, match := range matches {
+		wrappedIssueNumber := fmt.Sprintf(
+			"%s%s%s",
+			*cfg.OutputIssuePrefix,
+			match,
+			*cfg.OutputIssueSuffix,
+		)
+		mappedMatches[index] = wrappedIssueNumber
+	}
+
+	joinedIssues := strings.Join(mappedMatches, ", ")
+	return fmt.Sprintf(
+		"%s%s%s%s",
+		*cfg.OutputStringPrefix,
+		joinedIssues,
+		*cfg.OutputStringSuffix,
+		commitMessage,
+	)
+}
+
 // Creates commit options with the author information
 func makeCommitOptions(usr user.User) git.CommitOptions {
 	return git.CommitOptions{
@@ -155,7 +182,7 @@ func checkStagedChanges(worktree *git.Worktree) {
 	}
 
 	for _, status := range fileStatuses {
-		if status.Staging != git.Unmodified {
+		if status.Staging != git.Unmodified && status.Staging != git.Untracked {
 			return
 		}
 	}

docs/README.md

@@ -47,17 +47,21 @@ But this can be changed by setting different values in a `.commit.json` file at
 {  
     "issueRegex": "ABC-[0-9]+", 
     "outputIssuePrefix": "#",
-    "outputIssueSuffix": ": "
+    "outputIssueSuffix": "",
+    "outputStringPrefix": "",
+    "outputStringSuffix": ": ",
 }
 ```
 What each setting does:
 - **issueRegex**: This is how the tool determines what is the pattern to look for.
-- **outputIssuePrefix**: Precedes the generated part of the commit message.
-- **outputIssueSuffix**: Follows at the end of the generated part of the commit message.
+- **outputIssuePrefix**: Added before each issue.
+- **outputIssueSuffix**: Added after each issue.
+- **outputStringPrefix**: Precedes the generated part of the commit message.
+- **outputStringSuffix**: Follows at the end of the generated part of the commit message.
 
 The structure of the resulting commit message is as follows:  
 ```
-<outputIssuePrefix><issueRegex><outputIssueSuffix> <commit message>
+<outputStringPrefix><outputIssuePrefix><issueRegex><outputIssueSuffix>, <outputIssuePrefix><issueRegex><outputIssueSuffix><outputStringSuffix> <commit message>
 ```
 If the `.commit.json` file is not included, the tool will just fall back to its default settings (GitHub style issues).  
 Same will happen for any of the settings that is not included in the config json. See the default values in [constants.go](/internal/helpers/constants.go) file.
@@ -73,6 +77,11 @@ For example, the branch named `add-tests-for-CR-127-and-CR-131-features`, the is
 ## Testing
 So far I haven't added a lot of unit tests for this project, but I will be doing it in the future.  
 To run the tests, use the `make test` or `go test -v ./tests` commands.
+### Debug
+To check what commit message will be generated without making the actual commit, there is a `-dry-run` flag that can be passed to the command:
+```shell
+commit -dry-run "Not a real commit"
+```
 ## Contributing
 Originally I wrote this tool for myself in shell and Swift and used a lot on MacOS. This repo is an attempt to make it crossplatform and an opportunity to excercise in writing Go.  
 If you find it useful and see that something's wrong or missing, feel free to raise issues and contribute to the project.  

internal/config/config.go

@@ -8,16 +8,18 @@ import (
 	"github.com/artem-y/commit/internal/helpers"
 )
 
-type commitConfig struct {
-	IssueRegex        string  `json:"issueRegex"`
-	OutputIssuePrefix *string `json:"outputIssuePrefix"`
-	OutputIssueSuffix *string `json:"outputIssueSuffix"`
+type CommitConfig struct {
+	IssueRegex         string  `json:"issueRegex"`
+	OutputIssuePrefix  *string `json:"outputIssuePrefix"`
+	OutputIssueSuffix  *string `json:"outputIssueSuffix"`
+	OutputStringPrefix *string `json:"outputStringPrefix"`
+	OutputStringSuffix *string `json:"outputStringSuffix"`
 }
 
 // Reads config at the file path and unmarshals it into commitConfig struct
-func ReadCommitConfig(configFilePath string) commitConfig {
+func ReadCommitConfig(configFilePath string) CommitConfig {
 
-	var cfg commitConfig
+	var cfg CommitConfig
 
 	_, err := os.Stat(configFilePath)
 	if err == nil {
@@ -40,13 +42,23 @@ func ReadCommitConfig(configFilePath string) commitConfig {
 	}
 
 	if cfg.OutputIssuePrefix == nil {
-		defaultPrefix := helpers.DEFAULT_OUTPUT_ISSUE_PREFIX
-		cfg.OutputIssuePrefix = &defaultPrefix
+		defaultIssuePrefix := helpers.DEFAULT_OUTPUT_ISSUE_PREFIX
+		cfg.OutputIssuePrefix = &defaultIssuePrefix
 	}
 
 	if cfg.OutputIssueSuffix == nil {
-		defaultSuffix := helpers.DEFAULT_OUTPUT_ISSUE_SUFFIX
-		cfg.OutputIssueSuffix = &defaultSuffix
+		defaultIssueSuffix := helpers.DEFAULT_OUTPUT_ISSUE_SUFFIX
+		cfg.OutputIssueSuffix = &defaultIssueSuffix
+	}
+
+	if cfg.OutputStringPrefix == nil {
+		defaultStringPrefix := helpers.DEFAULT_OUTPUT_STRING_PREFIX
+		cfg.OutputStringPrefix = &defaultStringPrefix
+	}
+
+	if cfg.OutputStringSuffix == nil {
+		defaultStringSuffix := helpers.DEFAULT_OUTPUT_STRING_SUFFIX
+		cfg.OutputStringSuffix = &defaultStringSuffix
 	}
 
 	return cfg

internal/helpers/constants.go

@@ -1,8 +1,10 @@
 package helpers
 
 const (
-	DEFAULT_CONFIG_FILE_PATH    = ".commit.json"
-	DEFAULT_ISSUE_REGEX         = "[0-9]+"
-	DEFAULT_OUTPUT_ISSUE_PREFIX = "[#"
-	DEFAULT_OUTPUT_ISSUE_SUFFIX = "]: "
+	DEFAULT_CONFIG_FILE_PATH     = ".commit.json"
+	DEFAULT_ISSUE_REGEX          = "[0-9]+"
+	DEFAULT_OUTPUT_ISSUE_PREFIX  = "#"
+	DEFAULT_OUTPUT_ISSUE_SUFFIX  = ""
+	DEFAULT_OUTPUT_STRING_PREFIX = ""
+	DEFAULT_OUTPUT_STRING_SUFFIX = ": "
 )