Merge pull request #12 from muandane/feat/skipquestions

feature ✨ (src): added ability to skip questions

.goji.json

@@ -4,7 +4,7 @@
       "emoji": "✨",
       "code": ":sparkles:",
       "description": "Introduce new features.",
-      "name": "feature"
+      "name": "feat"
     },
     {
       "emoji": "🐛",

README.md

@@ -69,7 +69,7 @@ You can customize the `.goji.json` generated file to add or change the scopes, t
       "emoji": "✨",
       "code": ":sparkles:",
       "description": "Introducing new features.",
-      "name": "feature"
+      "name": "feat"
     },
     {
       "emoji": "🐛",
@@ -90,6 +90,10 @@ You can customize the `.goji.json` generated file to add or change the scopes, t
 }
 ```
 
+You can skip questions by adding them in `"SkipQuestions"`
+
+Only `"Scopes"` question can be skipped since it's optional according to the [Commit Spec](https://www.conventionalcommits.org/en/v1.0.0/)
+
 ## License
 
 Apache 2.0 license [Zine El Abidine Moualhi](https://www.linkedin.com/in/zinemoualhi/)

src/cmd/goji.go

@@ -19,7 +19,7 @@ func init() {
 }
 
 func main() {
-	version := "0.0.1-rc3"
+	version := "0.0.1-rc4"
 	helpFlag := flag.Bool("h", false, "Display help information")
 	flag.BoolVar(helpFlag, "help", false, "display help")
 	versionFlag := flag.Bool("v", false, "Display version information")
@@ -108,7 +108,7 @@ type initConfig struct {
 
 func AddCustomCommitTypes(gitmojis []Gitmoji) []Gitmoji {
 	customGitmojis := []Gitmoji{
-		{Emoji: "✨", Code: ":sparkles:", Description: "Introduce new features.", Name: "feature"},
+		{Emoji: "✨", Code: ":sparkles:", Description: "Introduce new features.", Name: "feat"},
 		{Emoji: "🐛", Code: ":bug:", Description: "Fix a bug.", Name: "fix"},
 		{Emoji: "📚", Code: ":books:", Description: "Documentation change.", Name: "docs"},
 		{Emoji: "🎨", Code: ":art:", Description: "Improve structure/format of the code.", Name: "refactor"},

src/pkg/config/config_test.go

@@ -1,14 +1,14 @@
 package config
 
 import (
-	"github.com/stretchr/testify/mock"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"strconv"
 	"strings"
 	"testing"
+
+	"github.com/stretchr/testify/mock"
 )
 
 func TestLoadConfig(t *testing.T) {
@@ -255,7 +255,7 @@ func (m *MockExec) Command(name string, arg ...string) *exec.Cmd {
 }
 func TestLoadConfig_Failure1(t *testing.T) {
 	// Create a temporary directory for the test
-	tmpDir, err := ioutil.TempDir("", "test")
+	tmpDir, err := os.MkdirTemp("", "test")
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -265,12 +265,10 @@ func TestLoadConfig_Failure1(t *testing.T) {
 
 	// Change the working directory to the temporary directory
 	os.Chdir(tmpDir)
-
 	// Try to load a non-existent config file
 	_, err = LoadConfig("non_existent_file.json")
 	if err == nil {
 		t.Errorf("Expected error, got nil")
 	}
 
-	// The test will succeed if there is any error (not just a 'file does not exist' error)
 }

src/pkg/utils/askQuestions.go

@@ -33,12 +33,15 @@ func AskQuestions(config *config.Config) (string, error) {
 		}
 	}
 
-	promptScope := &survey.Input{
-		Message: "Enter the scope of the change:",
-	}
-	err = askOneFunc(promptScope, &commitScope)
-	if err != nil {
-		return "", err
+	// Only ask for commitScope if not in SkipQuestions
+	if !isInSkipQuestions("Scopes", config.SkipQuestions) {
+		promptScope := &survey.Input{
+			Message: "Enter the scope of the change:",
+		}
+		err = askOneFunc(promptScope, &commitScope)
+		if err != nil {
+			return "", err
+		}
 	}
 
 	promptSubject := &survey.Input{
@@ -49,6 +52,21 @@ func AskQuestions(config *config.Config) (string, error) {
 		return "", err
 	}
 
-	commitMessage := fmt.Sprintf("%s (%s): %s", commitType, commitScope, commitSubject)
+	var commitMessage string
+	if commitScope == "" {
+		commitMessage = fmt.Sprintf("%s: %s", commitType, commitSubject)
+	} else {
+		commitMessage = fmt.Sprintf("%s (%s): %s", commitType, commitScope, commitSubject)
+	}
+
 	return commitMessage, nil
 }
+
+func isInSkipQuestions(value string, list []string) bool {
+	for _, v := range list {
+		if v == value {
+			return true
+		}
+	}
+	return false
+}

src/pkg/utils/commitMessage_test.go

@@ -2,11 +2,13 @@ package utils
 
 import (
 	"errors"
-	"github.com/AlecAivazis/survey/v2"
-	"github.com/stretchr/testify/mock"
 	"goji/pkg/config"
 	"goji/pkg/models"
 	"testing"
+
+	"github.com/AlecAivazis/survey/v2"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
 )
 
 func TestAskQuestions(t *testing.T) {
@@ -125,3 +127,19 @@ func TestAskQuestions_Failure(t *testing.T) {
 		t.Errorf("Expected commit message '', got '%s'", commitMessage)
 	}
 }
+func TestIsInSkipQuestions(t *testing.T) {
+	testCases := []struct {
+		skipQuestions []string
+		value         string
+		expected      bool
+	}{
+		{[]string{"types", "scopes", "message"}, "scopes", true},
+		{[]string{"types", "scopes", "message"}, "notInList", false},
+		{[]string{}, "scopes", false},
+	}
+
+	for _, tc := range testCases {
+		result := isInSkipQuestions(tc.value, tc.skipQuestions)
+		assert.Equal(t, tc.expected, result)
+	}
+}