Implemented a "please rate" notice.

In the hopes to get more people to rate on the marketplace or give a GitHub star, in the hope that this will boost visibility of the extension.

Author: Sedeniono

VSDoxyHighlighter/GeneralOptionsPage.cs

@@ -222,10 +222,21 @@ public bool IsEnabledInCommentType(CommentType type)
 
     //----------------
 
-    // The value is not editable by the user.
+    // The version of the configuration format stored in the config file.
     [Browsable(false)]
     public int Version { get; set; } = (int)ConfigVersions.NoVersionInConfig;
 
+    // We show the "please rate" notice after this date, stored in ISO 8601 format.
+    // By default is it null and we set it the first time the package gets loaded.
+    [Browsable(false)]
+    public string RateNoticeDateStr { get; set; } // Must be public for serialization.
+
+    public void SaveRateNoticeDate(DateTime newDate)
+    {
+      RateNoticeDateStr = newDate.ToString("o");
+      SaveSettingsToStorage();
+    }
+
 
     //----------------
     // Flags to enable/disable the main features of the extension
@@ -469,16 +480,22 @@ private static void HandleConversionFromStringError(string valueAsString, Except
       InfoBar.ShowMessage(
         icon: KnownMonikers.StatusError,
         message: "VSDoxyHighlighter: Failed to parse Doxygen commands configuration from string. Backed up configuration and restored defaults.",
-        actions: new (string, Action)[] {
+        showCloseButton: true,
+        actions: new (string uiText, bool asButton, Func<bool> callback)[] {
                   ("Show details",
-                    () => MessageBox.Show(
-                      "VSDoxyHighlighter extension: Failed to convert the configuration of the Doxygen commands (which is stored as a JSON string) to an actual 'List<DoxygenCommandInConfig>'. "
-                      + "Corrupt settings or maybe a bug in the extension?\n"
-                      + "Default configuration of commands got restored.\n"
-                      + $"Original JSON string written to: {backupFilename}.\n\n"
-                      + $"Exception message from the conversion: {ex}\n\n"
-                      + $"JSON string that failed to get parsed:\n{valueAsString}",
-                      "VSDoxyHighlighter error", MessageBoxButtons.OK, MessageBoxIcon.Error))}
+                    false,
+                    () => {
+                      MessageBox.Show(
+                        "VSDoxyHighlighter extension: Failed to convert the configuration of the Doxygen commands (which is stored as a JSON string) to an actual 'List<DoxygenCommandInConfig>'. "
+                        + "Corrupt settings or maybe a bug in the extension?\n"
+                        + "Default configuration of commands got restored.\n"
+                        + $"Original JSON string written to: {backupFilename}.\n\n"
+                        + $"Exception message from the conversion: {ex}\n\n"
+                        + $"JSON string that failed to get parsed:\n{valueAsString}",
+                        "VSDoxyHighlighter error", MessageBoxButtons.OK, MessageBoxIcon.Error);
+                      return false;
+                    }
+                  )}
       );
     }
   }

VSDoxyHighlighter/InfoBar.cs

@@ -15,9 +15,10 @@ internal static class InfoBar
     ///        InfoBar.ShowMessage(
     ///          icon: KnownMonikers.StatusError, 
     ///          message: "test message", 
-    ///          actions: new(string, Action)[] { 
-    ///            ("yes", () => MessageBox.Show("You clicked Yes!")),
-    ///            ("no", () => MessageBox.Show("You clicked No!"))}
+    ///          actions: new(string uiText, bool asButton, Func<bool /*closeInfoBar*/> callback)[] { 
+    ///            ("yes", false, () => { MessageBox.Show("You clicked Yes!"); return false; }),
+    ///            ("no", false, () => { MessageBox.Show("You clicked No!"); return false; }),
+    ///          }
     ///        );
     ///        
     /// Note: Must be called from the main thread!
@@ -27,10 +28,17 @@ internal static class InfoBar
     /// 
     /// <param name="icon">Use the members of KnownMonikers. E.g. KnownMonikers.StatusInformation</param>
     /// <param name="message">The displayed message.</param>
-    /// <param name="actions">For each element in the array, a hyperlink with the given string as message gets created.
-    ///   When the user clicks on the hyperlinks, the given action gets executed. Use "null" or an empty array in case 
-    ///   you do not need any hyperlinks (or the dedicated overload without an "actions" item.</param>
-    public static void ShowMessage(ImageMoniker icon, string message, (string, Action)[] actions)
+    /// <param name="actions">For each element in the array, a hyperlink or button with the given string as message gets created.
+    ///   When the user clicks on one of these, the given callback gets executed. If the callback returns true, the info bar is
+    ///   closed afterwards. If the callback return false, the info bar stays open.
+    ///   Set the actions parameter to "null" or an empty array in case you do not need any interactive elements (or use the 
+    ///   dedicated overload without an "actions" parameter).
+    ///   </param>
+    public static void ShowMessage(
+        ImageMoniker icon, 
+        string message, 
+        bool showCloseButton,
+        (string uiText, bool asButton, Func<bool /*closeInfoBar*/> callback)[] actions)
     {
       ThreadHelper.ThrowIfNotOnUIThread();
 
@@ -55,17 +63,22 @@ public static void ShowMessage(ImageMoniker icon, string message, (string, Actio
         return;
       }
 
-      List<InfoBarHyperlink> hyperlinks = new List<InfoBarHyperlink>();
+      var actionItems = new List<IVsInfoBarActionItem>();
       if (actions != null) {
         foreach (var action in actions) {
-          hyperlinks.Add(new InfoBarHyperlink(action.Item1, action.Item2));
+          if (action.asButton) {
+            actionItems.Add(new InfoBarButton(action.uiText, action.callback));
+          }
+          else {
+            actionItems.Add(new InfoBarHyperlink(action.uiText, action.callback));
+          }
         }
       }
 
-      InfoBarModel infoBarModel = new InfoBarModel(message, hyperlinks, icon, isCloseButtonVisible: true);
+      InfoBarModel infoBarModel = new InfoBarModel(message, actionItems, icon, isCloseButtonVisible: showCloseButton);
 
       IVsInfoBarUIElement uiElement = infoBarFactory.CreateInfoBar(infoBarModel);
-      if (hyperlinks.Count > 0) {
+      if (actionItems.Count > 0) {
         InfoBarEvents events = new InfoBarEvents();
         uiElement.Advise(events, out events.mCookie);
       }
@@ -79,12 +92,12 @@ public static void ShowMessage(ImageMoniker icon, string message, (string, Actio
     public static void ShowMessage(ImageMoniker icon, string message)
     {
       ThreadHelper.ThrowIfNotOnUIThread();
-      ShowMessage(icon, message, null);
+      ShowMessage(icon, message, true, null);
     }
 
 
     /// <summary>
-    /// Helper class containing the callbacks from the hyperlinks in the info bar message.
+    /// Helper class containing the callbacks from the actionItems in the info bar message.
     /// </summary>
     private class InfoBarEvents : IVsInfoBarUIEvents
     {
@@ -93,8 +106,10 @@ public InfoBarEvents() { }
       public void OnActionItemClicked(IVsInfoBarUIElement infoBarUIElement, IVsInfoBarActionItem actionItem)
       {
         ThreadHelper.ThrowIfNotOnUIThread();
-        Action action = (Action)actionItem.ActionContext;
-        action();
+        var callback = (Func<bool>)actionItem.ActionContext;
+        if (callback()) {
+          infoBarUIElement.Close();
+        }
       }
 
       public void OnClosed(IVsInfoBarUIElement infoBarUIElement)

VSDoxyHighlighter/VSDoxyHighlighterPackage.cs

@@ -2,9 +2,10 @@
 using Microsoft.VisualStudio.Shell;
 using Microsoft.VisualStudio.Shell.Interop;
 using System;
+using System.Diagnostics;
+using System.Globalization;
 using System.Runtime.InteropServices;
 using System.Threading;
-using System.Windows.Forms;
 using Task = System.Threading.Tasks.Task;
 
 namespace VSDoxyHighlighter
@@ -70,9 +71,12 @@ public static CommentParser CommentParser {
     protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
     {
       await this.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
+
       mGeneralOptions = (GeneralOptionsPage)GetDialogPage(typeof(GeneralOptionsPage));
       mDoxygenCommands = new DoxygenCommands(mGeneralOptions);
       mCommentParser = new CommentParser(mDoxygenCommands);
+      
+      HandleRateNoticeAfterLoad();
     }
 
     protected override void Dispose(bool disposing)
@@ -84,6 +88,7 @@ protected override void Dispose(bool disposing)
       base.Dispose(disposing);
     }
 
+
     // Loads our package, especially getting the options pages.
     private static void LoadPackage() 
     {
@@ -116,6 +121,103 @@ private static void LoadPackage()
     }
 
 
+    enum RateNoticeAction
+    {
+      None,
+      Initialize,
+      Show,
+    }
+
+
+    private void HandleRateNoticeAfterLoad()
+    {
+      ThreadHelper.ThrowIfNotOnUIThread();
+
+      switch (GetRateNoticeAction()) {
+        case RateNoticeAction.Initialize:
+          // 30 days after the extension got loaded for the first time seems like a reasonable date that gave
+          // users enough time to try out the extension.
+          mGeneralOptions.SaveRateNoticeDate(DateTime.Now.AddDays(30));
+          break;
+        case RateNoticeAction.Show:
+          ShowRateNoticeNow();
+          break;
+      }
+    }
+
+
+    private RateNoticeAction GetRateNoticeAction()
+    {
+      if (string.IsNullOrEmpty(mGeneralOptions.RateNoticeDateStr)) {
+        return RateNoticeAction.Initialize;
+      }
+
+      if (DateTime.TryParseExact(mGeneralOptions.RateNoticeDateStr, "o", CultureInfo.InvariantCulture,
+              DateTimeStyles.RoundtripKind, out DateTime rateNoticeDate)) {
+        if (DateTime.Now >= rateNoticeDate) {
+          return RateNoticeAction.Show;
+        }
+        else {
+          return RateNoticeAction.None;
+        }
+      }
+      else {
+        ActivityLog.LogError("VSDoxyHighlighter", $"Failed to parse RateNoticeDateStr '{mGeneralOptions.RateNoticeDateStr}'. Resetting...");
+        return RateNoticeAction.Initialize;
+      }
+    }
+
+
+    private void ShowRateNoticeNow()
+    {
+      ThreadHelper.ThrowIfNotOnUIThread();
+
+      InfoBar.ShowMessage(
+        icon: KnownMonikers.StatusInformation,
+        message: "You are using the VSDoxyHighlighter extension which provides syntax highlighting, IntelliSense and " +
+          "quick infos for doxygen/javadoc style comments. If you find it useful, please consider giving the " +
+          "project a star on GitHub and leaving a rating on the Visual Studio Marketplace.",
+        showCloseButton: false,
+        actions: new (string uiText, bool asButton, Func<bool /*closeInfoBar*/> callback)[] {
+          (
+            uiText: "Open GitHub page",
+            asButton: false,
+            callback: () => {
+              Process.Start(new ProcessStartInfo("https://github.com/Sedeniono/VSDoxyHighlighter") { UseShellExecute = true });
+              return false;
+            }
+          ),
+          (
+            uiText: "Open Marketplace",
+            asButton: false,
+            callback: () => {
+              Process.Start(new ProcessStartInfo("https://marketplace.visualstudio.com/items?itemName=Sedenion.VSDoxyHighlighter") { UseShellExecute = true });
+              return false;
+            }
+          ),
+          (
+            uiText: "Remind me in 5 days",
+            asButton: true,
+            callback: () => {
+              // We don't choose 7 days and instead some "uneven" number of days and hours to prevent
+              // the notice from appearing again at the same time of day and the same day of the week,
+              // in case it originally interrupted a daily or weekly meeting.
+              mGeneralOptions.SaveRateNoticeDate(DateTime.Now.AddDays(5).AddHours(4));
+              return true;
+            }
+          ),
+          (
+            uiText: "Never show this again",
+            asButton: true,
+            callback: () => { 
+              mGeneralOptions.SaveRateNoticeDate(DateTime.MaxValue);
+              return true;
+            }
+          )
+        });
+    }
+
+
     private const string PackageGuidString = "72c95c0a-4101-4d94-a4e0-5be5e28bdf02";
     private static Guid PackageGuid = new Guid(PackageGuidString);