docs: Update package and function level documentations

cmd/commit.go

@@ -79,6 +79,10 @@ var commitCmd = &cobra.Command{
 			coAuthors, err = commit.PromptForCoAuthors(prompt.Prompt{
 				Label: "Select authors that are involded",
 			})
+			if err != nil {
+				fmt.Println("Prompt failed:", err)
+				os.Exit(1)
+			}
 		}
 
 		isBreakingChange, err := commit.PromptForBool(prompt.Prompt{

pkg/author/author.go

@@ -1,36 +1,30 @@
 package author
 
 import (
-	"fmt"
 	"os/exec"
-	"regexp"
 	"strings"
 )
 
-func extractNameAndEmail(line string) []string {
-	pattern := `(\w[\w\s]+)\s+<([^>]+)>`
-	re := regexp.MustCompile(pattern)
-	return re.FindStringSubmatch(line)
-}
-
+// GetSuggestedCoAuthors retrieves a list of suggested co-authors who have made commits in the Git repository.
+//
+// This function uses the `git log` command to obtain a list of authors who have made commits in the Git repository.
+// It executes the command and processes the output to extract author names and email addresses. The resulting
+// list represents suggested co-authors for Git commits.
 func GetSuggestedCoAuthors() ([]string, error) {
 	// Use the `git rev-list` command to obtain a list of authors who have made commits in the Git repository.
 	revlist := "git log --pretty='%an <%ae>' | sort -u"
 	cmd := exec.Command("bash", "-c", revlist)
 	output, err := cmd.CombinedOutput()
-
 	if err != nil {
 		return nil, err
 	}
 
 	authorString := strings.TrimSpace(string(output))
 
-	strings.Replace(authorString, `\n`, "\n", -1)
+	authorString = strings.ReplaceAll(authorString, `\n`, "\n")
 
 	// Parse the output to extract author names and email addresses.
 	suggestedCoAuthors := strings.Split(authorString, "\n")
 
-	fmt.Println("suggested authors", suggestedCoAuthors)
-
 	return suggestedCoAuthors, nil
 }

pkg/commit/commit_helpers.go → pkg/commit/commit.go

@@ -1,6 +1,14 @@
+/*
+Package commit provides functionality for creating Git commits.
+
+This file includes utility functions for interacting with Git and creating Git commits.
+
+Copyright © 2023 HENRI REMONEN <henri@remonen.fi>
+*/
 package commit
 
 import (
+	"fmt"
 	"os"
 	"os/exec"
 	"strings"
@@ -28,7 +36,7 @@ func GetStagedFiles() ([]string, error) {
 }
 
 // CreateCommitMessage creates a commit message in the Conventional Commits format.
-func CreateCommitMessage(commitInfo CommitInfo) string {
+func createCommitMessage(commitInfo CommitInfo) string {
 	commitMessage := commitInfo.CommitType
 	if commitInfo.CommitScope != "" {
 		commitMessage += "(" + commitInfo.CommitScope + ")"
@@ -44,7 +52,6 @@ func CreateCommitMessage(commitInfo CommitInfo) string {
 		commitMessage += "\n\n" + commitInfo.CommitBody
 	}
 
-	//Add space between body and footer as per the spec
 	if commitInfo.IsBreakingChange {
 		commitMessage += "\n\n"
 	}
@@ -58,7 +65,10 @@ func CreateCommitMessage(commitInfo CommitInfo) string {
 
 // CreateGitCommit creates a Git commit with the given message and files.
 func CreateGitCommit(commitInfo CommitInfo, files []string) error {
-	commitMessage := CreateCommitMessage(commitInfo)
+	commitMessage := createCommitMessage(commitInfo)
+
+	fmt.Println(commitMessage, files)
+
 	commitArgs := append([]string{"commit", "-m", commitMessage}, files...)
 
 	commitGitCmd := exec.Command("git", commitArgs...) //nolint:gosec // because I do not think the users can do anything bad here

pkg/commit/commit_info.go

@@ -1,5 +1,20 @@
+/*
+Package commit provides functionality for creating Git commits.
+
+The CommitInfo struct in this package represents information needed for creating a Git commit. It includes fields for specifying the commit type, scope, description, body, co-authors, and breaking change details.
+
+Usage:
+  - Create instances of the CommitInfo struct to define commit information.
+  - Set the CommitType, CommitDescription, and other fields to configure the commit.
+  - Optionally, add co-authors to the CoAuthors field if the commit is co-authored.
+  - Use the IsBreakingChange field to indicate whether the commit introduces a breaking change.
+  - For more information on how to use the CommitInfo struct and create Git commits, refer to the package-specific functions and commands.
+
+Copyright © 2023 HENRI REMONEN <henri@remonen.fi>
+*/
 package commit
 
+// CommitInfo represents information needed for creating a Git commit.
 type CommitInfo struct {
 	CommitType                string
 	CommitScope               string

pkg/commit/prompts.go

@@ -1,3 +1,10 @@
+/*
+Package commit provides functionality for creating Git commits.
+
+This file includes utility functions for interacting with the user.
+
+Copyright © 2023 HENRI REMONEN <henri@remonen.fi>
+*/
 package commit
 
 import (
@@ -60,6 +67,11 @@ func PromptForMultilineString(prompt prompt.Prompt) (string, error) {
 	return strings.Join(lines, "\n"), nil
 }
 
+// PromptForCoAuthors displays a prompt to select or enter co-authors for a Git commit.
+//
+// This function retrieves a list of suggested co-authors using the GetSuggestedCoAuthors function
+// from the author package. It then presents the user with a selectable list of suggested co-authors
+// and allows them to choose from the suggestions or enter custom co-authors.
 func PromptForCoAuthors(prompt prompt.Prompt) ([]string, error) {
 	suggestedCoAuthors, err := author.GetSuggestedCoAuthors()
 	if err != nil {

pkg/validators/string_validators.go

@@ -2,13 +2,15 @@ package validators
 
 import "fmt"
 
+// ValidateStringNotEmpty checks if a string is not empty.
 func ValidateStringNotEmpty(s string) error {
 	if len(s) > 0 {
 		return nil
 	}
 	return fmt.Errorf("please enter a valid string")
 }
 
+// ValidateStringYesNo checks if a string is "yes" or "no" (case-insensitive).
 func ValidateStringYesNo(s string) error {
 	if s == "Y" || s == "N" || s == "y" || s == "n" {
 		return nil