feat: refactor prompt folder handling and update its configuration key (#228)

- Add detailed comments to the `initConfig` function to describe its steps and purpose
- Replace existing logic for handling the prompt folder with a switch-case structure
- Add `prompt.folder` configuration key to the list of available keys
- Add `prompt.folder` flag to `configSetCmd`
- Update the configuration key `prompt_folder` to `prompt.folder` in `helper.go`
- Enhance `prompt.go` to display the prompt folder path and improve confirmation prompt message

Signed-off-by: appleboy <[email protected]>

Author: appleboy

cmd/cmd.go

@@ -48,6 +48,25 @@ func init() {
 	rootCmd.CompletionOptions.HiddenDefaultCmd = true
 }
 
+// initConfig initializes the configuration for the application.
+// It sets up the configuration file, environment variables, and prompt folder.
+//
+// If a configuration file is specified by the cfgFile variable, it uses that file.
+// If the file does not exist, it creates a new one.
+// If no configuration file is specified, it searches for a configuration file
+// named ".codegpt.yaml" in the user's home directory under ".config/codegpt".
+//
+// The function also sets up environment variable handling to support multiple
+// CI/CD platforms, such as GitHub Actions and Drone CI, by setting the appropriate
+// environment variable prefixes.
+//
+// Additionally, it ensures that the prompt folder is correctly set up. If a prompt
+// folder is specified by the promptFolder variable, it verifies that it is a directory
+// and creates it if it does not exist. If no prompt folder is specified, it defaults
+// to a "prompt" directory under the ".config/codegpt" directory in the user's home.
+//
+// The function uses the Viper library for configuration management and the Cobra
+// library for error handling.
 func initConfig() {
 	if cfgFile != "" {
 		// Use config file from the flag.
@@ -78,30 +97,6 @@ func initConfig() {
 		}
 	}
 
-	if promptFolder != "" {
-		viper.Set("prompt_folder", promptFolder)
-		if file.IsFile(promptFolder) {
-			log.Fatalf("prompt folder %s is a file", promptFolder)
-		}
-		// create the prompt folder if it doesn't exist
-		if !file.IsDir(promptFolder) {
-			if err := os.MkdirAll(promptFolder, os.ModePerm); err != nil {
-				log.Fatal(err)
-			}
-		}
-	} else {
-		// Find home directory.
-		home, err := os.UserHomeDir()
-		cobra.CheckErr(err)
-		targetFolder := path.Join(home, ".config", "codegpt", "prompt")
-		if !file.IsDir(targetFolder) {
-			if err := os.MkdirAll(targetFolder, os.ModePerm); err != nil {
-				log.Fatal(err)
-			}
-		}
-		viper.Set("prompt_folder", targetFolder)
-	}
-
 	viper.AutomaticEnv()
 	viper.SetEnvKeyReplacer(replacer)
 
@@ -127,6 +122,49 @@ func initConfig() {
 			fmt.Fprintln(os.Stderr, err)
 		}
 	}
+
+	switch {
+	case promptFolder != "":
+		// If a prompt folder is specified by the promptFolder variable,
+		// check if it is a file. If it is, log a fatal error.
+		if file.IsFile(promptFolder) {
+			log.Fatalf("prompt folder %s is a file", promptFolder)
+		}
+		// If the prompt folder does not exist, create it.
+		if !file.IsDir(promptFolder) {
+			if err := os.MkdirAll(promptFolder, os.ModePerm); err != nil {
+				log.Fatal(err)
+			}
+		}
+		// Set the prompt folder in the configuration.
+		viper.Set("prompt.folder", promptFolder)
+	case viper.GetString("prompt.folder") != "":
+		// If the prompt folder is specified in the configuration,
+		// retrieve it and check if it is a file. If it is, log a fatal error.
+		promptFolder = viper.GetString("prompt.folder")
+		if file.IsFile(promptFolder) {
+			log.Fatalf("prompt folder %s is a file", promptFolder)
+		}
+		// If the prompt folder does not exist, create it.
+		if !file.IsDir(promptFolder) {
+			if err := os.MkdirAll(promptFolder, os.ModePerm); err != nil {
+				log.Fatal(err)
+			}
+		}
+	default:
+		// If no prompt folder is specified, use the default prompt folder
+		// under the ".config/codegpt" directory in the user's home directory.
+		home, err := os.UserHomeDir()
+		cobra.CheckErr(err)
+		targetFolder := path.Join(home, ".config", "codegpt", "prompt")
+		if !file.IsDir(targetFolder) {
+			if err := os.MkdirAll(targetFolder, os.ModePerm); err != nil {
+				log.Fatal(err)
+			}
+		}
+		// Set the prompt folder in the configuration.
+		viper.Set("prompt.folder", targetFolder)
+	}
 }
 
 func Execute(ctx context.Context) {

cmd/config_list.go

@@ -36,6 +36,7 @@ var availableKeys = map[string]string{
 	"openai.top_p":             "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.",
 	"openai.frequency_penalty": "Number between 0.0 and 1.0 that penalizes new tokens based on their existing frequency in the text so far. Decreases the model's likelihood to repeat the same line verbatim.",
 	"openai.presence_penalty":  "Number between 0.0 and 1.0 that penalizes new tokens based on whether they appear in the text so far. Increases the model's likelihood to talk about new topics.",
+	"prompt.folder":            "prompt template folder",
 }
 
 // configListCmd represents the command to list the configuration values.

cmd/config_set.go

@@ -32,6 +32,7 @@ func init() {
 	configSetCmd.Flags().BoolP("skip_verify", "", false, availableKeys["openai.skip_verify"])
 	configSetCmd.Flags().StringP("headers", "", "", availableKeys["openai.headers"])
 	configSetCmd.Flags().StringP("api_version", "", "", availableKeys["openai.api_version"])
+	configSetCmd.Flags().StringP("prompt_folder", "", "", availableKeys["prompt.folder"])
 	_ = viper.BindPFlag("openai.base_url", configSetCmd.Flags().Lookup("base_url"))
 	_ = viper.BindPFlag("openai.org_id", configSetCmd.Flags().Lookup("org_id"))
 	_ = viper.BindPFlag("openai.api_key", configSetCmd.Flags().Lookup("api_key"))
@@ -50,6 +51,7 @@ func init() {
 	_ = viper.BindPFlag("openai.skip_verify", configSetCmd.Flags().Lookup("skip_verify"))
 	_ = viper.BindPFlag("openai.headers", configSetCmd.Flags().Lookup("headers"))
 	_ = viper.BindPFlag("openai.api_version", configSetCmd.Flags().Lookup("api_version"))
+	_ = viper.BindPFlag("prompt.folder", configSetCmd.Flags().Lookup("prompt_folder"))
 }
 
 // configSetCmd updates the config value.

cmd/hepler.go

@@ -66,7 +66,7 @@ func check() error {
 	}
 
 	// load custom prompt
-	promptFolder := viper.GetString("prompt_folder")
+	promptFolder := viper.GetString("prompt.folder")
 	if promptFolder != "" {
 		if err := util.LoadTemplatesFromDir(promptFolder); err != nil {
 			return fmt.Errorf("failed to load custom prompt templates: %s", err)

cmd/prompt.go

@@ -39,12 +39,14 @@ var promptCmd = &cobra.Command{
 			return nil
 		}
 
-		confirm, err := confirmation.New("Do you want to load default prompt data, will overwrite your data", confirmation.No).RunPrompt()
+		folder := viper.GetString("prompt.folder")
+
+		color.Yellow("Prompt folder: %s", folder)
+		confirm, err := confirmation.New("Do you want to load the default prompt data? This will overwrite your existing data.", confirmation.No).RunPrompt()
 		if err != nil || !confirm {
 			return err
 		}
 
-		folder := viper.GetString("prompt_folder")
 		for _, key := range defaultPromptDataKeys {
 			if err := savePromptData(folder, key); err != nil {
 				return err