Merge pull request Flow-Launcher#4023 from Flow-Launcher/shell_setting_panel_enhancement

Refactor ShellSettings with Binding & Fix IsEnabled logic

Author: Jack251970

Plugins/Flow.Launcher.Plugin.Shell/Converters/LeaveShellOpenOrCloseShellAfterPressEnabledConverter.cs

@@ -0,0 +1,25 @@
+using System;
+using System.Globalization;
+using System.Windows.Data;
+
+namespace Flow.Launcher.Plugin.Shell.Converters;
+
+public class LeaveShellOpenOrCloseShellAfterPressEnabledConverter : IMultiValueConverter
+{
+    public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
+    {
+        if (
+            values.Length != 2 ||
+            values[0] is not bool closeShellAfterPressOrLeaveShellOpen ||
+            values[1] is not Shell shell
+        )
+            return Binding.DoNothing;
+
+        return (!closeShellAfterPressOrLeaveShellOpen) && shell != Shell.RunCommand;
+    }
+
+    public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
+    {
+        throw new NotImplementedException();
+    }
+}

Plugins/Flow.Launcher.Plugin.Shell/Main.cs

@@ -5,6 +5,7 @@
 using System.IO;
 using System.Linq;
 using Flow.Launcher.Plugin.SharedCommands;
+using Flow.Launcher.Plugin.Shell.Views;
 using Control = System.Windows.Controls.Control;
 
 namespace Flow.Launcher.Plugin.Shell
@@ -376,6 +377,14 @@ public void Init(PluginInitContext context)
         {
             Context = context;
             _settings = context.API.LoadSettingJsonStorage<Settings>();
+
+            // Since the old Settings class set default value of ShowOnlyMostUsedCMDsNumber to 0 which is a wrong value,
+            // we need to fix it here to make sure the default value is 5
+            // todo: remove this code block after release v2.2.0
+            if (_settings.ShowOnlyMostUsedCMDsNumber == 0)
+            {
+                _settings.ShowOnlyMostUsedCMDsNumber = 5;
+            }
         }
 
         public Control CreateSettingPanel()

Plugins/Flow.Launcher.Plugin.Shell/Settings.cs

@@ -1,22 +1,107 @@
 using System.Collections.Generic;
+using Flow.Launcher.Localization.Attributes;
 
 namespace Flow.Launcher.Plugin.Shell
 {
-    public class Settings
+    public class Settings : BaseModel
     {
-        public Shell Shell { get; set; } = Shell.Cmd;
+        private Shell _shell = Shell.Cmd;
+        public Shell Shell
+        {
+            get => _shell;
+            set
+            {
+                if (_shell != value)
+                {
+                    _shell = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
 
-        public bool CloseShellAfterPress { get; set; } = false;
+        private bool _closeShellAfterPress = false;
+        public bool CloseShellAfterPress
+        {
+            get => _closeShellAfterPress;
+            set
+            {
+                if (_closeShellAfterPress != value)
+                {
+                    _closeShellAfterPress = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
 
-        public bool LeaveShellOpen { get; set; }
+        private bool _leaveShellOpen;
+        public bool LeaveShellOpen
+        {
+            get => _leaveShellOpen;
+            set
+            {
+                if (_leaveShellOpen != value)
+                {
+                    _leaveShellOpen = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
 
-        public bool RunAsAdministrator { get; set; } = true;
+        private bool _runAsAdministrator = true;
+        public bool RunAsAdministrator
+        {
+            get => _runAsAdministrator;
+            set
+            {
+                if (_runAsAdministrator != value)
+                {
+                    _runAsAdministrator = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
 
-        public bool UseWindowsTerminal { get; set; } = false;
+        private bool _useWindowsTerminal = false;
+        public bool UseWindowsTerminal
+        {
+            get => _useWindowsTerminal;
+            set
+            {
+                if (_useWindowsTerminal != value)
+                {
+                    _useWindowsTerminal = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
 
-        public bool ShowOnlyMostUsedCMDs { get; set; }
+        private bool _showOnlyMostUsedCMDs;
+        public bool ShowOnlyMostUsedCMDs
+        {
+            get => _showOnlyMostUsedCMDs;
+            set
+            {
+                if (_showOnlyMostUsedCMDs != value)
+                {
+                    _showOnlyMostUsedCMDs = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
 
-        public int ShowOnlyMostUsedCMDsNumber { get; set; }
+        private int _showOnlyMostUsedCMDsNumber = 5;
+        public int ShowOnlyMostUsedCMDsNumber
+        {
+            get => _showOnlyMostUsedCMDsNumber;
+            set
+            {
+                if (_showOnlyMostUsedCMDsNumber != value)
+                {
+                    _showOnlyMostUsedCMDsNumber = value;
+                    OnPropertyChanged();
+                }
+            }
+        }
 
         public Dictionary<string, int> CommandHistory { get; set; } = [];
 
@@ -29,11 +114,19 @@ public void AddCmdHistory(string cmdName)
         }
     }
 
+    [EnumLocalize]
     public enum Shell
     {
+        [EnumLocalizeValue("CMD")]
         Cmd = 0,
+
+        [EnumLocalizeValue("PowerShell")]
         Powershell = 1,
+
+        [EnumLocalizeValue("RunCommand")]
         RunCommand = 2,
+
+        [EnumLocalizeValue("Pwsh")]
         Pwsh = 3,
     }
 }

Plugins/Flow.Launcher.Plugin.Shell/ShellSetting.xaml.cs

@@ -0,0 +1,78 @@
+using System.Collections.Generic;
+
+namespace Flow.Launcher.Plugin.Shell.ViewModels;
+
+public class ShellSettingViewModel : BaseModel
+{
+    public Settings Settings { get; }
+
+    public List<ShellLocalized> AllShells { get; } = ShellLocalized.GetValues();
+
+    public Shell SelectedShell
+    {
+        get => Settings.Shell;
+        set
+        {
+            if (Settings.Shell != value)
+            {
+                Settings.Shell = value;
+                OnPropertyChanged();
+            }
+        }
+    }
+
+    public List<int> OnlyMostUsedCMDsNumbers { get; } = [5, 10, 20];
+    public int SelectedOnlyMostUsedCMDsNumber
+    {
+        get => Settings.ShowOnlyMostUsedCMDsNumber;
+        set
+        {
+            if (Settings.ShowOnlyMostUsedCMDsNumber != value)
+            {
+                Settings.ShowOnlyMostUsedCMDsNumber = value;
+                OnPropertyChanged();
+            }
+        }
+    }
+
+    public bool CloseShellAfterPress
+    {
+        get => Settings.CloseShellAfterPress;
+        set
+        {
+            if (Settings.CloseShellAfterPress != value)
+            {
+                Settings.CloseShellAfterPress = value;
+                OnPropertyChanged();
+                // Only allow CloseShellAfterPress to be true when LeaveShellOpen is false
+                if (value)
+                {
+                    LeaveShellOpen = false;
+                }
+            }
+        }
+    }
+
+    public bool LeaveShellOpen
+    {
+        get => Settings.LeaveShellOpen;
+        set
+        {
+            if (Settings.LeaveShellOpen != value)
+            {
+                Settings.LeaveShellOpen = value;
+                OnPropertyChanged();
+                // Only allow LeaveShellOpen to be true when CloseShellAfterPress is false
+                if (value)
+                {
+                    CloseShellAfterPress = false;
+                }
+            }
+        }
+    }
+
+    public ShellSettingViewModel(Settings settings)
+    {
+        Settings = settings;
+    }
+}