feature: allows to customize conventional commit types (#1861)

love-linger · love-linger · commit aed9ddedfd59 · 2025-10-20T21:24:15.000+08:00
Signed-off-by: leo &lt;longshuang@msn.cn&gt;
diff --git a/README.md b/README.md
@@ -45,6 +45,7 @@
 * Custom Action
 * Create PR on GitHub/Gitlab/Gitea/Gitee/Bitbucket...
 * Using AI to generate commit message (C# port of [anjerodev/commitollama](https://github.com/anjerodev/commitollama))
+* Built-in conventional commit message helper.
 
 > [!WARNING]
 > **Linux** only tested on **Debian 12** on both **X11** & **Wayland**.
@@ -173,6 +174,27 @@ This app supports open repository in external tools listed in the table below.
 > [!NOTE]
 > This app also supports a lot of `JetBrains` IDEs, installing `JetBrains Toolbox` will help this app to find them.
 
+## Conventional Commit Helper
+
+You can define your own conventional commit types (per-repository) by following steps:
+
+1. Create a json file with your own conventional commit type definitions. For example:
+```json
+[
+  {
+    "Name": "New Feature",
+    "Type": "Feature",
+    "Description": "Adding a new feature"
+  },
+  {
+    "Name": "Bug Fixes",
+    "Type": "Fix",
+    "Description": "Fixing a bug"
+  }
+]
+```
+2. Configure the `Conventional Commit Types` in repository configuration window.  
+
 ## Screenshots
 
 * Dark Theme
diff --git a/src/App.JsonCodeGen.cs b/src/App.JsonCodeGen.cs
@@ -65,6 +65,7 @@ public override void Write(Utf8JsonWriter writer, DataGridLength value, JsonSeri
     [JsonSerializable(typeof(Models.ThemeOverrides))]
     [JsonSerializable(typeof(Models.Version))]
     [JsonSerializable(typeof(Models.RepositorySettings))]
+    [JsonSerializable(typeof(List<Models.ConventionalCommitType>))]
     [JsonSerializable(typeof(List<Models.LFSLock>))]
     [JsonSerializable(typeof(List<Models.VisualStudioInstance>))]
     [JsonSerializable(typeof(ViewModels.Preferences))]
diff --git a/src/Models/ConventionalCommitType.cs b/src/Models/ConventionalCommitType.cs
@@ -1,4 +1,6 @@
 ﻿using System.Collections.Generic;
+using System.IO;
+using System.Text.Json;
 
 namespace SourceGit.Models
 {
@@ -8,26 +10,39 @@ public class ConventionalCommitType
         public string Type { get; set; }
         public string Description { get; set; }
 
-        public static readonly List<ConventionalCommitType> Supported = [
-            new("Features", "feat", "Adding a new feature"),
-            new("Bug Fixes", "fix", "Fixing a bug"),
-            new("Work In Progress", "wip", "Still being developed and not yet complete"),
-            new("Reverts", "revert", "Undoing a previous commit"),
-            new("Code Refactoring", "refactor", "Restructuring code without changing its external behavior"),
-            new("Performance Improvements", "perf", "Improves performance"),
-            new("Builds", "build", "Changes that affect the build system or external dependencies"),
-            new("Continuous Integrations", "ci", "Changes to CI configuration files and scripts"),
-            new("Documentations", "docs", "Updating documentation"),
-            new("Styles", "style", "Elements or code styles without changing the code logic"),
-            new("Tests", "test", "Adding or updating tests"),
-            new("Chores", "chore", "Other changes that don't modify src or test files"),
-        ];
-
         public ConventionalCommitType(string name, string type, string description)
         {
             Name = name;
             Type = type;
             Description = description;
         }
+
+        public static List<ConventionalCommitType> Load(string storageFile)
+        {
+            try
+            {
+                if (!string.IsNullOrEmpty(storageFile) && File.Exists(storageFile))
+                    return JsonSerializer.Deserialize(File.ReadAllText(storageFile), JsonCodeGen.Default.ListConventionalCommitType) ?? [];
+            }
+            catch
+            {
+                // Ignore errors.
+            }
+
+            return new List<ConventionalCommitType> {
+                new("Features", "feat", "Adding a new feature"),
+                new("Bug Fixes", "fix", "Fixing a bug"),
+                new("Work In Progress", "wip", "Still being developed and not yet complete"),
+                new("Reverts", "revert", "Undoing a previous commit"),
+                new("Code Refactoring", "refactor", "Restructuring code without changing its external behavior"),
+                new("Performance Improvements", "perf", "Improves performance"),
+                new("Builds", "build", "Changes that affect the build system or external dependencies"),
+                new("Continuous Integrations", "ci", "Changes to CI configuration files and scripts"),
+                new("Documentations", "docs", "Updating documentation"),
+                new("Styles", "style", "Elements or code styles without changing the code logic"),
+                new("Tests", "test", "Adding or updating tests"),
+                new("Chores", "chore", "Other changes that don't modify src or test files"),
+            };
+        }
     }
 }
diff --git a/src/Models/RepositorySettings.cs b/src/Models/RepositorySettings.cs
@@ -236,6 +236,12 @@ public string LastCommitMessage
             set;
         } = string.Empty;
 
+        public string ConventionalTypesOverride
+        {
+            get;
+            set;
+        } = string.Empty;
+
         public Dictionary<string, FilterMode> CollectHistoriesFilters()
         {
             var map = new Dictionary<string, FilterMode>();
diff --git a/src/Resources/Locales/en_US.axaml b/src/Resources/Locales/en_US.axaml
@@ -222,6 +222,7 @@
   <x:String x:Key="Text.Configure.Git" xml:space="preserve">GIT</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetch" xml:space="preserve">Fetch remotes automatically</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetchIntervalSuffix" xml:space="preserve">Minute(s)</x:String>
+  <x:String x:Key="Text.Configure.Git.ConventionalTypesOverride" xml:space="preserve">Conventional Commit Types</x:String>
   <x:String x:Key="Text.Configure.Git.DefaultRemote" xml:space="preserve">Default Remote</x:String>
   <x:String x:Key="Text.Configure.Git.PreferredMergeMode" xml:space="preserve">Preferred Merge Mode</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">ISSUE TRACKER</x:String>
diff --git a/src/Resources/Locales/zh_CN.axaml b/src/Resources/Locales/zh_CN.axaml
@@ -226,6 +226,7 @@
   <x:String x:Key="Text.Configure.Git" xml:space="preserve">GIT配置</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetch" xml:space="preserve">启用定时自动拉取远程更新</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetchIntervalSuffix" xml:space="preserve">分钟</x:String>
+  <x:String x:Key="Text.Configure.Git.ConventionalTypesOverride" xml:space="preserve">自定义规范化提交类型</x:String>
   <x:String x:Key="Text.Configure.Git.DefaultRemote" xml:space="preserve">默认远程</x:String>
   <x:String x:Key="Text.Configure.Git.PreferredMergeMode" xml:space="preserve">默认合并方式</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">ISSUE追踪</x:String>
diff --git a/src/Resources/Locales/zh_TW.axaml b/src/Resources/Locales/zh_TW.axaml
@@ -226,6 +226,7 @@
   <x:String x:Key="Text.Configure.Git" xml:space="preserve">Git 設定</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetch" xml:space="preserve">啟用定時自動提取 (fetch) 遠端更新</x:String>
   <x:String x:Key="Text.Configure.Git.AutoFetchIntervalSuffix" xml:space="preserve">分鐘</x:String>
+  <x:String x:Key="Text.Configure.Git.ConventionalTypesOverride" xml:space="preserve">自訂約定式提交類型</x:String>
   <x:String x:Key="Text.Configure.Git.DefaultRemote" xml:space="preserve">預設遠端存放庫</x:String>
   <x:String x:Key="Text.Configure.Git.PreferredMergeMode" xml:space="preserve">預設合併模式</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">Issue 追蹤</x:String>
diff --git a/src/ViewModels/ConventionalCommitMessageBuilder.cs b/src/ViewModels/ConventionalCommitMessageBuilder.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
 using System.Diagnostics.CodeAnalysis;
 using System.Text;
@@ -9,11 +10,17 @@ namespace SourceGit.ViewModels
 {
     public class ConventionalCommitMessageBuilder : ObservableValidator
     {
+        public List<Models.ConventionalCommitType> Types
+        {
+            get;
+            private set;
+        } = [];
+
         [Required(ErrorMessage = "Type of changes can not be null")]
-        public Models.ConventionalCommitType Type
+        public Models.ConventionalCommitType SelectedType
         {
-            get => _type;
-            set => SetProperty(ref _type, value, true);
+            get => _selectedType;
+            set => SetProperty(ref _selectedType, value, true);
         }
 
         public string Scope
@@ -47,8 +54,10 @@ public string ClosedIssue
             set => SetProperty(ref _closedIssue, value);
         }
 
-        public ConventionalCommitMessageBuilder(Action<string> onApply)
+        public ConventionalCommitMessageBuilder(string conventionalTypesOverride, Action<string> onApply)
         {
+            Types = Models.ConventionalCommitType.Load(conventionalTypesOverride);
+            SelectedType = Types.Count > 0 ? Types[0] : null;
             _onApply = onApply;
         }
 
@@ -63,7 +72,7 @@ public bool Apply()
                 return false;
 
             var builder = new StringBuilder();
-            builder.Append(_type.Type);
+            builder.Append(_selectedType.Type);
 
             if (!string.IsNullOrEmpty(_scope))
             {
@@ -103,7 +112,7 @@ public bool Apply()
         }
 
         private Action<string> _onApply = null;
-        private Models.ConventionalCommitType _type = Models.ConventionalCommitType.Supported[0];
+        private Models.ConventionalCommitType _selectedType = null;
         private string _scope = string.Empty;
         private string _description = string.Empty;
         private string _detail = string.Empty;
diff --git a/src/ViewModels/InteractiveRebase.cs b/src/ViewModels/InteractiveRebase.cs
@@ -96,6 +96,11 @@ public AvaloniaList<Models.IssueTracker> IssueTrackers
             get => _repo.IssueTrackers;
         }
 
+        public string ConventionalTypesOverride
+        {
+            get => _repo.Settings.ConventionalTypesOverride;
+        }
+
         public bool IsLoading
         {
             get => _isLoading;
diff --git a/src/ViewModels/RepositoryConfigure.cs b/src/ViewModels/RepositoryConfigure.cs
@@ -76,6 +76,19 @@ public string HttpProxy
             set => SetProperty(ref _httpProxy, value);
         }
 
+        public string ConventionalTypesOverride
+        {
+            get => _repo.Settings.ConventionalTypesOverride;
+            set
+            {
+                if (_repo.Settings.ConventionalTypesOverride != value)
+                {
+                    _repo.Settings.ConventionalTypesOverride = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
+
         public bool EnablePruneOnFetch
         {
             get;
diff --git a/src/Views/CommitMessageEditor.axaml.cs b/src/Views/CommitMessageEditor.axaml.cs
@@ -1,12 +1,18 @@
 using System;
 using System.IO;
-
+using System.Text.Json;
 using Avalonia.Interactivity;
 
 namespace SourceGit.Views
 {
     public partial class CommitMessageEditor : ChromelessWindow
     {
+        public string ConventionalTypesOverride
+        {
+            get;
+            private set;
+        } = string.Empty;
+
         public CommitMessageEditor()
         {
             CloseOnESC = true;
@@ -15,6 +21,25 @@ public CommitMessageEditor()
 
         public void AsStandalone(string file)
         {
+            var gitDir = new Commands.QueryGitDir(Path.GetDirectoryName(file)).GetResult();
+            if (!string.IsNullOrEmpty(gitDir))
+            {
+                var settingsFile = Path.Combine(gitDir, "sourcegit.settings");
+                if (File.Exists(settingsFile))
+                {
+                    try
+                    {
+                        using var stream = File.OpenRead(settingsFile);
+                        var settings = JsonSerializer.Deserialize(stream, JsonCodeGen.Default.RepositorySettings);
+                        ConventionalTypesOverride = settings.ConventionalTypesOverride;
+                    }
+                    catch
+                    {
+                        // Ignore errors
+                    }
+                }
+            }
+
             _onSave = msg => File.WriteAllText(file, msg);
             _shouldExitApp = true;
 
@@ -25,8 +50,10 @@ public void AsStandalone(string file)
                 Editor.DescriptionEditor.Text = parts[1].Trim();
         }
 
-        public void AsBuiltin(string msg, Action<string> onSave)
+        public void AsBuiltin(string conventionalTypesOverride, string msg, Action<string> onSave)
         {
+            ConventionalTypesOverride = conventionalTypesOverride;
+
             _onSave = onSave;
             _shouldExitApp = false;
 
diff --git a/src/Views/CommitMessageTextBox.axaml.cs b/src/Views/CommitMessageTextBox.axaml.cs
@@ -339,13 +339,21 @@ private async void OnOpenOpenAIHelper(object sender, RoutedEventArgs e)
 
         private async void OnOpenConventionalCommitHelper(object _, RoutedEventArgs e)
         {
-            var toplevel = TopLevel.GetTopLevel(this);
-            if (toplevel is Window owner)
+            var owner = TopLevel.GetTopLevel(this) as Window;
+            if (owner == null)
+                return;
+
+            var conventionalTypesOverride = owner switch
             {
-                var vm = new ViewModels.ConventionalCommitMessageBuilder(text => Text = text);
-                var builder = new ConventionalCommitMessageBuilder() { DataContext = vm };
-                await builder.ShowDialog(owner);
-            }
+                Launcher { DataContext: ViewModels.Launcher { ActivePage: { Data: ViewModels.Repository repo } } } => repo.Settings.ConventionalTypesOverride,
+                RepositoryConfigure { DataContext: ViewModels.RepositoryConfigure config } => config.ConventionalTypesOverride,
+                CommitMessageEditor editor => editor.ConventionalTypesOverride,
+                _ => string.Empty
+            };
+
+            var vm = new ViewModels.ConventionalCommitMessageBuilder(conventionalTypesOverride, text => Text = text);
+            var builder = new ConventionalCommitMessageBuilder() { DataContext = vm };
+            await builder.ShowDialog(owner);
 
             e.Handled = true;
         }
diff --git a/src/Views/ConventionalCommitMessageBuilder.axaml b/src/Views/ConventionalCommitMessageBuilder.axaml
@@ -47,8 +47,8 @@
       <ComboBox Grid.Row="0" Grid.Column="1"
                 Height="28" Padding="8,0"
                 VerticalAlignment="Center" HorizontalAlignment="Stretch"
-                ItemsSource="{Binding Source={x:Static m:ConventionalCommitType.Supported}}"
-                SelectedItem="{Binding Type, Mode=TwoWay}"
+                ItemsSource="{Binding Types, Mode=OneWay}"
+                SelectedItem="{Binding SelectedType, Mode=TwoWay}"
                 Grid.IsSharedSizeScope="True">
         <ComboBox.SelectionBoxItemTemplate>
           <DataTemplate DataType="m:ConventionalCommitType">
diff --git a/src/Views/InteractiveRebase.axaml.cs b/src/Views/InteractiveRebase.axaml.cs
@@ -103,8 +103,11 @@ public InteractiveRebase()
 
         public void OpenCommitMessageEditor(ViewModels.InteractiveRebaseItem item)
         {
+            if (DataContext is not ViewModels.InteractiveRebase vm)
+                return;
+
             var dialog = new CommitMessageEditor();
-            dialog.AsBuiltin(item.FullMessage, msg => item.FullMessage = msg);
+            dialog.AsBuiltin(vm.ConventionalTypesOverride, item.FullMessage, msg => item.FullMessage = msg);
             dialog.ShowDialog(this);
         }
 
diff --git a/src/Views/RepositoryConfigure.axaml b/src/Views/RepositoryConfigure.axaml
@@ -44,7 +44,7 @@
           <TextBlock Classes="tab_header" Text="{DynamicResource Text.Configure.Git}"/>
         </TabItem.Header>
 
-        <Grid Margin="16,4,16,8" RowDefinitions="32,32,32,32,32,32,32,32,32,32" ColumnDefinitions="Auto,*">
+        <Grid Margin="16,4,16,8" RowDefinitions="32,32,32,32,32,32,32,32,32,32,32" ColumnDefinitions="Auto,*">
           <TextBlock Grid.Row="0" Grid.Column="0"
                      HorizontalAlignment="Right" VerticalAlignment="Center"
                      Margin="0,0,8,0"
@@ -147,19 +147,34 @@
                    Watermark="{DynamicResource Text.Preferences.GPG.UserKey.Placeholder}"
                    Text="{Binding GPGUserSigningKey, Mode=TwoWay}"/>
 
-          <CheckBox Grid.Row="6" Grid.Column="1"
+          <TextBlock Grid.Row="6" Grid.Column="0"
+                     Text="{DynamicResource Text.Configure.Git.ConventionalTypesOverride}"
+                     HorizontalAlignment="Right"
+                     Margin="0,0,8,0"/>
+          <TextBox Grid.Row="6" Grid.Column="1"
+                   Height="28"
+                   CornerRadius="3"
+                   Text="{Binding ConventionalTypesOverride, Mode=TwoWay}">
+            <TextBox.InnerRightContent>
+              <Button Classes="icon_button" Width="30" Height="30" Click="SelectConventionalTypesFile">
+                <Path Data="{StaticResource Icons.Folder.Open}" Fill="{DynamicResource Brush.FG1}"/>
+              </Button>
+            </TextBox.InnerRightContent>
+          </TextBox>
+
+          <CheckBox Grid.Row="7" Grid.Column="1"
                     Content="{DynamicResource Text.Preferences.GPG.CommitEnabled}"
                     IsChecked="{Binding GPGCommitSigningEnabled, Mode=TwoWay}"/>
 
-          <CheckBox Grid.Row="7" Grid.Column="1"
+          <CheckBox Grid.Row="8" Grid.Column="1"
                     Content="{DynamicResource Text.Preferences.GPG.TagEnabled}"
                     IsChecked="{Binding GPGTagSigningEnabled, Mode=TwoWay}"/>
 
-          <CheckBox Grid.Row="8" Grid.Column="1"
+          <CheckBox Grid.Row="9" Grid.Column="1"
                     Content="{DynamicResource Text.Preferences.Git.EnablePruneOnFetch}"
                     IsChecked="{Binding EnablePruneOnFetch, Mode=TwoWay}"/>
 
-          <StackPanel Grid.Row="9" Grid.Column="1" Orientation="Horizontal">
+          <StackPanel Grid.Row="10" Grid.Column="1" Orientation="Horizontal">
             <CheckBox x:Name="AutoFetchCheckBox"
                       Content="{DynamicResource Text.Configure.Git.AutoFetch}"
                       IsChecked="{Binding EnableAutoFetch, Mode=TwoWay}"/>
diff --git a/src/Views/RepositoryConfigure.axaml.cs b/src/Views/RepositoryConfigure.axaml.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`using System;`
	`2`	`+using System.Collections.Generic;`
`2`	`3`	`using System.ComponentModel.DataAnnotations;`
`3`	`4`	`using System.Diagnostics.CodeAnalysis;`
`4`	`5`	`using System.Text;`
`@@ -9,11 +10,17 @@ namespace SourceGit.ViewModels`
`9`	`10`	`{`
`10`	`11`	`public class ConventionalCommitMessageBuilder : ObservableValidator`
`11`	`12`	`{`
	`13`	`+ public List<Models.ConventionalCommitType> Types`
	`14`	`+ {`
	`15`	`+ get;`
	`16`	`+ private set;`
	`17`	`+ } = [];`
	`18`	`+`
`12`	`19`	`[Required(ErrorMessage = "Type of changes can not be null")]`
`13`		`- public Models.ConventionalCommitType Type`
	`20`	`+ public Models.ConventionalCommitType SelectedType`
`14`	`21`	`{`
`15`		`- get => _type;`
`16`		`- set => SetProperty(ref _type, value, true);`
	`22`	`+ get => _selectedType;`
	`23`	`+ set => SetProperty(ref _selectedType, value, true);`
`17`	`24`	`}`
`18`	`25`
`19`	`26`	`public string Scope`
`@@ -47,8 +54,10 @@ public string ClosedIssue`
`47`	`54`	`set => SetProperty(ref _closedIssue, value);`
`48`	`55`	`}`
`49`	`56`
`50`		`- public ConventionalCommitMessageBuilder(Action<string> onApply)`
	`57`	`+ public ConventionalCommitMessageBuilder(string conventionalTypesOverride, Action<string> onApply)`
`51`	`58`	`{`
	`59`	`+ Types = Models.ConventionalCommitType.Load(conventionalTypesOverride);`
	`60`	`+ SelectedType = Types.Count > 0 ? Types[0] : null;`
`52`	`61`	`_onApply = onApply;`
`53`	`62`	`}`
`54`	`63`
`@@ -63,7 +72,7 @@ public bool Apply()`
`63`	`72`	`return false;`
`64`	`73`
`65`	`74`	`var builder = new StringBuilder();`
`66`		`- builder.Append(_type.Type);`
	`75`	`+ builder.Append(_selectedType.Type);`
`67`	`76`
`68`	`77`	`if (!string.IsNullOrEmpty(_scope))`
`69`	`78`	`{`
`@@ -103,7 +112,7 @@ public bool Apply()`
`103`	`112`	`}`
`104`	`113`
`105`	`114`	`private Action<string> _onApply = null;`
`106`		`- private Models.ConventionalCommitType _type = Models.ConventionalCommitType.Supported[0];`
	`115`	`+ private Models.ConventionalCommitType _selectedType = null;`
`107`	`116`	`private string _scope = string.Empty;`
`108`	`117`	`private string _description = string.Empty;`
`109`	`118`	`private string _detail = string.Empty;`
Original file line number	Diff line number	Diff line change
`@@ -96,6 +96,11 @@ public AvaloniaList<Models.IssueTracker> IssueTrackers`
`96`	`96`	`get => _repo.IssueTrackers;`
`97`	`97`	`}`
`98`	`98`
	`99`	`+ public string ConventionalTypesOverride`
	`100`	`+ {`
	`101`	`+ get => _repo.Settings.ConventionalTypesOverride;`
	`102`	`+ }`
	`103`	`+`
`99`	`104`	`public bool IsLoading`
`100`	`105`	`{`
`101`	`106`	`get => _isLoading;`