refactor: refactor configuration handling and helper functions

- Add available keys to the `config.go` file - Replace a comment about a Git command with a more general one in the `helper.go` file - Update Viper configuration values based on CLI flags in the `helper.go` file - Check if the template file specified in the configuration exists in the `helper.go` file Signed-off-by: Bo-Yi.Wu <appleboy.tw@gmail.com>
appleboy · Apr 15, 2023 · 182cea6 · 182cea6
1 parent 92b3564
commit 182cea6
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/cmd/config.go b/cmd/config.go
@@ -26,7 +26,6 @@ var availableKeys = []string{
 	"openai.timeout",
 	"openai.max_tokens",
 	"openai.temperature",
-
 	"openai.provider",
 	"openai.model_name",
 }
@@ -74,18 +73,25 @@ var configCmd = &cobra.Command{
 	Short: "Add openai config (openai.api_key, openai.model ...)",
 	Args:  cobra.MinimumNArgs(3),
 	RunE: func(cmd *cobra.Command, args []string) error {
+		// Check if command is 'set'
 		if args[0] != "set" {
 			return errors.New("config set key value. ex: config set openai.api_key sk-...")
 		}
 
+		// Check if key is available
 		if !array.InSlice(args[1], availableKeys) {
 			return errors.New("available key list: " + strings.Join(availableKeys, ", "))
 		}
 
+		// Set config value in viper
 		viper.Set(args[1], args[2])
+
+		// Write config to file
 		if err := viper.WriteConfig(); err != nil {
 			return err
 		}
+
+		// Print success message with config file location
 		color.Green("you can see the config file: %s", viper.ConfigFileUsed())
 		return nil
 	},

diff --git a/cmd/hepler.go b/cmd/hepler.go
@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"errors"
+	"fmt"
 
 	"github.com/appleboy/CodeGPT/openai"
 	"github.com/appleboy/CodeGPT/prompt"
@@ -12,11 +13,12 @@ import (
 )
 
 func check() error {
-	// check git command exist
+	// Check if the Git command is available on the system's PATH
 	if !util.IsCommandAvailable("git") {
 		return errors.New("Git command not found on your system's PATH. Please install Git and try again.")
 	}
 
+	// Update Viper configuration values based on the CLI flags
 	if diffUnified != 3 {
 		viper.Set("git.diff_unified", diffUnified)
 	}
@@ -25,12 +27,10 @@ func check() error {
 		viper.Set("git.exclude_list", excludeList)
 	}
 
-	// check default language
 	if prompt.GetLanguage(commitLang) != prompt.DefaultLanguage {
 		viper.Set("output.lang", commitLang)
 	}
 
-	// check default model
 	if openai.GetModel(commitModel) != openai.DefaultModel {
 		viper.Set("openai.model", commitModel)
 	}
@@ -55,10 +55,10 @@ func check() error {
 		viper.Set("git.template_string", templateString)
 	}
 
-	if viper.GetString("git.template_file") != "" {
-		if !file.IsFile(viper.GetString("git.template_file")) {
-			return errors.New("template file not found: " + viper.GetString("git.template_file"))
-		}
+	// Check if the template file specified in the configuration exists
+	templateFile := viper.GetString("git.template_file")
+	if templateFile != "" && !file.IsFile(templateFile) {
+		return fmt.Errorf("template file not found: %s", templateFile)
 	}
 
 	return nil