Skip to content

Commit 86c6254

Browse files
love-lingerlove-linger
committed
Merge branch 'feature/openai-support' into develop
2 parents 84b3de6 + 16f8e2f commit 86c6254

16 files changed

+496
-30
lines changed

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Opensource Git GUI client.
3535
* Git LFS
3636
* Issue Link
3737
* Workspace
38+
* Using AI to generate commit message (C# port of [anjerodev/commitollama](https://github.com/anjerodev/commitollama))
3839

3940
> [!WARNING]
4041
> **Linux** only tested on **Debian 12** on both **X11** & **Wayland**.

‎src/App.JsonCodeGen.cs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ public override void Write(Utf8JsonWriter writer, GridLength value, JsonSerializ
4646
[JsonSerializable(typeof(Models.ExternalToolPaths))]
4747
[JsonSerializable(typeof(Models.InteractiveRebaseJobCollection))]
4848
[JsonSerializable(typeof(Models.JetBrainsState))]
49+
[JsonSerializable(typeof(Models.OpenAIChatRequest))]
50+
[JsonSerializable(typeof(Models.OpenAIChatResponse))]
4951
[JsonSerializable(typeof(Models.ThemeOverrides))]
5052
[JsonSerializable(typeof(Models.Version))]
5153
[JsonSerializable(typeof(Models.RepositorySettings))]

‎src/Commands/GenerateCommitMessage.cs‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Text;
4+
using System.Threading;
5+
6+
namespace SourceGit.Commands
7+
{
8+
/// <summary>
9+
/// A C# version of https://github.com/anjerodev/commitollama
10+
/// </summary>
11+
public class GenerateCommitMessage
12+
{
13+
public class GetDiffContent : Command
14+
{
15+
public GetDiffContent(string repo, Models.DiffOption opt)
16+
{
17+
WorkingDirectory = repo;
18+
Context = repo;
19+
Args = $"diff --diff-algorithm=minimal {opt}";
20+
}
21+
}
22+
23+
public GenerateCommitMessage(string repo, List<Models.Change> changes, CancellationToken cancelToken, Action<string> onProgress)
24+
{
25+
_repo = repo;
26+
_changes = changes;
27+
_cancelToken = cancelToken;
28+
_onProgress = onProgress;
29+
}
30+
31+
public string Result()
32+
{
33+
try
34+
{
35+
var summaries = new List<string>();
36+
foreach (var change in _changes)
37+
{
38+
if (_cancelToken.IsCancellationRequested)
39+
return "";
40+
41+
_onProgress?.Invoke($"Analyzing {change.Path}...");
42+
var summary = GenerateChangeSummary(change);
43+
summaries.Add(summary);
44+
}
45+
46+
if (_cancelToken.IsCancellationRequested)
47+
return "";
48+
49+
_onProgress?.Invoke($"Generating commit message...");
50+
var builder = new StringBuilder();
51+
builder.Append(GenerateSubject(string.Join("", summaries)));
52+
builder.Append("\n");
53+
foreach (var summary in summaries)
54+
{
55+
builder.Append("\n- ");
56+
builder.Append(summary.Trim());
57+
}
58+
59+
return builder.ToString();
60+
}
61+
catch (Exception e)
62+
{
63+
App.RaiseException(_repo, $"Failed to generate commit message: {e}");
64+
return "";
65+
}
66+
}
67+
68+
private string GenerateChangeSummary(Models.Change change)
69+
{
70+
var rs = new GetDiffContent(_repo, new Models.DiffOption(change, false)).ReadToEnd();
71+
var diff = rs.IsSuccess ? rs.StdOut : "unknown change";
72+
73+
var prompt = new StringBuilder();
74+
prompt.AppendLine("You are an expert developer specialist in creating commits.");
75+
prompt.AppendLine("Provide a super concise one sentence overall changes summary of the user `git diff` output following strictly the next rules:");
76+
prompt.AppendLine("- Do not use any code snippets, imports, file routes or bullets points.");
77+
prompt.AppendLine("- Do not mention the route of file that has been change.");
78+
prompt.AppendLine("- Simply describe the MAIN GOAL of the changes.");
79+
prompt.AppendLine("- Output directly the summary in plain text.`");
80+
81+
var rsp = Models.OpenAI.Chat(prompt.ToString(), $"Here is the `git diff` output: {diff}");
82+
if (rsp != null && rsp.Choices.Count > 0)
83+
return rsp.Choices[0].Message.Content;
84+
85+
return string.Empty;
86+
}
87+
88+
private string GenerateSubject(string summary)
89+
{
90+
var prompt = new StringBuilder();
91+
prompt.AppendLine("You are an expert developer specialist in creating commits messages.");
92+
prompt.AppendLine("Your only goal is to retrieve a single commit message.");
93+
prompt.AppendLine("Based on the provided user changes, combine them in ONE SINGLE commit message retrieving the global idea, following strictly the next rules:");
94+
prompt.AppendLine("- Assign the commit {type} according to the next conditions:");
95+
prompt.AppendLine(" feat: Only when adding a new feature.");
96+
prompt.AppendLine(" fix: When fixing a bug.");
97+
prompt.AppendLine(" docs: When updating documentation.");
98+
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.");
99+
prompt.AppendLine(" test: When adding or updating tests. ");
100+
prompt.AppendLine(" chore: When making changes to the build process or auxiliary tools and libraries. ");
101+
prompt.AppendLine(" revert: When undoing a previous commit.");
102+
prompt.AppendLine(" refactor: When restructuring code without changing its external behavior, or is any of the other refactor types.");
103+
prompt.AppendLine("- Do not add any issues numeration, explain your output nor introduce your answer.");
104+
prompt.AppendLine("- Output directly only one commit message in plain text with the next format: {type}: {commit_message}.");
105+
prompt.AppendLine("- Be as concise as possible, keep the message under 50 characters.");
106+
107+
var rsp = Models.OpenAI.Chat(prompt.ToString(), $"Here are the summaries changes: {summary}");
108+
if (rsp != null && rsp.Choices.Count > 0)
109+
return rsp.Choices[0].Message.Content;
110+
111+
return string.Empty;
112+
}
113+
114+
private string _repo;
115+
private List<Models.Change> _changes;
116+
private CancellationToken _cancelToken;
117+
private Action<string> _onProgress;
118+
}
119+
}

‎src/Models/OpenAI.cs‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Net.Http;
4+
using System.Text.Json;
5+
using System.Text.Json.Serialization;
6+
7+
namespace SourceGit.Models
8+
{
9+
public class OpenAIChatMessage
10+
{
11+
[JsonPropertyName("role")]
12+
public string Role
13+
{
14+
get;
15+
set;
16+
}
17+
18+
[JsonPropertyName("content")]
19+
public string Content
20+
{
21+
get;
22+
set;
23+
}
24+
}
25+
26+
public class OpenAIChatChoice
27+
{
28+
[JsonPropertyName("index")]
29+
public int Index
30+
{
31+
get;
32+
set;
33+
}
34+
35+
[JsonPropertyName("message")]
36+
public OpenAIChatMessage Message
37+
{
38+
get;
39+
set;
40+
}
41+
}
42+
43+
public class OpenAIChatResponse
44+
{
45+
[JsonPropertyName("choices")]
46+
public List<OpenAIChatChoice> Choices
47+
{
48+
get;
49+
set;
50+
} = [];
51+
}
52+
53+
public class OpenAIChatRequest
54+
{
55+
[JsonPropertyName("model")]
56+
public string Model
57+
{
58+
get;
59+
set;
60+
}
61+
62+
[JsonPropertyName("messages")]
63+
public List<OpenAIChatMessage> Messages
64+
{
65+
get;
66+
set;
67+
} = [];
68+
69+
public void AddMessage(string role, string content)
70+
{
71+
Messages.Add(new OpenAIChatMessage { Role = role, Content = content });
72+
}
73+
}
74+
75+
public static class OpenAI
76+
{
77+
public static string Server
78+
{
79+
get;
80+
set;
81+
}
82+
83+
public static string ApiKey
84+
{
85+
get;
86+
set;
87+
}
88+
89+
public static string Model
90+
{
91+
get;
92+
set;
93+
}
94+
95+
public static bool IsValid
96+
{
97+
get => !string.IsNullOrEmpty(Server) && !string.IsNullOrEmpty(ApiKey) && !string.IsNullOrEmpty(Model);
98+
}
99+
100+
public static OpenAIChatResponse Chat(string prompt, string question)
101+
{
102+
var chat = new OpenAIChatRequest() { Model = Model };
103+
chat.AddMessage("system", prompt);
104+
chat.AddMessage("user", question);
105+
106+
var client = new HttpClient() { Timeout = TimeSpan.FromSeconds(60) };
107+
client.DefaultRequestHeaders.Add("Authorization", $"Bearer {ApiKey}");
108+
109+
var req = new StringContent(JsonSerializer.Serialize(chat, JsonCodeGen.Default.OpenAIChatRequest));
110+
var task = client.PostAsync(Server, req);
111+
task.Wait();
112+
113+
var rsp = task.Result;
114+
if (!rsp.IsSuccessStatusCode)
115+
throw new Exception($"AI service returns error code {rsp.StatusCode}");
116+
117+
var reader = rsp.Content.ReadAsStringAsync();
118+
reader.Wait();
119+
120+
return JsonSerializer.Deserialize(reader.Result, JsonCodeGen.Default.OpenAIChatResponse);
121+
}
122+
}
123+
}

‎src/Resources/Icons.axaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<ResourceDictionary xmlns="https://github.com/avaloniaui" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
2+
<StreamGeometry x:Key="Icons.AIAssist">M951 419a255 255 0 00-22-209 258 258 0 00-278-124A259 259 0 00213 178a255 255 0 00-171 124 258 258 0 0032 303 255 255 0 0022 210 258 258 0 00278 124A255 255 0 00566 1024a258 258 0 00246-179 256 256 0 00171-124 258 258 0 00-32-302zM566 957a191 191 0 01-123-44l6-3 204-118a34 34 0 0017-29v-287l86 50a3 3 0 012 2v238a192 192 0 01-192 192zM154 781a191 191 0 01-23-129l6 4 204 118a33 33 0 0033 0l249-144v99a3 3 0 01-1 3L416 851a192 192 0 01-262-70zM100 337a191 191 0 01101-84V495a33 33 0 0017 29l248 143-86 50a3 3 0 01-3 0l-206-119A192 192 0 01100 336zm708 164-249-145L645 307a3 3 0 013 0l206 119a192 192 0 01-29 346v-242a34 34 0 00-17-28zm86-129-6-4-204-119a33 33 0 00-33 0L401 394V294a3 3 0 011-3l206-119a192 192 0 01285 199zm-539 176-86-50a3 3 0 01-2-2V259a192 192 0 01315-147l-6 3-204 118a34 34 0 00-17 29zm47-101 111-64 111 64v128l-111 64-111-64z</StreamGeometry>
23
<StreamGeometry x:Key="Icons.Archive">M296 392h64v64h-64zM296 582v160h128V582h-64v-62h-64v62zm80 48v64h-32v-64h32zM360 328h64v64h-64zM296 264h64v64h-64zM360 456h64v64h-64zM360 200h64v64h-64zM855 289 639 73c-6-6-14-9-23-9H192c-18 0-32 14-32 32v832c0 18 14 32 32 32h640c18 0 32-14 32-32V311c0-9-3-17-9-23zM790 326H602V138L790 326zm2 562H232V136h64v64h64v-64h174v216c0 23 19 42 42 42h216v494z</StreamGeometry>
34
<StreamGeometry x:Key="Icons.Binary">M71 1024V0h661L953 219V1024H71zm808-731-220-219H145V951h735V293zM439 512h-220V219h220V512zm-74-219H292v146h74v-146zm0 512h74v73h-220v-73H292v-146H218V585h147v219zm294-366h74V512H512v-73h74v-146H512V219h147v219zm74 439H512V585h220v293zm-74-219h-74v146h74v-146z</StreamGeometry>
45
<StreamGeometry x:Key="Icons.Blame">M128 256h192a64 64 0 110 128H128a64 64 0 110-128zm576 192h192a64 64 0 010 128h-192a64 64 0 010-128zm-576 192h192a64 64 0 010 128H128a64 64 0 010-128zm576 0h192a64 64 0 010 128h-192a64 64 0 010-128zm0-384h192a64 64 0 010 128h-192a64 64 0 010-128zM128 448h192a64 64 0 110 128H128a64 64 0 110-128zm384-320a64 64 0 0164 64v640a64 64 0 01-128 0V192a64 64 0 0164-64z</StreamGeometry>

‎src/Resources/Locales/en_US.axaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
<x:String x:Key="Text.AddWorktree.Name.Placeholder" xml:space="preserve">Optional. Default is the destination folder name.</x:String>
1818
<x:String x:Key="Text.AddWorktree.Tracking" xml:space="preserve">Track Branch:</x:String>
1919
<x:String x:Key="Text.AddWorktree.Tracking.Toggle" xml:space="preserve">Tracking remote branch</x:String>
20+
<x:String x:Key="Text.AIAssistant" xml:space="preserve">OpenAI Assistant</x:String>
21+
<x:String x:Key="Text.AIAssistant.Tip" xml:space="preserve">Use OpenAI to generate commit message</x:String>
2022
<x:String x:Key="Text.Apply" xml:space="preserve">Patch</x:String>
2123
<x:String x:Key="Text.Apply.Error" xml:space="preserve">Error</x:String>
2224
<x:String x:Key="Text.Apply.Error.Desc" xml:space="preserve">Raise errors and refuses to apply the patch</x:String>
@@ -384,6 +386,10 @@
384386
<x:String x:Key="Text.Period.LastYear" xml:space="preserve">Last year</x:String>
385387
<x:String x:Key="Text.Period.YearsAgo" xml:space="preserve">{0} years ago</x:String>
386388
<x:String x:Key="Text.Preference" xml:space="preserve">Preference</x:String>
389+
<x:String x:Key="Text.Preference.AI" xml:space="preserve">OPEN AI</x:String>
390+
<x:String x:Key="Text.Preference.AI.Server" xml:space="preserve">Server</x:String>
391+
<x:String x:Key="Text.Preference.AI.ApiKey" xml:space="preserve">API Key</x:String>
392+
<x:String x:Key="Text.Preference.AI.Model" xml:space="preserve">Model</x:String>
387393
<x:String x:Key="Text.Preference.Appearance" xml:space="preserve">APPEARANCE</x:String>
388394
<x:String x:Key="Text.Preference.Appearance.DefaultFont" xml:space="preserve">Default Font</x:String>
389395
<x:String x:Key="Text.Preference.Appearance.DefaultFontSize" xml:space="preserve">Default Font Size</x:String>

‎src/Resources/Locales/zh_CN.axaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
<x:String x:Key="Text.AddWorktree.Name.Placeholder" xml:space="preserve">选填。默认使用目标文件夹名称。</x:String>
2121
<x:String x:Key="Text.AddWorktree.Tracking" xml:space="preserve">跟踪分支</x:String>
2222
<x:String x:Key="Text.AddWorktree.Tracking.Toggle" xml:space="preserve">设置上游跟踪分支</x:String>
23+
<x:String x:Key="Text.AIAssistant" xml:space="preserve">OpenAI助手</x:String>
24+
<x:String x:Key="Text.AIAssistant.Tip" xml:space="preserve">使用OpenAI助手生成提交信息</x:String>
2325
<x:String x:Key="Text.Apply" xml:space="preserve">应用补丁(apply)</x:String>
2426
<x:String x:Key="Text.Apply.Error" xml:space="preserve">错误</x:String>
2527
<x:String x:Key="Text.Apply.Error.Desc" xml:space="preserve">输出错误，并终止应用补丁</x:String>

‎src/Resources/Locales/zh_TW.axaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
<x:String x:Key="Text.AddWorktree.Name.Placeholder" xml:space="preserve">選填。預設使用目標資料夾名稱。</x:String>
2121
<x:String x:Key="Text.AddWorktree.Tracking" xml:space="preserve">追蹤分支</x:String>
2222
<x:String x:Key="Text.AddWorktree.Tracking.Toggle" xml:space="preserve">設定遠端追蹤分支</x:String>
23+
<x:String x:Key="Text.AIAssistant" xml:space="preserve">OpenAI 助手</x:String>
24+
<x:String x:Key="Text.AIAssistant.Tip" xml:space="preserve">使用 OpenAI 產生提交消息</x:String>
2325
<x:String x:Key="Text.Apply" xml:space="preserve">套用修補檔 (apply patch)</x:String>
2426
<x:String x:Key="Text.Apply.Error" xml:space="preserve">錯誤</x:String>
2527
<x:String x:Key="Text.Apply.Error.Desc" xml:space="preserve">輸出錯誤，並中止套用修補檔</x:String>

‎src/Resources/Styles.axaml‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -466,21 +466,6 @@
466466
<Setter Property="Fill" Value="{DynamicResource Brush.FG2}"/>
467467
</Style>
468468

469-
<Style Selector="Button.no_border">
470-
<Setter Property="BorderThickness" Value="0"/>
471-
<Setter Property="Background" Value="Transparent"/>
472-
<Setter Property="VerticalAlignment" Value="Center"/>
473-
</Style>
474-
<Style Selector="Button.no_border /template/ ContentPresenter#PART_ContentPresenter">
475-
<Setter Property="Background" Value="Transparent"/>
476-
</Style>
477-
<Style Selector="Button.no_border:pointerover Path">
478-
<Setter Property="Fill" Value="{DynamicResource Brush.Accent}"/>
479-
</Style>
480-
<Style Selector="Button.no_border:pressed">
481-
<Setter Property="RenderTransform" Value="scale(1.0)"/>
482-
</Style>
483-
484469
<Style Selector="Button.flat">
485470
<Setter Property="BorderThickness" Value="1"/>
486471
<Setter Property="BorderBrush" Value="{DynamicResource Brush.Border2}"/>

‎src/ViewModels/Preference.cs‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,45 @@ public int? GitAutoFetchInterval
274274
}
275275
}
276276

277+
public string OpenAIServer
278+
{
279+
get => Models.OpenAI.Server;
280+
set
281+
{
282+
if (value != Models.OpenAI.Server)
283+
{
284+
Models.OpenAI.Server = value;
285+
OnPropertyChanged();
286+
}
287+
}
288+
}
289+
290+
public string OpenAIApiKey
291+
{
292+
get => Models.OpenAI.ApiKey;
293+
set
294+
{
295+
if (value != Models.OpenAI.ApiKey)
296+
{
297+
Models.OpenAI.ApiKey = value;
298+
OnPropertyChanged();
299+
}
300+
}
301+
}
302+
303+
public string OpenAIModel
304+
{
305+
get => Models.OpenAI.Model;
306+
set
307+
{
308+
if (value != Models.OpenAI.Model)
309+
{
310+
Models.OpenAI.Model = value;
311+
OnPropertyChanged();
312+
}
313+
}
314+
}
315+
277316
public int ExternalMergeToolType
278317
{
279318
get => _externalMergeToolType;

0 commit comments

Comments
 (0)