[PT Run > Time and Date plugin] Custom formats and other improvements (#37743)

* add settings definition

* fix typos and improve settings

* make spell checker happy

* new icon type error

* first code to handle custom formats

* support parsing of new formats

* spelling and typos

* comment fix

* spell check

* start implement custom format results

* last changes

* finish implementation

* spell checker

* settings name

* add missing format

* reorder settings

* dev docs

* change ELF to EAB

* update dev docs

* last changes

* test cases

* fix typos

* fix typo

* port changes

* fixes

* changes

* fixes

* leap year support

* days in month

* tests

* comment

* fix comment

src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.TimeDate/Components/TimeDateSettings.cs

@@ -61,6 +61,11 @@ namespace Microsoft.PowerToys.Run.Plugin.TimeDate.Components
         /// </summary>
         internal bool HideNumberMessageOnGlobalQuery { get; private set; }
 
+        /// <summary>
+        /// Gets a value containing the custom format definitions
+        /// </summary>
+        internal List<string> CustomFormats { get; private set; }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="TimeDateSettings"/> class.
         /// Private constructor to make sure there is never more than one instance of this class
@@ -100,29 +105,6 @@ namespace Microsoft.PowerToys.Run.Plugin.TimeDate.Components
         {
             var optionList = new List<PluginAdditionalOption>
             {
-                new PluginAdditionalOption()
-                {
-                    Key = nameof(CalendarFirstWeekRule),
-                    DisplayLabel = Resources.Microsoft_plugin_timedate_SettingFirstWeekRule,
-                    DisplayDescription = Resources.Microsoft_plugin_timedate_SettingFirstWeekRule_Description,
-                    PluginOptionType = PluginAdditionalOption.AdditionalOptionType.Combobox,
-                    ComboBoxItems = new List<KeyValuePair<string, string>>
-                    {
-                        new KeyValuePair<string, string>(Resources.Microsoft_plugin_timedate_Setting_UseSystemSetting, "-1"),
-                        new KeyValuePair<string, string>(Resources.Microsoft_plugin_timedate_SettingFirstWeekRule_FirstDay, "0"),
-                        new KeyValuePair<string, string>(Resources.Microsoft_plugin_timedate_SettingFirstWeekRule_FirstFullWeek, "1"),
-                        new KeyValuePair<string, string>(Resources.Microsoft_plugin_timedate_SettingFirstWeekRule_FirstFourDayWeek, "2"),
-                    },
-                    ComboBoxValue = -1,
-                },
-                new PluginAdditionalOption()
-                {
-                    Key = nameof(FirstDayOfWeek),
-                    DisplayLabel = Resources.Microsoft_plugin_timedate_SettingFirstDayOfWeek,
-                    PluginOptionType = PluginAdditionalOption.AdditionalOptionType.Combobox,
-                    ComboBoxItems = GetSortedListForWeekDaySetting(),
-                    ComboBoxValue = -1,
-                },
                 new PluginAdditionalOption()
                 {
                     Key = nameof(OnlyDateTimeNowGlobal),
@@ -150,6 +132,38 @@ namespace Microsoft.PowerToys.Run.Plugin.TimeDate.Components
                     DisplayLabel = Resources.Microsoft_plugin_timedate_SettingHideNumberMessageOnGlobalQuery,
                     Value = false,
                 },
+                new PluginAdditionalOption()
+                {
+                    Key = nameof(CalendarFirstWeekRule),
+                    DisplayLabel = Resources.Microsoft_plugin_timedate_SettingFirstWeekRule,
+                    DisplayDescription = Resources.Microsoft_plugin_timedate_SettingFirstWeekRule_Description,
+                    PluginOptionType = PluginAdditionalOption.AdditionalOptionType.Combobox,
+                    ComboBoxItems = new List<KeyValuePair<string, string>>
+                    {
+                        new KeyValuePair<string, string>(Resources.Microsoft_plugin_timedate_Setting_UseSystemSetting, "-1"),
+                        new KeyValuePair<string, string>(Resources.Microsoft_plugin_timedate_SettingFirstWeekRule_FirstDay, "0"),
+                        new KeyValuePair<string, string>(Resources.Microsoft_plugin_timedate_SettingFirstWeekRule_FirstFullWeek, "1"),
+                        new KeyValuePair<string, string>(Resources.Microsoft_plugin_timedate_SettingFirstWeekRule_FirstFourDayWeek, "2"),
+                    },
+                    ComboBoxValue = -1,
+                },
+                new PluginAdditionalOption()
+                {
+                    Key = nameof(FirstDayOfWeek),
+                    DisplayLabel = Resources.Microsoft_plugin_timedate_SettingFirstDayOfWeek,
+                    PluginOptionType = PluginAdditionalOption.AdditionalOptionType.Combobox,
+                    ComboBoxItems = GetSortedListForWeekDaySetting(),
+                    ComboBoxValue = -1,
+                },
+                new PluginAdditionalOption()
+                {
+                    Key = nameof(CustomFormats),
+                    PluginOptionType = PluginAdditionalOption.AdditionalOptionType.MultilineTextbox,
+                    DisplayLabel = Resources.Microsoft_plugin_timedate_Setting_CustomFormats,
+                    DisplayDescription = string.Format(CultureInfo.CurrentCulture, Resources.Microsoft_plugin_timedate_Setting_CustomFormatsDescription.ToString(), "DOW", "DIM", "WOM", "WOY", "EAB", "WFT", "UXT", "UMS", "OAD", "EXC", "EXF", "UTC:"),
+                    PlaceholderText = "MyFormat=dd-MMM-yyyy\rMySecondFormat=dddd (Da\\y nu\\mber: DOW)\rMyUtcFormat=UTC:hh:mm:ss",
+                    TextValue = string.Empty,
+                },
             };
 
             return optionList;
@@ -172,6 +186,7 @@ namespace Microsoft.PowerToys.Run.Plugin.TimeDate.Components
             TimeWithSeconds = GetSettingOrDefault(settings, nameof(TimeWithSeconds));
             DateWithWeekday = GetSettingOrDefault(settings, nameof(DateWithWeekday));
             HideNumberMessageOnGlobalQuery = GetSettingOrDefault(settings, nameof(HideNumberMessageOnGlobalQuery));
+            CustomFormats = GetMultilineTextSettingOrDefault(settings, nameof(CustomFormats));
         }
 
         /// <summary>
@@ -204,6 +219,21 @@ namespace Microsoft.PowerToys.Run.Plugin.TimeDate.Components
             return option?.ComboBoxValue ?? GetAdditionalOptions().First(x => x.Key == name).ComboBoxValue;
         }
 
+        /// <summary>
+        /// Return the combobox value of the given settings list with the given name.
+        /// </summary>
+        /// <param name="settings">The object that contain all settings.</param>
+        /// <param name="name">The name of the setting.</param>
+        /// <returns>A settings value.</returns>
+        private static List<string> GetMultilineTextSettingOrDefault(PowerLauncherPluginSettings settings, string name)
+        {
+            var option = settings?.AdditionalOptions?.FirstOrDefault(x => x.Key == name);
+
+            // If a setting isn't available, we use the value defined in the method GetAdditionalOptions() as fallback.
+            // We can use First() instead of FirstOrDefault() because the values must exist. Otherwise, we made a mistake when defining the settings.
+            return option?.TextValueAsMultilineList ?? GetAdditionalOptions().First(x => x.Key == name).TextValueAsMultilineList;
+        }
+
         /// <summary>
         /// Returns a sorted list of values for the combo box of 'first day of week' setting.
         /// The list is sorted based on the current system culture setting.