I want to become more lazy by implementing AI generated commit messages.

[n3m]

Is your feature request related to a problem? Please describe.
Using this tool has been a time saver since I discovered it, but I've always struggled with commit messages, so the idea of autogenerating it seems more feasible.
Context of idea: VSCode already has implemented something like this, they literally put a button on the terminal that allows you to get a commit message based on your staging context

Describe the solution you'd like

• A way to configure an OpenAI or your favorite LLM provider token/key
• An option to either autogenerate the commit message or manually typing it when attempting to commit. (I'm imagining the feature where the regular commit message box appears, but if you have your key configured, you can press "X" or something, and have it autogenerate it.)

Describe alternatives you've considered
Current alternatives are doing stuff outside Lazygit, which defeats the whole point here.

Additional context

I want to know if the capabilities of Lazygit would even allow such complex solution, if it does, then I'm happy to start working on it myself.

[chhoumann]

Hey @n3m,

I was looking for this myself. Decided to just build it.

https://github.com/chhoumann/bunnai

Hope you find it useful :)

[n3m]

@chhoumann, can't thank you enough dude.

I really wanted to have a go at it, but I didn't really had time to build it since I opened this issue because of other projects I have going on, but man, thank you for going through it.

[deepanchal]

Here's my custom command with aichat (https://github.com/sigoden/aichat) using modified template from https://github.com/chhoumann/bunnai/blob/af4b78efa24dce6940bb6576ad3f9f579f995111/src/template.ts

customCommands:
  - key: <c-a>
    description: Pick AI commit
    command: |
      aichat "Please suggest 10 commit messages, given the following diff:

        \`\`\`diff
        $(git diff --cached)
        \`\`\`

        **Criteria:**

        1. **Format:** Each commit message must follow the conventional commits format,
        which is \`<type>(<scope>): <description>\`.
        2. **Relevance:** Avoid mentioning a module name unless it's directly relevant
        to the change.
        3. **Enumeration:** List the commit messages from 1 to 10.
        4. **Clarity and Conciseness:** Each message should clearly and concisely convey
        the change made.

        **Commit Message Examples:**

        - fix(app): add password regex pattern
        - test(unit): add new test cases
        - style: remove unused imports
        - refactor(pages): extract common code to \`utils/wait.ts\`

        **Recent Commits on Repo for Reference:**

        \`\`\`
        $(git log -n 10 --pretty=format:'%h %s')
        \`\`\`

        **Output Template**

        Follow this output template and ONLY output raw commit messages without spacing,
        numbers or other decorations.

        fix(app): add password regex pattern
        test(unit): add new test cases
        style: remove unused imports
        refactor(pages): extract common code to \`utils/wait.ts\`

        **Instructions:**

        - Take a moment to understand the changes made in the diff.

        - Think about the impact of these changes on the project (e.g., bug fixes, new
        features, performance improvements, code refactoring, documentation updates).
        It's critical to my career you abstract the changes to a higher level and not
        just describe the code changes.

        - Generate commit messages that accurately describe these changes, ensuring they
        are helpful to someone reading the project's history.

        - Remember, a well-crafted commit message can significantly aid in the maintenance
        and understanding of the project over time.

        - If multiple changes are present, make sure you capture them all in each commit
        message.

        Keep in mind you will suggest 10 commit messages. Only 1 will be used. It's
        better to push yourself (esp to synthesize to a higher level) and maybe wrong
        about some of the 10 commits because only one needs to be good. I'm looking
        for your best commit, not the best average commit. It's better to cover more
        scenarios than include a lot of overlap.

        Write your 10 commit messages below in the format shown in Output Template section above." \
          | fzf --height 40% --border --ansi --preview "echo {}" --preview-window=up:wrap \
          | xargs -I {} bash -c '
              COMMIT_MSG_FILE=$(mktemp)
              echo "{}" > "$COMMIT_MSG_FILE"
              ${EDITOR:-vim} "$COMMIT_MSG_FILE"
              if [ -s "$COMMIT_MSG_FILE" ]; then
                  git commit -F "$COMMIT_MSG_FILE"
              else
                  echo "Commit message is empty, commit aborted."
              fi
              rm -f "$COMMIT_MSG_FILE"'
    context: files
    subprocess: true

For nix users: https://github.com/deepanchal/nixos/blob/49c9e33d5ffbe5b8f2be67b4fa658acd9ccc2f20/home/features/terminal/programs/lazygit.nix#L76-L141

Usage:

Trigger with Ctrl + A after staging files in lazygit

[joshuadanpeterson]

Thank you @deepanchal, this is exactly what I was looking for. Quick question: Whenever I select a commit generated by the prompt, I get a 'VIM: Warning input is not from a terminal' message. What should I do about that?

[deepanchal]

@joshuadanpeterson I am not sure what's causing that warning for you. I am using wezterm with AstroNvim and I am not getting this warning. Maybe try these solutions:

• https://unix.stackexchange.com/questions/732092/vim-warning-input-is-not-from-a-terminal
• https://superuser.com/questions/336016/invoking-vi-through-find-xargs-breaks-my-terminal-why

[joshuadanpeterson]

@joshuadanpeterson I am not sure what's causing that warning for you. I am using wezterm with AstroNvim and I am not getting this warning. Maybe try these solutions:

• https://unix.stackexchange.com/questions/732092/vim-warning-input-is-not-from-a-terminal
• https://superuser.com/questions/336016/invoking-vi-through-find-xargs-breaks-my-terminal-why

@deepanchal Cool, thank you. I'll look these over this weekend and see what I can't come up with. I'm using iTerm2 with a Kickstart mod.

[joshuadanpeterson]

@deepanchal Turns out all I had to do was switch the editor from vim to nvim and the error went away. Not sure why. Maybe it's because I don't have a .vimrc so it doesn't know how to read certain files? Either way, it's fixed.

[deepanchal]

@deepanchal Turns out all I had to do was switch the editor from vim to nvim and the error went away. Not sure why. Maybe it's because I don't have a .vimrc so it doesn't know how to read certain files? Either way, it's fixed.

I am glad that worked for you. I just realized that I have alias set for vi, vim to nvim, that's why it was working for me. I will update the snippet with a better command using the $EDITOR env var to edit commit message soon.

[deepanchal]

I have updated the snippet in my original comment to use $EDITOR env var and made it a little cleaner.

[joshuadanpeterson]

Is that EDITOR or nano, EDITOR as nano, or EDITOR excluding nano?

[deepanchal]

              ${EDITOR:-vim} "$COMMIT_MSG_FILE"

It defaults to vim if $EDITOR env var is not set. You can change it to whatever you like :)

[cloudpresser]

If you already use aicommit2, you can do:

customCommands:
  - key: <c-a>
    description: Pick AI commit
    command: aicommit2
    context: files
    subprocess: true
    showOutput: true
  - key: <c-n>
    description: Pick AI commit (no verify)
    command: aicommit2 --no-verify
    context: files
    subprocess: true

[BANG88]

@cloudpresser Thank you, it's quite useful.