Feature request: Generate commit message based on staged changes

[Frixxie]

Hi, would it be possible to create an /commit-staged action that prompts the CodeCompanion to generate a commit message based on staged changes instead of unstaged ones?

[olimorris]

That's a great suggestion. You can add this to your own config via a default prompt as per the RECIPES guide. I imagine it's a minor change to the git command.

[dhruvinsh]

I was about to open feature request for the same but before submitting it made me search, checkbox serving its purpose.

I like to keep commit clean and server only single purpose. So for such case It would be great if we can generate commit message for staged files and ignore everything else. That way I can target only need changes for commit message and ignore all other changes.

Here is my config with Recipes suggestion,

default_prompts = {                                                                                                                                                
  ["Generate a Commit Message for Staged Files"] = {                                                                                                               
    strategy = "chat",                                                                                                                                             
    description = "staged file commit messages",                                                                                                                   
    opts = {                                                                                                                                                       
      index = 9,                                                                                                                                                   
      default_prompt = true,                                                                                                                                       
      mapping = "<LocalLeader>gm",                                                                                                                                 
      slash_cmd = "commit",                                                                                                                                        
      auto_submit = true,                                                                                                                                          
    },                                                                                                                                                             
    prompts = {                                                                                                                                                    
      {                                                                                                                                                            
        role = "user",                                                                                                                                             
        contains_code = true,                                                                                                                                      
        content = function()                                                                                                                                       
          return "You are an expert at following the Conventional Commit specification. Given the git diff listed below, please generate a commit message for me:" 
            .. "\n\n```\n"                                                                                                                                         
            .. vim.fn.system("git diff --staged")                                                                                                                  
            .. "\n```"                                                                                                                                             
        end,                                                                                                                                                       
      },                                                                                                                                                           
    },                                                                                                                                                             
  },                                                                                                                                                               
},                                                                                                                                                                 

[dhruvinsh]

with v4.0.0 breaking changes, new updated would (and some minor changes) would be,

      prompt_library = {
        ["Commit Message for Staged Files"] = {
          strategy = "chat",
          description = "staged file commit messages",
          opts = {
            index = 9,
            default_prompt = true,
            mapping = "<LocalLeader>gm",
            slash_cmd = "stage",
            auto_submit = true,
          },
          prompts = {
            {
              role = "system",
              content = "You are an expert at following the Conventional Commit specification.",
            },
            {
              role = "user",
              contains_code = true,
              content = function()
                return "Given the git diff listed below, please generate a commit message for me:\n\n"
                  .. "```\n"
                  .. vim.fn.system("git diff --staged")
                  .. "\n```"
              end,
            },
          },
        },
      },

[dhruvinsh]

with v5.0.0 this behaviour is default now.