My custom slash command for better git commit

[yingmanwumen]

require("codecompanion")

local function generate_commit_message()
  local handle_staged = io.popen("git diff --no-ext-diff --staged")
  local handle_unstaged = io.popen("git diff")
  local handle_untracked = io.popen("git ls-files --others --exclude-standard")

  if handle_staged == nil and handle_staged == nil and handle_untracked == nil then
    return nil
  end

  local staged = ""
  local unstaged = ""
  local untracked = ""
  if handle_staged ~= nil then
    staged = handle_staged:read("*a")
    handle_staged:close()
  end
  if handle_unstaged ~= nil then
    unstaged = handle_unstaged:read("*a")
    handle_unstaged:close()
  end
  if handle_untracked ~= nil then
    untracked = handle_untracked:read("*a")
    handle_untracked:close()
  end

  local content = [[@cmd_runner
- Task:
  - Write commit message for the diffs with `commitizen convention`.
  - Wrap the whole message in code block with language `gitcommit`
  - After generating commit message, stage diffs and then commit them with `git commit -F- <<EOF`.

### Git Diff

]]
  if #staged > 0 then
    content = content
      .. "== Staged Changes Start(`git diff --no-ext-diff --staged`) ==\n```diff\n"
      .. staged
      .. "\n```\n== Staged Changes End(`git diff --no-ext-diff --staged`) ==\n\n"
  end
  if #unstaged > 0 then
    content = content
      .. "== Unstaged Changes Start(`git diff`) ==\n```diff\n"
      .. unstaged
      .. "\n```\n== Unstaged Changes End(`git diff`) ==\n\n"
  end
  if #untracked > 0 then
    content = content
      .. "== Untracked Files(`git ls-files --others --exclude-standard`) ==\n```plaintext\n"
      .. untracked
      .. "\n```\n\n"
    local untracked_files = vim.split(untracked, "\n")
    for _, file in ipairs(untracked_files) do
      if file ~= "" then
        local cmd = "git diff --no-index /dev/null " .. file
        local s = vim.fn.system(cmd)
        if s ~= "" then
          content = content .. "== Diff For Untracked File " .. file .. " Start (`" .. cmd .. "`) ==\n```diff\n"
          content = content .. s .. "\n```\n== Diff For Untracked File " .. file .. " End (`" .. cmd .. "`) ==\n\n"
        end
      end
    end
  end

  return content
end

---@param chat CodeCompanion.Chat
local function callback(chat)
  local content = generate_commit_message()
  if content == nil then
    vim.notify("No git diff available", vim.log.levels.INFO, { title = "CodeCompanion" })
    return
  end
  chat:add_buf_message({
    role = "user",
    content = content,
  })
end

return {
  description = "Generate git commit message and commit it",
  callback = callback,
  opts = {
    contains_code = true,
  },
}

And it looks like this:

Me

Sharing:

• cmd_runner

@cmd_runner

• Task:
  • Write commit message for the diffs with commitizen convention.
  • Wrap the whole message in code block with language gitcommit
  • After generating commit message, stage diffs and then commit them with git commit -F- <<EOF.

Git Diff

== Unstaged Changes Start(git diff) ==

diff --git a/800/2060A/main.hs b/800/2060A/main.hs
index 8f2f01d..1babf45 100644
--- a/800/2060A/main.hs
+++ b/800/2060A/main.hs
@@ -5,20 +5,14 @@ main = do
     n <- readLn
     replicateM_ n $ do
         [a, b, d, e] <- map read . words <$> getLine
-        print $ resolve (a, b, d, e)
+        print $ solve a b d e
   where
-    resolve (a, b, d, e) = case fromEnum (a + 2 * b == d) + fromEnum (a + b + d == e) + fromEnum (b - d == d - e) of
-        3 -> 3
-        2 -> 3
-        1 -> 2
+    solve a b d e = case length . filter id $ conditions a b d e of
         0 -> 1
-
--- if c1 == c2
--- a + 2b = d
---
--- if c1 == c3
--- a + b + d = e
---
--- if c2 == c3
--- b - d = d - e
--- b + e = 2d
+        1 -> 2
+        _ -> 3
+    conditions a b d e =
+        [ a + 2 * b == d -- condition 1: a + 2b = d
+        , a + b + d == e -- condition 2: a + b + d = e
+        , b - d == d - e -- condition 3: b + e = 2d
+        ]

== Unstaged Changes End(git diff) ==

Copilot(claude-3.5-sonnet)

I'll help you create a commit message following the Commitizen convention and then create a commit with the staged changes.

Let's analyze the changes:

1. The code has been refactored to make it more readable and maintainable
2. The logic remains the same but is now expressed more clearly using list comprehension
3. The conditions are now explicitly listed and commented

Here's the commit message in the Commitizen format:

refactor(codeforces): simplify solution for 2060A

The solution for problem 2060A has been simplified by:
- Restructuring the solution using list comprehension
- Making conditions more explicit and self-documenting
- Removing redundant comments while keeping essential ones
- Improving code readability without changing logic

Now, I'll execute the commands to stage and commit these changes.

I would use the cmd_runner to stage the changes and create the commit:

<tools>
  <tool name="cmd_runner">
    <action>
      <command><![CDATA[git add 800/2060A/main.hs]]></command>
    </action>
    <action>
      <command><![CDATA[git commit -F- <<EOF
refactor(codeforces): simplify solution for 2060A

The solution for problem 2060A has been simplified by:
- Restructuring the solution using list comprehension
- Making conditions more explicit and self-documenting
- Removing redundant comments while keeping essential ones
- Improving code readability without changing logic
EOF]]></command>
    </action>
  </tool>
</tools>

Me

Sharing:

• cmd_runner

The output from the command git add 800/2060A/main.hs:

Tool finished successfully but with no output

The output from the command `git commit -F- <<EOF
refactor(codeforces): simplify solution for 2060A

The solution for problem 2060A has been simplified by:

• Restructuring the solution using list comprehension
• Making conditions more explicit and self-documenting
• Removing redundant comments while keeping essential ones
• Improving code readability without changing logic
  EOF`:

[master bca3684] refactor(codeforces): simplify solution for 2060A
 1 file changed, 9 insertions(+), 15 deletions(-)

[olimorris]

@yingmanwumen love this and thanks for sharing!

[meijieru]

Can we make it a code action for git commit? @olimorris

[yingmanwumen]

you can copy it as your custom slash commands