feature: simple implementation for generating commit message by OpenAI (#456)

2025-05-23 13:14:59 +00:00 · 2024-09-11 18:22:05 +08:00 · 2024-09-11 18:22:05 +08:00 · 16f8e2fd0b
commit 16f8e2fd0b
parent a63450f73f
16 changed files with 496 additions and 30 deletions
--- a/src/Commands/GenerateCommitMessage.cs
+++ b/src/Commands/GenerateCommitMessage.cs
@ -0,0 +1,119 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Threading;
+
+namespace SourceGit.Commands
+{
+    /// <summary>
+    ///     A C# version of https://github.com/anjerodev/commitollama
+    /// </summary>
+    public class GenerateCommitMessage
+    {
+        public class GetDiffContent : Command
+        {
+            public GetDiffContent(string repo, Models.DiffOption opt)
+            {
+                WorkingDirectory = repo;
+                Context = repo;
+                Args = $"diff --diff-algorithm=minimal {opt}";
+            }
+        }
+
+        public GenerateCommitMessage(string repo, List<Models.Change> changes, CancellationToken cancelToken, Action<string> onProgress)
+        {
+            _repo = repo;
+            _changes = changes;
+            _cancelToken = cancelToken;
+            _onProgress = onProgress;
+        }
+
+        public string Result()
+        {
+            try
+            {
+                var summaries = new List<string>();
+                foreach (var change in _changes)
+                {
+                    if (_cancelToken.IsCancellationRequested)
+                        return "";
+
+                    _onProgress?.Invoke($"Analyzing {change.Path}...");
+                    var summary = GenerateChangeSummary(change);
+                    summaries.Add(summary);
+                }
+
+                if (_cancelToken.IsCancellationRequested)
+                    return "";
+
+                _onProgress?.Invoke($"Generating commit message...");
+                var builder = new StringBuilder();
+                builder.Append(GenerateSubject(string.Join("", summaries)));
+                builder.Append("\n");
+                foreach (var summary in summaries)
+                {
+                    builder.Append("\n- ");
+                    builder.Append(summary.Trim());
+                }
+
+                return builder.ToString();
+            }
+            catch (Exception e)
+            {
+                App.RaiseException(_repo, $"Failed to generate commit message: {e}");
+                return "";
+            }
+        }
+
+        private string GenerateChangeSummary(Models.Change change)
+        {
+            var rs = new GetDiffContent(_repo, new Models.DiffOption(change, false)).ReadToEnd();
+            var diff = rs.IsSuccess ? rs.StdOut : "unknown change";
+
+            var prompt = new StringBuilder();
+            prompt.AppendLine("You are an expert developer specialist in creating commits.");
+            prompt.AppendLine("Provide a super concise one sentence overall changes summary of the user `git diff` output following strictly the next rules:");
+            prompt.AppendLine("- Do not use any code snippets, imports, file routes or bullets points.");
+            prompt.AppendLine("- Do not mention the route of file that has been change.");
+            prompt.AppendLine("- Simply describe the MAIN GOAL of the changes.");
+            prompt.AppendLine("- Output directly the summary in plain text.`");
+
+            var rsp = Models.OpenAI.Chat(prompt.ToString(), $"Here is the `git diff` output: {diff}");
+            if (rsp != null && rsp.Choices.Count > 0)
+                return rsp.Choices[0].Message.Content;
+
+            return string.Empty;
+        }
+
+        private string GenerateSubject(string summary)
+        {
+            var prompt = new StringBuilder();
+            prompt.AppendLine("You are an expert developer specialist in creating commits messages.");
+            prompt.AppendLine("Your only goal is to retrieve a single commit message.");
+            prompt.AppendLine("Based on the provided user changes, combine them in ONE SINGLE commit message retrieving the global idea, following strictly the next rules:");
+            prompt.AppendLine("- Assign the commit {type} according to the next conditions:");
+            prompt.AppendLine("  feat: Only when adding a new feature.");
+            prompt.AppendLine("  fix: When fixing a bug.");
+            prompt.AppendLine("  docs: When updating documentation.");
+            prompt.AppendLine("  style: When changing elements styles or design and/or making changes to the code style (formatting, missing semicolons, etc.) without changing the code logic.");
+            prompt.AppendLine("  test: When adding or updating tests. ");
+            prompt.AppendLine("  chore: When making changes to the build process or auxiliary tools and libraries. ");
+            prompt.AppendLine("  revert: When undoing a previous commit.");
+            prompt.AppendLine("  refactor: When restructuring code without changing its external behavior, or is any of the other refactor types.");
+            prompt.AppendLine("- Do not add any issues numeration, explain your output nor introduce your answer.");
+            prompt.AppendLine("- Output directly only one commit message in plain text with the next format: {type}: {commit_message}.");
+            prompt.AppendLine("- Be as concise as possible, keep the message under 50 characters.");
+
+            var rsp = Models.OpenAI.Chat(prompt.ToString(), $"Here are the summaries changes: {summary}");
+            if (rsp != null && rsp.Choices.Count > 0)
+                return rsp.Choices[0].Message.Content;
+
+            return string.Empty;           
+        }
+
+        private string _repo;
+        private List<Models.Change> _changes;
+        private CancellationToken _cancelToken;
+        private Action<string> _onProgress;
+    }
+}