style: refactor codebase for enhanced readability and formatting

- Add golines formatter to the golangci-lint configuration
- Reformat flag registrations to use multi-line style for readability and consistency
- Apply multi-line wrapping to function calls with long arguments and string formatting
- Improve error message construction by wrapping them in multi-line statements
- Increase code clarity around user confirmations and conditional checks
- Update test error reporting to use multi-line formatting for arguments
- No changes to program logic; only code readability, style, and formatting were improved

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

Author: appleboy

.golangci.yml

@@ -40,6 +40,7 @@ formatters:
     - gofmt
     - gofumpt
     - goimports
+    - golines
   exclusions:
     generated: lax
     paths:

cmd/cmd.go

@@ -34,8 +34,10 @@ const (
 func init() {
 	cobra.OnInitialize(initConfig)
 
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.config/codegpt/.codegpt.yaml)")
-	rootCmd.PersistentFlags().StringVar(&promptFolder, "prompt_folder", "", "prompt folder (default is $HOME/.config/codegpt/prompt)")
+	rootCmd.PersistentFlags().
+		StringVar(&cfgFile, "config", "", "config file (default is $HOME/.config/codegpt/.codegpt.yaml)")
+	rootCmd.PersistentFlags().
+		StringVar(&promptFolder, "prompt_folder", "", "prompt folder (default is $HOME/.config/codegpt/prompt)")
 	rootCmd.AddCommand(versionCmd)
 	rootCmd.AddCommand(configCmd)
 	rootCmd.AddCommand(commitCmd)

cmd/commit.go

@@ -45,22 +45,30 @@ var (
 
 func init() {
 	commitCmd.PersistentFlags().StringP("file", "f", "", "specify output file for commit message")
-	commitCmd.PersistentFlags().BoolVar(&preview, "preview", false, "preview commit message before committing")
+	commitCmd.PersistentFlags().
+		BoolVar(&preview, "preview", false, "preview commit message before committing")
 	commitCmd.PersistentFlags().IntVar(&diffUnified, "diff_unified", 3,
 		"generate diffs with <n> lines of context (default: 3)")
-	commitCmd.PersistentFlags().StringVar(&commitModel, "model", "gpt-4o", "specify which OpenAI model to use for generation")
-	commitCmd.PersistentFlags().StringVar(&commitLang, "lang", "en", "set output language for the commit message (default: English)")
+	commitCmd.PersistentFlags().
+		StringVar(&commitModel, "model", "gpt-4o", "specify which OpenAI model to use for generation")
+	commitCmd.PersistentFlags().
+		StringVar(&commitLang, "lang", "en", "set output language for the commit message (default: English)")
 	commitCmd.PersistentFlags().StringSliceVar(&excludeList, "exclude_list", []string{},
 		"specify files to exclude from git diff")
 	commitCmd.PersistentFlags().StringVar(&httpsProxy, "proxy", "", "set HTTP proxy URL")
 	commitCmd.PersistentFlags().StringVar(&socksProxy, "socks", "", "set SOCKS proxy URL")
-	commitCmd.PersistentFlags().StringVar(&templateFile, "template_file", "", "provide template file for commit message format")
-	commitCmd.PersistentFlags().StringVar(&templateString, "template_string", "", "provide inline template string for commit message format")
-	commitCmd.PersistentFlags().StringSliceVar(&templateVars, "template_vars", []string{}, "define custom variables for templates")
-	commitCmd.PersistentFlags().StringVar(&templateVarsFile, "template_vars_file", "", "specify file containing template variables")
+	commitCmd.PersistentFlags().
+		StringVar(&templateFile, "template_file", "", "provide template file for commit message format")
+	commitCmd.PersistentFlags().
+		StringVar(&templateString, "template_string", "", "provide inline template string for commit message format")
+	commitCmd.PersistentFlags().
+		StringSliceVar(&templateVars, "template_vars", []string{}, "define custom variables for templates")
+	commitCmd.PersistentFlags().
+		StringVar(&templateVarsFile, "template_vars_file", "", "specify file containing template variables")
 	commitCmd.PersistentFlags().BoolVar(&commitAmend, "amend", false,
 		"amend the previous commit instead of creating a new one")
-	commitCmd.PersistentFlags().DurationVarP(&timeout, "timeout", "t", defaultTimeout, "set API request timeout duration")
+	commitCmd.PersistentFlags().
+		DurationVarP(&timeout, "timeout", "t", defaultTimeout, "set API request timeout duration")
 	commitCmd.PersistentFlags().BoolVar(&promptOnly, "prompt_only", false,
 		"display the prompt without sending to OpenAI")
 	commitCmd.PersistentFlags().BoolVar(&noConfirm, "no_confirm", false,
@@ -196,7 +204,10 @@ var commitCmd = &cobra.Command{
 			}
 
 			// Lowercase the first character of first word of the commit message and remove the trailing period
-			summarizeTitle = strings.TrimRight(strings.ToLower(string(summarizeTitle[0]))+summarizeTitle[1:], ".")
+			summarizeTitle = strings.TrimRight(
+				strings.ToLower(string(summarizeTitle[0]))+summarizeTitle[1:],
+				".",
+			)
 			data[prompt.SummarizeTitleKey] = strings.TrimSpace(summarizeTitle)
 		}
 
@@ -268,7 +279,11 @@ var commitCmd = &cobra.Command{
 			}
 
 			// Translate git commit message
-			color.Cyan("Translating git commit message to " + prompt.GetLanguage(viper.GetString("output.lang")))
+			color.Cyan(
+				"Translating git commit message to " + prompt.GetLanguage(
+					viper.GetString("output.lang"),
+				),
+			)
 			resp, err := client.Completion(cmd.Context(), out)
 			if err != nil {
 				return err
@@ -306,7 +321,8 @@ var commitCmd = &cobra.Command{
 			if noConfirm {
 				return nil
 			}
-			if ready, err := confirmation.New("Commit this preview summary?", confirmation.Yes).RunPrompt(); err != nil || !ready {
+			if ready, err := confirmation.New("Commit this preview summary?", confirmation.Yes).RunPrompt(); err != nil ||
+				!ready {
 				if err != nil {
 					return err
 				}

cmd/config_set.go

@@ -26,8 +26,10 @@ func init() {
 	configSetCmd.Flags().IntP("max_tokens", "", 300, availableKeys["openai.max_tokens"])
 	configSetCmd.Flags().Float32P("temperature", "", 1.0, availableKeys["openai.temperature"])
 	configSetCmd.Flags().Float32P("top_p", "", 1.0, availableKeys["openai.top_p"])
-	configSetCmd.Flags().Float32P("frequency_penalty", "", 0.0, availableKeys["openai.frequency_penalty"])
-	configSetCmd.Flags().Float32P("presence_penalty", "", 0.0, availableKeys["openai.presence_penalty"])
+	configSetCmd.Flags().
+		Float32P("frequency_penalty", "", 0.0, availableKeys["openai.frequency_penalty"])
+	configSetCmd.Flags().
+		Float32P("presence_penalty", "", 0.0, availableKeys["openai.presence_penalty"])
 	configSetCmd.Flags().StringP("provider", "", "openai", availableKeys["openai.provider"])
 	configSetCmd.Flags().BoolP("skip_verify", "", false, availableKeys["openai.skip_verify"])
 	configSetCmd.Flags().StringP("headers", "", "", availableKeys["openai.headers"])
@@ -36,7 +38,8 @@ func init() {
 	// Gemini flags
 	configSetCmd.Flags().String("gemini.project_id", "", availableKeys["gemini.project_id"])
 	configSetCmd.Flags().String("gemini.location", "", availableKeys["gemini.location"])
-	configSetCmd.Flags().String("gemini.backend", "BackendGeminiAPI", availableKeys["gemini.backend"])
+	configSetCmd.Flags().
+		String("gemini.backend", "BackendGeminiAPI", availableKeys["gemini.backend"])
 	configSetCmd.Flags().String("gemini.api_key", "", availableKeys["gemini.api_key"])
 
 	_ = viper.BindPFlag("openai.base_url", configSetCmd.Flags().Lookup("base_url"))
@@ -76,7 +79,9 @@ var configSetCmd = &cobra.Command{
 	RunE: func(cmd *cobra.Command, args []string) error {
 		// Check if key is available
 		if _, ok := availableKeys[args[0]]; !ok {
-			return errors.New("config key is not available, please use `codegpt config list` to see the available keys")
+			return errors.New(
+				"config key is not available, please use `codegpt config list` to see the available keys",
+			)
 		}
 
 		// Set config value in viper

cmd/hepler.go

@@ -16,7 +16,9 @@ import (
 func check(ctx context.Context) error {
 	// Check if the Git command is available on the system's PATH
 	if !util.IsCommandAvailable("git") {
-		return errors.New("git command not found in your system's PATH. Please install Git and try again")
+		return errors.New(
+			"git command not found in your system's PATH. Please install Git and try again",
+		)
 	}
 
 	// Check if the current directory is a git repository and can execute git diff

cmd/prompt.go

@@ -59,7 +59,8 @@ When executed with the --load flag, it will copy all standard templates to your
 		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()
+		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
 		}

cmd/review.go

@@ -23,8 +23,10 @@ func init() {
 	reviewCmd.PersistentFlags().IntVar(&maxTokens, "max_tokens", 300,
 		"Maximum number of tokens to generate in the chat completion")
 	reviewCmd.PersistentFlags().StringVar(&commitModel, "model", "gpt-4o", "OpenAI model to use")
-	reviewCmd.PersistentFlags().StringVar(&commitLang, "lang", "en", "Language for summarization (default: English)")
-	reviewCmd.PersistentFlags().StringSliceVar(&excludeList, "exclude_list", []string{}, "Files to exclude from git diff")
+	reviewCmd.PersistentFlags().
+		StringVar(&commitLang, "lang", "en", "Language for summarization (default: English)")
+	reviewCmd.PersistentFlags().
+		StringSliceVar(&excludeList, "exclude_list", []string{}, "Files to exclude from git diff")
 	reviewCmd.PersistentFlags().BoolVar(&commitAmend, "amend", false,
 		"Replace the tip of the current branch by creating a new commit")
 	reviewCmd.PersistentFlags().BoolVar(&promptOnly, "prompt_only", false,

git/git_test.go

@@ -82,7 +82,10 @@ func TestCanExecuteGitDiff(t *testing.T) {
 
 		err = cmd.CanExecuteGitDiff(ctx)
 		if err != nil {
-			t.Errorf("CanExecuteGitDiff() should succeed in a git repository subdirectory, got error: %v", err)
+			t.Errorf(
+				"CanExecuteGitDiff() should succeed in a git repository subdirectory, got error: %v",
+				err,
+			)
 		}
 	})
 }

provider/openai/openai.go

@@ -58,7 +58,8 @@ func (c *Client) Completion(ctx context.Context, content string) (*core.Response
 func (c *Client) GetSummaryPrefix(ctx context.Context, content string) (*core.Response, error) {
 	var resp openai.ChatCompletionResponse
 	var err error
-	if checkOSeriesModels.MatchString(c.model) || strings.Contains(strings.ToLower(c.model), "deepseek") {
+	if checkOSeriesModels.MatchString(c.model) ||
+		strings.Contains(strings.ToLower(c.model), "deepseek") {
 		resp, err = c.CreateChatCompletion(ctx, content)
 		if err != nil || len(resp.Choices) != 1 {
 			return nil, err