refactor(gitcommit): improve formatting and consistency

- update indentation and spacing across gitcommit extension files
- fix minor comment alignment and trailing comma issues in config example
- standardize function parameter documentation and formatting

Author: jinzhongjia

config_example_with_history.lua

@@ -5,7 +5,7 @@ require("codecompanion").setup({
     openai = function()
       return require("codecompanion.adapters").use("openai", {
         env = {
-          api_key = "your_api_key_here"
+          api_key = "your_api_key_here",
         },
       })
     end,
@@ -17,11 +17,11 @@ require("codecompanion").setup({
       adapter = "openai",
       model = "gpt-4-turbo-preview",
       languages = { "English", "Chinese" },
-      
+
       -- NEW: History commit context configuration
-      use_commit_history = true,        -- Enable using commit history as context
-      commit_history_count = 15,        -- Use 15 recent commits for context (default: 10)
-      
+      use_commit_history = true, -- Enable using commit history as context
+      commit_history_count = 15, -- Use 15 recent commits for context (default: 10)
+
       -- Existing configuration options
       buffer = {
         enabled = true,
@@ -30,7 +30,7 @@ require("codecompanion").setup({
         auto_generate_delay = 200,
         skip_auto_generate_on_amend = true,
       },
-      
+
       exclude_files = {
         "*.pb.go",
         "*.min.js",
@@ -41,18 +41,18 @@ require("codecompanion").setup({
         "build/*",
         "node_modules/*",
       },
-      
+
       add_git_tool = true,
       enable_git_read = true,
       enable_git_edit = true,
       enable_git_bot = true,
       git_tool_auto_submit_success = true,
-    })
+    }),
   },
 })
 
 -- Alternative configuration with history disabled
 -- require("codecompanion._extensions.gitcommit").setup({
 --   use_commit_history = false,  -- Disable history context
 --   -- ... other options
--- })
+-- })

lua/codecompanion/_extensions/gitcommit/buffer.lua

@@ -114,14 +114,14 @@ function Buffer._generate_and_insert_commit_message(bufnr)
 
   Langs.select_lang(function(lang)
     vim.notify("Generating commit message...", vim.log.levels.INFO)
-    
+
     -- Get commit history if enabled
     local commit_history = nil
     local git_config = Git.get_config and Git.get_config() or {}
     if git_config.use_commit_history then
       commit_history = Git.get_commit_history(git_config.commit_history_count)
     end
-    
+
     -- Generate commit message using LLM
     Generator.generate_commit_message(diff, lang, commit_history, function(result, error)
       if error then

lua/codecompanion/_extensions/gitcommit/generator.lua

@@ -64,18 +64,19 @@ end
 
 ---Create prompt for commit message generation
 ---@param diff string The git diff to include in prompt
- ---@param commit_history? string[] Array of recent commit messages for context (optional)
- function Generator._create_prompt(diff, lang, commit_history)
-   -- Build the history context section
-   local history_context = ""
-   if commit_history and #commit_history > 0 then
-     history_context = "\nRECENT COMMIT HISTORY (for style reference):\n"
-     for i, commit_msg in ipairs(commit_history) do
-       history_context = history_context .. string.format("%d. %s\n", i, commit_msg)
-     end
-     history_context = history_context .. "\nAnalyze the above commit history to understand the project's commit style, tone, and format patterns. Use this as guidance to maintain consistency.\n"
-   end
- 
+---@param commit_history? string[] Array of recent commit messages for context (optional)
+function Generator._create_prompt(diff, lang, commit_history)
+  -- Build the history context section
+  local history_context = ""
+  if commit_history and #commit_history > 0 then
+    history_context = "\nRECENT COMMIT HISTORY (for style reference):\n"
+    for i, commit_msg in ipairs(commit_history) do
+      history_context = history_context .. string.format("%d. %s\n", i, commit_msg)
+    end
+    history_context = history_context
+      .. "\nAnalyze the above commit history to understand the project's commit style, tone, and format patterns. Use this as guidance to maintain consistency.\n"
+  end
+
   return string.format(
     [[You are a commit message generator. Generate exactly ONE complete Conventional Commit message for the provided git diff.%s
 

lua/codecompanion/_extensions/gitcommit/git.lua

@@ -347,7 +347,7 @@ end
 ---@return string[]|nil commit_messages Array of commit messages or nil on error
 function Git.get_commit_history(count)
   count = count or 10
-  
+
   -- Use pcall to safely execute git operations
   local ok, result = pcall(function()
     if not Git.is_repository() then
@@ -358,22 +358,22 @@ function Git.get_commit_history(count)
     -- Use --pretty=format to get just the commit message
     local cmd = string.format("git log --pretty=format:%%s --no-merges -%d", count)
     local output = vim.fn.system(cmd)
-    
+
     if vim.v.shell_error ~= 0 then
       return nil
     end
 
     -- Split output into lines and filter out empty lines
     local lines = vim.split(output, "\n")
     local commit_messages = {}
-    
+
     for _, line in ipairs(lines) do
       local trimmed = trim(line)
       if trimmed ~= "" then
         table.insert(commit_messages, trimmed)
       end
     end
-    
+
     return commit_messages
   end)
 

lua/codecompanion/_extensions/gitcommit/init.lua

@@ -32,14 +32,14 @@ function M.generate_commit_message()
 
   Langs.select_lang(function(lang)
     vim.notify("Generating commit message...", vim.log.levels.INFO)
-    
+
     -- Get commit history if enabled
     local commit_history = nil
     local git_config = Git.get_config and Git.get_config() or {}
     if git_config.use_commit_history then
       commit_history = Git.get_commit_history(git_config.commit_history_count)
     end
-    
+
     -- Generate commit message using LLM
     Generator.generate_commit_message(diff, lang, commit_history, function(result, error)
       if error then
@@ -276,7 +276,7 @@ return {
   setup = function(opts)
     opts = vim.tbl_deep_extend("force", Config.default_opts, opts or {})
 
-    Git.setup({ 
+    Git.setup({
       exclude_files = opts.exclude_files,
       use_commit_history = opts.use_commit_history,
       commit_history_count = opts.commit_history_count,

lua/codecompanion/_extensions/gitcommit/types.lua

@@ -53,7 +53,7 @@
 ---@field get_staged_diff fun(): string|nil -- Get git diff for staged changes
 ---@field commit_changes fun(message: string): boolean -- Commit changes with the provided message
 
- ---@field generate_commit_message fun(diff: string,lang: string?, commit_history: string[]?, callback: fun(result: string|nil, error: string|nil)): nil -- Generate commit message using LLM
+---@field generate_commit_message fun(diff: string,lang: string?, commit_history: string[]?, callback: fun(result: string|nil, error: string|nil)): nil -- Generate commit message using LLM
 
 ---@class CodeCompanion.GitCommit.UI
 ---@field show_commit_message fun(message: string, on_commit: fun(message: string): boolean): nil -- Show commit message in a floating window with interactive options