refactor(git): improve formatting and readability in release notes

- adjust whitespace and indentation for consistency in generate_release_notes
- split long lines and clarify string concatenation for error messages
- fix minor formatting issues in contributors and commit grouping sections
- update git_read to use multiline assignment for generate_release_notes call

Author: jinzhongjia

lua/codecompanion/_extensions/gitcommit/tools/git.lua

@@ -699,7 +699,7 @@ end
 ---@return string llm_msg
 function GitTool.generate_release_notes(from_tag, to_tag, format)
   format = format or "markdown"
-  
+
   -- Get all tags sorted by version
   local success, tags_output = pcall(vim.fn.system, "git tag --sort=-version:refname")
   if not success or vim.v.shell_error ~= 0 then
@@ -708,26 +708,26 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
     local llm_msg = "<gitReleaseNotes>fail: " .. msg .. "</gitReleaseNotes>"
     return false, msg, user_msg, llm_msg
   end
-  
+
   local tags = {}
   for tag in tags_output:gmatch("[^\r\n]+") do
     if tag ~= "" then
       table.insert(tags, tag)
     end
   end
-  
+
   if #tags < 1 then
     local msg = "No tags found in repository"
     local user_msg = msg
     local llm_msg = "<gitReleaseNotes>fail: " .. msg .. "</gitReleaseNotes>"
     return false, msg, user_msg, llm_msg
   end
-  
+
   -- Determine tag range
   if not to_tag then
     to_tag = tags[1] -- Latest tag
   end
-  
+
   if not from_tag then
     if #tags < 2 then
       local msg = "Cannot generate release notes: only one tag found. Please specify from_tag parameter."
@@ -737,19 +737,24 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
     end
     from_tag = tags[2] -- Second latest tag
   end
-  
+
   -- Get commit range between tags
   local range = from_tag .. ".." .. to_tag
   local commit_cmd = "git log --pretty=format:'%h|%s|%an|%ad' --date=short " .. range
   local success_commits, commits_output = pcall(vim.fn.system, commit_cmd)
-  
+
   if not success_commits or vim.v.shell_error ~= 0 then
-    local msg = "Failed to get commits between " .. from_tag .. " and " .. to_tag .. ": " .. (commits_output or "unknown error")
+    local msg = "Failed to get commits between "
+      .. from_tag
+      .. " and "
+      .. to_tag
+      .. ": "
+      .. (commits_output or "unknown error")
     local user_msg = msg
     local llm_msg = "<gitReleaseNotes>fail: " .. msg .. "</gitReleaseNotes>"
     return false, msg, user_msg, llm_msg
   end
-  
+
   -- Parse commits
   local commits = {}
   for line in commits_output:gmatch("[^\r\n]+") do
@@ -759,32 +764,32 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
         hash = hash,
         subject = subject,
         author = author,
-        date = date
+        date = date,
       })
     end
   end
-  
+
   if #commits == 0 then
     local msg = "No commits found between " .. from_tag .. " and " .. to_tag
     local user_msg = msg
     local llm_msg = "<gitReleaseNotes>success: " .. msg .. "</gitReleaseNotes>"
     return true, msg, user_msg, llm_msg
   end
-  
+
   -- Generate release notes based on format
   local release_notes = ""
   local user_msg = ""
   local llm_msg = ""
-  
+
   if format == "markdown" then
     release_notes = "# Release Notes: " .. from_tag .. " → " .. to_tag .. "\n\n"
     release_notes = release_notes .. "## Changes (" .. #commits .. " commits)\n\n"
-    
+
     -- Group commits by type (conventional commits)
     local features = {}
     local fixes = {}
     local others = {}
-    
+
     for _, commit in ipairs(commits) do
       local type_match = commit.subject:match("^(%w+):")
       if type_match then
@@ -799,7 +804,7 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
         table.insert(others, commit)
       end
     end
-    
+
     -- Add features
     if #features > 0 then
       release_notes = release_notes .. "### ✨ New Features\n\n"
@@ -808,7 +813,7 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
       end
       release_notes = release_notes .. "\n"
     end
-    
+
     -- Add fixes
     if #fixes > 0 then
       release_notes = release_notes .. "### 🐛 Bug Fixes\n\n"
@@ -817,7 +822,7 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
       end
       release_notes = release_notes .. "\n"
     end
-    
+
     -- Add other changes
     if #others > 0 then
       release_notes = release_notes .. "### 📝 Other Changes\n\n"
@@ -826,7 +831,7 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
       end
       release_notes = release_notes .. "\n"
     end
-    
+
     -- Add contributors
     local contributors = {}
     for _, commit in ipairs(commits) do
@@ -835,7 +840,7 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
       end
       contributors[commit.author] = contributors[commit.author] + 1
     end
-    
+
     release_notes = release_notes .. "### 👥 Contributors\n\n"
     local sorted_authors = {}
     for author in pairs(contributors) do
@@ -850,34 +855,30 @@ function GitTool.generate_release_notes(from_tag, to_tag, format)
     for _, author in ipairs(sorted_authors) do
       release_notes = release_notes .. "- " .. author .. " (" .. contributors[author] .. " commits)\n"
     end
-    end
-    
   elseif format == "plain" then
     release_notes = "Release Notes: " .. from_tag .. " → " .. to_tag .. "\n"
     release_notes = release_notes .. "Changes (" .. #commits .. " commits):\n\n"
     for _, commit in ipairs(commits) do
       release_notes = release_notes .. "- " .. commit.subject .. " (" .. commit.hash .. " by " .. commit.author .. ")\n"
     end
-    
   elseif format == "json" then
     local json_data = {
       from_tag = from_tag,
       to_tag = to_tag,
       total_commits = #commits,
-      commits = commits
+      commits = commits,
     }
     release_notes = vim.fn.json_encode(json_data)
-    
   else
     local msg = "Unsupported format: " .. format .. ". Supported formats: markdown, plain, json"
     local user_msg = msg
     local llm_msg = "<gitReleaseNotes>fail: " .. msg .. "</gitReleaseNotes>"
     return false, msg, user_msg, llm_msg
   end
-  
+
   user_msg = "Generated release notes for " .. from_tag .. " → " .. to_tag .. " (" .. #commits .. " commits)"
   llm_msg = "<gitReleaseNotes>success: " .. user_msg .. "\n\n" .. release_notes .. "</gitReleaseNotes>"
-  
+
   return true, release_notes, user_msg, llm_msg
 end
 

lua/codecompanion/_extensions/gitcommit/tools/git_read.lua

@@ -196,7 +196,8 @@ GitRead.cmds = {
       elseif operation == "tags" then
         success, output, user_msg, llm_msg = GitTool.get_tags()
       elseif operation == "generate_release_notes" then
-        success, output, user_msg, llm_msg = GitTool.generate_release_notes(op_args.from_tag, op_args.to_tag, op_args.release_format)
+        success, output, user_msg, llm_msg =
+          GitTool.generate_release_notes(op_args.from_tag, op_args.to_tag, op_args.release_format)
       elseif operation == "gitignore_get" then
         success, output, user_msg, llm_msg = GitTool.get_gitignore()
       elseif operation == "gitignore_check" then