feat(git): push with async (#6)

Author: jinzhongjia

GEMINI.md

@@ -11,6 +11,12 @@ This project is a CodeCompanion extension designed to generate AI-powered Git co
 - **File Filtering**: Supports glob patterns to exclude generated files from analysis.
 - **Natural Language Interface**: Enables controlling Git workflows through conversational commands.
 
+## Development Principles
+
+- **No Plenary**: The use of the `plenary.nvim` library is prohibited. Instead, leverage Neovim's built-in `vim.uv` library for I/O and other system-level operations.
+- **Asynchronous by Default**: For any operation that could be time-consuming (e.g., network requests, file system operations), always prefer an asynchronous implementation to avoid blocking the main thread.
+- **Comprehensive Feedback**: Regardless of the outcome, every asynchronous operation must report its result (both success and failure) back to the language model. This ensures the LLM is always aware of the state of the tool.
+
 ## Installation:
 
 Add this extension to your CodeCompanion configuration in `init.lua` or similar:
@@ -70,4 +76,4 @@ Key configurable options include LLM adapter and model, supported languages, fil
 
 ## License:
 
-MIT License
+MIT License

README.md

@@ -42,7 +42,7 @@ require("codecompanion").setup({
 
         -- Feature toggles
         add_slash_command = true,      -- Add /gitcommit slash command
-        add_git_tool = true,          -- Add @git_read and @git_edit tools
+        add_git_tool = true,          -- Add @git_read and @git_edit tools, and @git_bot tool group
         add_git_commands = true,      -- Add :CodeCompanionGit commands
       }
     }

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

@@ -434,6 +434,68 @@ function GitTool.push(remote, branch, force, tags, tag_name)
   return execute_git_command(cmd)
 end
 
+---Push changes to a remote repository asynchronously
+---@param remote? string The name of the remote to push to (e.g., origin)
+---@param branch? string The name of the branch to push (defaults to current branch)
+---@param force? boolean Force push (DANGEROUS: overwrites remote history)
+---@param set_upstream? boolean Set the upstream branch
+---@param tags? boolean Push all tags
+---@param tag_name? string The name of a single tag to push
+---@param on_exit function The callback function to execute on completion
+function GitTool.push_async(remote, branch, force, set_upstream, tags, tag_name, on_exit)
+  local cmd = { "git", "push" }
+  if force then
+    table.insert(cmd, "--force")
+  end
+  if set_upstream then
+    table.insert(cmd, "--set-upstream")
+  end
+  if tags then
+    table.insert(cmd, "--tags")
+  end
+  if tag_name then
+    table.insert(cmd, "tag")
+    table.insert(cmd, tag_name)
+  end
+  if remote then
+    table.insert(cmd, remote)
+  end
+  if branch then
+    table.insert(cmd, branch)
+  end
+
+  local stdout_lines = {}
+  local stderr_lines = {}
+
+  vim.fn.jobstart(cmd, {
+    on_stdout = function(_, data)
+      if data then
+        for _, line in ipairs(data) do
+          if line ~= "" then
+            table.insert(stdout_lines, line)
+          end
+        end
+      end
+    end,
+    on_stderr = function(_, data)
+      if data then
+        for _, line in ipairs(data) do
+          if line ~= "" then
+            table.insert(stderr_lines, line)
+          end
+        end
+      end
+    end,
+    on_exit = function(_, code)
+      if code == 0 then
+        on_exit({ status = "success", data = table.concat(stdout_lines, "\n") })
+      else
+        on_exit({ status = "error", data = table.concat(stderr_lines, "\n") })
+      end
+    end,
+  })
+end
+
 ---Perform a git rebase operation
 
 ---@param onto? string The branch to rebase onto

lua/codecompanion/_extensions/gitcommit/tools/git_edit.lua

@@ -107,6 +107,10 @@ GitEdit.schema = {
               type = "boolean",
               description = "Force push (DANGEROUS: overwrites remote history)",
             },
+            set_upstream = {
+              type = "boolean",
+              description = "Set the upstream branch for the current local branch",
+            },
             tags = {
               type = "boolean",
               description = "Push all tags",
@@ -162,13 +166,14 @@ Best practices:
 • Auto-generation analyzes staged changes and creates Conventional Commit compliant messages
 • Use format: type(scope): description with lowercase type and imperative verb description
 • Include body with bullet points for complex changes, keep description under 50 characters
+• Use the `set_upstream` option to create and track a remote branch if it doesn't exist
 • Avoid force push operations that rewrite history
 • Ensure file paths and branch names are valid
 
 Available operations: stage, unstage, commit, create_branch, checkout, stash, apply_stash, reset, gitignore_add, gitignore_remove, push, cherry_pick, revert, create_tag, delete_tag, merge, help]]
 
 GitEdit.cmds = {
-  function(self, args, input)
+  function(self, args, input, output_handler)
     local operation = args.operation
     local op_args = args.args or {}
 
@@ -193,6 +198,18 @@ Available write-access Git operations:
       return { status = "success", data = help_text }
     end
 
+    if operation == "push" then
+      return GitTool.push_async(
+        op_args.remote,
+        op_args.branch,
+        op_args.force,
+        op_args.set_upstream,
+        op_args.tags,
+        op_args.single_tag_name,
+        output_handler
+      )
+    end
+
     local success, output
 
     if operation == "stage" then
@@ -255,8 +272,6 @@ Available write-access Git operations:
         return { status = "error", data = "No rule(s) specified for .gitignore remove" }
       end
       success, output = GitTool.remove_gitignore_rule(rules)
-    elseif operation == "push" then
-      success, output = GitTool.push(op_args.remote, op_args.branch, op_args.force, op_args.tags, op_args.tag_name)
     elseif operation == "cherry_pick" then
       if not op_args.cherry_pick_commit_hash then
         return { status = "error", data = "Commit hash is required for cherry-pick" }
@@ -310,8 +325,9 @@ GitEdit.output = {
   end,
   error = function(self, agent, cmd, stderr, stdout)
     local chat = agent.chat
-    local error_msg = stderr[1] or "Git edit operation failed"
-    local user_msg = "Git edit operation failed"
+    local operation = self.args.operation
+    local error_msg = stderr and stderr[1] or ("Git edit operation [%s] failed"):format(operation)
+    local user_msg = string.format("Git edit operation [%s] failed", operation)
     return chat:add_tool_output(self, error_msg, user_msg)
   end,
 }