feature: add an option in repository configuration to enable --prune on fetch (#590)

love-linger · love-linger · commit 3cbffa6ff93b · 2024-10-30T18:39:38.000+08:00
Signed-off-by: leo &lt;longshuang@msn.cn&gt;
diff --git a/src/Commands/Fetch.cs b/src/Commands/Fetch.cs
@@ -4,7 +4,7 @@ namespace SourceGit.Commands
 {
     public class Fetch : Command
     {
-        public Fetch(string repo, string remote, bool noTags, Action<string> outputHandler)
+        public Fetch(string repo, string remote, bool noTags, bool prune, Action<string> outputHandler)
         {
             _outputHandler = outputHandler;
             WorkingDirectory = repo;
@@ -18,6 +18,9 @@ public Fetch(string repo, string remote, bool noTags, Action<string> outputHandl
             else
                 Args += "--force ";
 
+            if (prune)
+                Args += "--prune ";
+
             Args += remote;
         }
 
diff --git a/src/Commands/Pull.cs b/src/Commands/Pull.cs
@@ -4,7 +4,7 @@ namespace SourceGit.Commands
 {
     public class Pull : Command
     {
-        public Pull(string repo, string remote, string branch, bool useRebase, bool noTags, Action<string> outputHandler)
+        public Pull(string repo, string remote, string branch, bool useRebase, bool noTags, bool prune, Action<string> outputHandler)
         {
             _outputHandler = outputHandler;
             WorkingDirectory = repo;
@@ -17,6 +17,8 @@ public Pull(string repo, string remote, string branch, bool useRebase, bool noTa
                 Args += "--rebase ";
             if (noTags)
                 Args += "--no-tags ";
+            if (prune)
+                Args += "--prune ";
 
             Args += $"{remote} {branch}";
         }
diff --git a/src/Models/RepositorySettings.cs b/src/Models/RepositorySettings.cs
@@ -16,6 +16,12 @@ public DealWithLocalChanges DealWithLocalChangesOnCheckoutBranch
             set;
         } = DealWithLocalChanges.DoNothing;
 
+        public bool EnablePruneOnFetch
+        {
+            get;
+            set;
+        } = false;
+
         public bool FetchWithoutTags
         {
             get;
diff --git a/src/Resources/Locales/en_US.axaml b/src/Resources/Locales/en_US.axaml
@@ -145,6 +145,7 @@
   <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.DefaultRemote" xml:space="preserve">Default Remote</x:String>
+  <x:String x:Key="Text.Configure.Git.EnablePruneOnFetch" xml:space="preserve">Enable --prune on fetch</x:String>
   <x:String x:Key="Text.Configure.Git.EnableSignOff" xml:space="preserve">Enable --signoff for commit</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">ISSUE TRACKER</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleGithub" xml:space="preserve">Add Sample Github Rule</x:String>
diff --git a/src/Resources/Locales/zh_CN.axaml b/src/Resources/Locales/zh_CN.axaml
@@ -149,6 +149,7 @@
   <x:String x:Key="Text.Configure.Git.AutoFetchIntervalSuffix" 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.EnableSignOff" xml:space="preserve">提交信息追加署名 (--signoff)</x:String>
+  <x:String x:Key="Text.Configure.Git.EnablePruneOnFetch" xml:space="preserve">拉取更新时启用修剪（--prune）</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">ISSUE追踪</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleGithub" xml:space="preserve">新增匹配Github Issue规则</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleJira" xml:space="preserve">新增匹配Jira规则</x:String>
diff --git a/src/Resources/Locales/zh_TW.axaml b/src/Resources/Locales/zh_TW.axaml
@@ -149,6 +149,7 @@
   <x:String x:Key="Text.Configure.Git.AutoFetchIntervalSuffix" 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.EnableSignOff" xml:space="preserve">提交訊息追加署名 (--signoff)</x:String>
+  <x:String x:Key="Text.Configure.Git.EnablePruneOnFetch" xml:space="preserve">提取變更时啟用修剪（--prune）</x:String>
   <x:String x:Key="Text.Configure.IssueTracker" xml:space="preserve">Issue 追蹤</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleGithub" xml:space="preserve">新增符合 GitHub Issue 規則</x:String>
   <x:String x:Key="Text.Configure.IssueTracker.AddSampleJira" xml:space="preserve">新增符合 Jira 規則</x:String>
diff --git a/src/ViewModels/AddRemote.cs b/src/ViewModels/AddRemote.cs
@@ -100,7 +100,7 @@ public override Task<bool> Sure()
                 {
                     SetProgressDescription("Fetching from added remote ...");
                     new Commands.Config(_repo.FullPath).Set($"remote.{_name}.sshkey", _useSSH ? SSHKey : null);
-                    new Commands.Fetch(_repo.FullPath, _name, false, SetProgressDescription).Exec();
+                    new Commands.Fetch(_repo.FullPath, _name, false, false, SetProgressDescription).Exec();
                 }
                 CallUIThread(() =>
                 {
diff --git a/src/ViewModels/Fetch.cs b/src/ViewModels/Fetch.cs
@@ -40,20 +40,22 @@ public override Task<bool> Sure()
         {
             _repo.SetWatcherEnabled(false);
 
+            var notags = _repo.Settings.FetchWithoutTags;
+            var prune = _repo.Settings.EnablePruneOnFetch;
             return Task.Run(() =>
             {
                 if (FetchAllRemotes)
                 {
                     foreach (var remote in _repo.Remotes)
                     {
                         SetProgressDescription($"Fetching remote: {remote.Name}");
-                        new Commands.Fetch(_repo.FullPath, remote.Name, NoTags, SetProgressDescription).Exec();
+                        new Commands.Fetch(_repo.FullPath, remote.Name, notags, prune, SetProgressDescription).Exec();
                     }
                 }
                 else
                 {
                     SetProgressDescription($"Fetching remote: {SelectedRemote.Name}");
-                    new Commands.Fetch(_repo.FullPath, SelectedRemote.Name, NoTags, SetProgressDescription).Exec();
+                    new Commands.Fetch(_repo.FullPath, SelectedRemote.Name, notags, prune, SetProgressDescription).Exec();
                 }
 
                 CallUIThread(() =>
diff --git a/src/ViewModels/Pull.cs b/src/ViewModels/Pull.cs
@@ -147,7 +147,13 @@ public override Task<bool> Sure()
                 if (FetchAllBranches)
                 {
                     SetProgressDescription($"Fetching remote: {_selectedRemote.Name}...");
-                    rs = new Commands.Fetch(_repo.FullPath, _selectedRemote.Name, NoTags, SetProgressDescription).Exec();
+                    rs = new Commands.Fetch(
+                        _repo.FullPath,
+                        _selectedRemote.Name,
+                        NoTags,
+                        _repo.Settings.EnablePruneOnFetch,
+                        SetProgressDescription).Exec();
+
                     if (!rs)
                     {
                         CallUIThread(() => _repo.SetWatcherEnabled(true));
@@ -171,7 +177,14 @@ public override Task<bool> Sure()
                 else
                 {
                     SetProgressDescription($"Pull {_selectedRemote.Name}/{_selectedBranch.Name}...");
-                    rs = new Commands.Pull(_repo.FullPath, _selectedRemote.Name, _selectedBranch.Name, UseRebase, NoTags, SetProgressDescription).Exec();
+                    rs = new Commands.Pull(
+                        _repo.FullPath,
+                        _selectedRemote.Name,
+                        _selectedBranch.Name,
+                        UseRebase,
+                        NoTags,
+                        _repo.Settings.EnablePruneOnFetch,
+                        SetProgressDescription).Exec();
                 }
 
                 if (rs && needPopStash)
diff --git a/src/ViewModels/Repository.cs b/src/ViewModels/Repository.cs
@@ -2137,7 +2137,7 @@ private void AutoFetchImpl(object sender)
 
             IsAutoFetching = true;
             Dispatcher.UIThread.Invoke(() => OnPropertyChanged(nameof(IsAutoFetching)));
-            new Commands.Fetch(_fullpath, "--all", false, null) { RaiseError = false }.Exec();
+            new Commands.Fetch(_fullpath, "--all", false, _settings.EnablePruneOnFetch, null) { RaiseError = false }.Exec();
             _lastFetchTime = DateTime.Now;
             IsAutoFetching = false;
             Dispatcher.UIThread.Invoke(() => OnPropertyChanged(nameof(IsAutoFetching)));
diff --git a/src/ViewModels/RepositoryConfigure.cs b/src/ViewModels/RepositoryConfigure.cs
@@ -67,6 +67,12 @@ public bool EnableSignOffForCommit
             set => _repo.Settings.EnableSignOffForCommit = value;
         }
 
+        public bool EnablePruneOnFetch
+        {
+            get => _repo.Settings.EnablePruneOnFetch;
+            set => _repo.Settings.EnablePruneOnFetch = value;
+        }
+
         public bool EnableAutoFetch
         {
             get => _repo.Settings.EnableAutoFetch;
@@ -134,7 +140,7 @@ public RepositoryConfigure(Repository repo)
                 AvailableOpenAIServices.Add(service.Name);
 
             if (AvailableOpenAIServices.IndexOf(PreferedOpenAIService) == -1)
-                PreferedOpenAIService = "---";               
+                PreferedOpenAIService = "---";
 
             _cached = new Commands.Config(repo.FullPath).ListAll();
             if (_cached.TryGetValue("user.name", out var name))
diff --git a/src/Views/RepositoryConfigure.axaml b/src/Views/RepositoryConfigure.axaml
@@ -51,7 +51,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" ColumnDefinitions="Auto,*">
+        <Grid Margin="16,4,16,8" RowDefinitions="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"
@@ -130,7 +130,11 @@
                     Content="{DynamicResource Text.Preference.GPG.TagEnabled}"
                     IsChecked="{Binding GPGTagSigningEnabled, Mode=TwoWay}"/>
 
-          <StackPanel Grid.Row="8" Grid.Column="1" Orientation="Horizontal">
+          <CheckBox Grid.Row="8" Grid.Column="1"
+                    Content="{DynamicResource Text.Configure.Git.EnablePruneOnFetch}"
+                    IsChecked="{Binding EnablePruneOnFetch, Mode=TwoWay}"/>
+
+          <StackPanel Grid.Row="9" Grid.Column="1" Orientation="Horizontal">
             <CheckBox x:Name="AutoFetchCheckBox"
                       Content="{DynamicResource Text.Configure.Git.AutoFetch}"
                       IsChecked="{Binding EnableAutoFetch, Mode=TwoWay}"/>

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ namespace SourceGit.Commands`
`4`	`4`	`{`
`5`	`5`	`public class Fetch : Command`
`6`	`6`	`{`
`7`		`- public Fetch(string repo, string remote, bool noTags, Action<string> outputHandler)`
	`7`	`+ public Fetch(string repo, string remote, bool noTags, bool prune, Action<string> outputHandler)`
`8`	`8`	`{`
`9`	`9`	`_outputHandler = outputHandler;`
`10`	`10`	`WorkingDirectory = repo;`
`@@ -18,6 +18,9 @@ public Fetch(string repo, string remote, bool noTags, Action<string> outputHandl`
`18`	`18`	`else`
`19`	`19`	`Args += "--force ";`
`20`	`20`
	`21`	`+ if (prune)`
	`22`	`+ Args += "--prune ";`
	`23`	`+`
`21`	`24`	`Args += remote;`
`22`	`25`	`}`
`23`	`26`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ namespace SourceGit.Commands`
`4`	`4`	`{`
`5`	`5`	`public class Pull : Command`
`6`	`6`	`{`
`7`		`- public Pull(string repo, string remote, string branch, bool useRebase, bool noTags, Action<string> outputHandler)`
	`7`	`+ public Pull(string repo, string remote, string branch, bool useRebase, bool noTags, bool prune, Action<string> outputHandler)`
`8`	`8`	`{`
`9`	`9`	`_outputHandler = outputHandler;`
`10`	`10`	`WorkingDirectory = repo;`
`@@ -17,6 +17,8 @@ public Pull(string repo, string remote, string branch, bool useRebase, bool noTa`
`17`	`17`	`Args += "--rebase ";`
`18`	`18`	`if (noTags)`
`19`	`19`	`Args += "--no-tags ";`
	`20`	`+ if (prune)`
	`21`	`+ Args += "--prune ";`
`20`	`22`
`21`	`23`	`Args += $"{remote} {branch}";`
`22`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ public override Task<bool> Sure()`
`100`	`100`	`{`
`101`	`101`	`SetProgressDescription("Fetching from added remote ...");`
`102`	`102`	`new Commands.Config(_repo.FullPath).Set($"remote.{_name}.sshkey", _useSSH ? SSHKey : null);`
`103`		`- new Commands.Fetch(_repo.FullPath, _name, false, SetProgressDescription).Exec();`
	`103`	`+ new Commands.Fetch(_repo.FullPath, _name, false, false, SetProgressDescription).Exec();`
`104`	`104`	`}`
`105`	`105`	`CallUIThread(() =>`
`106`	`106`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,20 +40,22 @@ public override Task<bool> Sure()`
`40`	`40`	`{`
`41`	`41`	`_repo.SetWatcherEnabled(false);`
`42`	`42`
	`43`	`+ var notags = _repo.Settings.FetchWithoutTags;`
	`44`	`+ var prune = _repo.Settings.EnablePruneOnFetch;`
`43`	`45`	`return Task.Run(() =>`
`44`	`46`	`{`
`45`	`47`	`if (FetchAllRemotes)`
`46`	`48`	`{`
`47`	`49`	`foreach (var remote in _repo.Remotes)`
`48`	`50`	`{`
`49`	`51`	`SetProgressDescription($"Fetching remote: {remote.Name}");`
`50`		`- new Commands.Fetch(_repo.FullPath, remote.Name, NoTags, SetProgressDescription).Exec();`
	`52`	`+ new Commands.Fetch(_repo.FullPath, remote.Name, notags, prune, SetProgressDescription).Exec();`
`51`	`53`	`}`
`52`	`54`	`}`
`53`	`55`	`else`
`54`	`56`	`{`
`55`	`57`	`SetProgressDescription($"Fetching remote: {SelectedRemote.Name}");`
`56`		`- new Commands.Fetch(_repo.FullPath, SelectedRemote.Name, NoTags, SetProgressDescription).Exec();`
	`58`	`+ new Commands.Fetch(_repo.FullPath, SelectedRemote.Name, notags, prune, SetProgressDescription).Exec();`
`57`	`59`	`}`
`58`	`60`
`59`	`61`	`CallUIThread(() =>`