updates to method summary and correct spell check errors

jjw24 · jjw24 · commit a63c8b036bd4 · 2025-07-07T21:35:12.000+10:00
diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt
@@ -99,3 +99,5 @@ pluginsmanager
 alreadyexists
 Softpedia
 img
+Reloadable
+metadatas
diff --git a/.github/actions/spelling/patterns.txt b/.github/actions/spelling/patterns.txt
@@ -133,3 +133,4 @@
 \bPortuguês (Brasil)\b
 \bčeština\b
 \bPortuguês\b
+\bIoc\b
diff --git a/Flow.Launcher.Core/Plugin/PluginInstaller.cs b/Flow.Launcher.Core/Plugin/PluginInstaller.cs
@@ -13,7 +13,7 @@
 namespace Flow.Launcher.Core.Plugin;
 
 /// <summary>
-/// Helper class for installing, updating, and uninstalling plugins.
+/// Class for installing, updating, and uninstalling plugins.
 /// </summary>
 public static class PluginInstaller
 {
@@ -25,6 +25,11 @@ public static class PluginInstaller
     private static IPublicAPI api = null;
     private static IPublicAPI API => api ??= Ioc.Default.GetRequiredService<IPublicAPI>();
 
+    /// <summary>
+    /// Installs a plugin and restarts the application if required by settings. Prompts user for confirmation and handles download if needed.
+    /// </summary>
+    /// <param name="newPlugin">The plugin to install.</param>
+    /// <returns>A Task representing the asynchronous install operation.</returns>
     public static async Task InstallPluginAndCheckRestartAsync(UserPlugin newPlugin)
     {
         if (API.PluginModified(newPlugin.ID))
@@ -106,6 +111,11 @@ await DownloadFileAsync(
         }
     }
 
+    /// <summary>
+    /// Installs a plugin from a local zip file and restarts the application if required by settings. Validates the zip and prompts user for confirmation.
+    /// </summary>
+    /// <param name="filePath">The path to the plugin zip file.</param>
+    /// <returns>A Task representing the asynchronous install operation.</returns>
     public static async Task InstallPluginAndCheckRestartAsync(string filePath)
     {
         UserPlugin plugin;
@@ -147,6 +157,11 @@ public static async Task InstallPluginAndCheckRestartAsync(string filePath)
         await InstallPluginAndCheckRestartAsync(plugin);
     }
 
+    /// <summary>
+    /// Uninstalls a plugin and restarts the application if required by settings. Prompts user for confirmation and whether to keep plugin settings.
+    /// </summary>
+    /// <param name="oldPlugin">The plugin metadata to uninstall.</param>
+    /// <returns>A Task representing the asynchronous uninstall operation.</returns>
     public static async Task UninstallPluginAndCheckRestartAsync(PluginMetadata oldPlugin)
     {
         if (API.PluginModified(oldPlugin.ID))
@@ -197,6 +212,12 @@ public static async Task UninstallPluginAndCheckRestartAsync(PluginMetadata oldP
         }
     }
 
+    /// <summary>
+    /// Updates a plugin to a new version and restarts the application if required by settings. Prompts user for confirmation and handles download if needed.
+    /// </summary>
+    /// <param name="newPlugin">The new plugin version to install.</param>
+    /// <param name="oldPlugin">The existing plugin metadata to update.</param>
+    /// <returns>A Task representing the asynchronous update operation.</returns>
     public static async Task UpdatePluginAndCheckRestartAsync(UserPlugin newPlugin, PluginMetadata oldPlugin)
     {
         if (API.ShowMsgBox(
@@ -256,15 +277,25 @@ await DownloadFileAsync(
         }
     }
 
-    private static async Task DownloadFileAsync(string prgBoxTitle, string downloadUrl, string filePath, CancellationTokenSource cts, bool deleteFile = true, bool showProgress = true)
+    /// <summary>
+    /// Downloads a file from a URL to a local path, optionally showing a progress box and handling cancellation.
+    /// </summary>
+    /// <param name="progressBoxTitle">The title for the progress box.</param>
+    /// <param name="downloadUrl">The URL to download from.</param>
+    /// <param name="filePath">The local file path to save to.</param>
+    /// <param name="cts">Cancellation token source for cancelling the download.</param>
+    /// <param name="deleteFile">Whether to delete the file if it already exists.</param>
+    /// <param name="showProgress">Whether to show a progress box during download.</param>
+    /// <returns>A Task representing the asynchronous download operation.</returns>
+    private static async Task DownloadFileAsync(string progressBoxTitle, string downloadUrl, string filePath, CancellationTokenSource cts, bool deleteFile = true, bool showProgress = true)
     {
         if (deleteFile && File.Exists(filePath))
             File.Delete(filePath);
 
         if (showProgress)
         {
             var exceptionHappened = false;
-            await API.ShowProgressBoxAsync(prgBoxTitle,
+            await API.ShowProgressBoxAsync(progressBoxTitle,
                 async (reportProgress) =>
                 {
                     if (reportProgress == null)
@@ -291,6 +322,11 @@ await API.ShowProgressBoxAsync(prgBoxTitle,
         }
     }
 
+    /// <summary>
+    /// Determines if the plugin install source is a known/approved source (e.g., GitHub and matches an existing plugin author).
+    /// </summary>
+    /// <param name="url">The URL to check.</param>
+    /// <returns>True if the source is known, otherwise false.</returns>
     private static bool InstallSourceKnown(string url)
     {
         if (string.IsNullOrEmpty(url))
diff --git a/Flow.Launcher.Core/Plugin/PluginManager.cs b/Flow.Launcher.Core/Plugin/PluginManager.cs
@@ -18,7 +18,7 @@
 namespace Flow.Launcher.Core.Plugin
 {
     /// <summary>
-    /// The entry for managing Flow Launcher plugins
+    /// Class for co-ordinating and managing all plugin lifecycle.
     /// </summary>
     public static class PluginManager
     {
diff --git a/Flow.Launcher/ProgressBoxEx.xaml.cs b/Flow.Launcher/ProgressBoxEx.xaml.cs
@@ -19,32 +19,32 @@ private ProgressBoxEx(Action cancelProgress)
 
         public static async Task ShowAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action cancelProgress = null)
         {
-            ProgressBoxEx prgBox = null;
+            ProgressBoxEx progressBox = null;
             try
             {
                 if (!Application.Current.Dispatcher.CheckAccess())
                 {
                     await Application.Current.Dispatcher.InvokeAsync(() =>
                     {
-                        prgBox = new ProgressBoxEx(cancelProgress)
+                        progressBox = new ProgressBoxEx(cancelProgress)
                         {
                             Title = caption
                         };
-                        prgBox.TitleTextBlock.Text = caption;
-                        prgBox.Show();
+                        progressBox.TitleTextBlock.Text = caption;
+                        progressBox.Show();
                     });
                 }
                 else
                 {
-                    prgBox = new ProgressBoxEx(cancelProgress)
+                    progressBox = new ProgressBoxEx(cancelProgress)
                     {
                         Title = caption
                     };
-                    prgBox.TitleTextBlock.Text = caption;
-                    prgBox.Show();
+                    progressBox.TitleTextBlock.Text = caption;
+                    progressBox.Show();
                 }
 
-                await reportProgressAsync(prgBox.ReportProgress).ConfigureAwait(false);
+                await reportProgressAsync(progressBox.ReportProgress).ConfigureAwait(false);
             }
             catch (Exception e)
             {
@@ -58,12 +58,12 @@ await Application.Current.Dispatcher.InvokeAsync(() =>
                 {
                     await Application.Current.Dispatcher.InvokeAsync(() =>
                     {
-                        prgBox?.Close();
+                        progressBox?.Close();
                     });
                 }
                 else
                 {
-                    prgBox?.Close();
+                    progressBox?.Close();
                 }
             }
         }
diff --git a/Plugins/Flow.Launcher.Plugin.PluginsManager/PluginsManager.cs b/Plugins/Flow.Launcher.Plugin.PluginsManager/PluginsManager.cs
@@ -205,15 +205,15 @@ await DownloadFileAsync(
             }
         }
 
-        private async Task DownloadFileAsync(string prgBoxTitle, string downloadUrl, string filePath, CancellationTokenSource cts, bool deleteFile = true, bool showProgress = true)
+        private async Task DownloadFileAsync(string progressBoxTitle, string downloadUrl, string filePath, CancellationTokenSource cts, bool deleteFile = true, bool showProgress = true)
         {
             if (deleteFile && File.Exists(filePath))
                 File.Delete(filePath);
 
             if (showProgress)
             {
                 var exceptionHappened = false;
-                await Context.API.ShowProgressBoxAsync(prgBoxTitle,
+                await Context.API.ShowProgressBoxAsync(progressBoxTitle,
                     async (reportProgress) =>
                     {
                         if (reportProgress == null)

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`namespace Flow.Launcher.Core.Plugin;`
`14`	`14`
`15`	`15`	`/// <summary>`
`16`		`-/// Helper class for installing, updating, and uninstalling plugins.`
	`16`	`+/// Class for installing, updating, and uninstalling plugins.`
`17`	`17`	`/// </summary>`
`18`	`18`	`public static class PluginInstaller`
`19`	`19`	`{`
`@@ -25,6 +25,11 @@ public static class PluginInstaller`
`25`	`25`	`private static IPublicAPI api = null;`
`26`	`26`	`private static IPublicAPI API => api ??= Ioc.Default.GetRequiredService<IPublicAPI>();`
`27`	`27`
	`28`	`+ /// <summary>`
	`29`	`+ /// Installs a plugin and restarts the application if required by settings. Prompts user for confirmation and handles download if needed.`
	`30`	`+ /// </summary>`
	`31`	`+ /// <param name="newPlugin">The plugin to install.</param>`
	`32`	`+ /// <returns>A Task representing the asynchronous install operation.</returns>`
`28`	`33`	`public static async Task InstallPluginAndCheckRestartAsync(UserPlugin newPlugin)`
`29`	`34`	`{`
`30`	`35`	`if (API.PluginModified(newPlugin.ID))`
`@@ -106,6 +111,11 @@ await DownloadFileAsync(`
`106`	`111`	`}`
`107`	`112`	`}`
`108`	`113`
	`114`	`+ /// <summary>`
	`115`	`+ /// Installs a plugin from a local zip file and restarts the application if required by settings. Validates the zip and prompts user for confirmation.`
	`116`	`+ /// </summary>`
	`117`	`+ /// <param name="filePath">The path to the plugin zip file.</param>`
	`118`	`+ /// <returns>A Task representing the asynchronous install operation.</returns>`
`109`	`119`	`public static async Task InstallPluginAndCheckRestartAsync(string filePath)`
`110`	`120`	`{`
`111`	`121`	`UserPlugin plugin;`
`@@ -147,6 +157,11 @@ public static async Task InstallPluginAndCheckRestartAsync(string filePath)`
`147`	`157`	`await InstallPluginAndCheckRestartAsync(plugin);`
`148`	`158`	`}`
`149`	`159`
	`160`	`+ /// <summary>`
	`161`	`+ /// Uninstalls a plugin and restarts the application if required by settings. Prompts user for confirmation and whether to keep plugin settings.`
	`162`	`+ /// </summary>`
	`163`	`+ /// <param name="oldPlugin">The plugin metadata to uninstall.</param>`
	`164`	`+ /// <returns>A Task representing the asynchronous uninstall operation.</returns>`
`150`	`165`	`public static async Task UninstallPluginAndCheckRestartAsync(PluginMetadata oldPlugin)`
`151`	`166`	`{`
`152`	`167`	`if (API.PluginModified(oldPlugin.ID))`
`@@ -197,6 +212,12 @@ public static async Task UninstallPluginAndCheckRestartAsync(PluginMetadata oldP`
`197`	`212`	`}`
`198`	`213`	`}`
`199`	`214`
	`215`	`+ /// <summary>`
	`216`	`+ /// Updates a plugin to a new version and restarts the application if required by settings. Prompts user for confirmation and handles download if needed.`
	`217`	`+ /// </summary>`
	`218`	`+ /// <param name="newPlugin">The new plugin version to install.</param>`
	`219`	`+ /// <param name="oldPlugin">The existing plugin metadata to update.</param>`
	`220`	`+ /// <returns>A Task representing the asynchronous update operation.</returns>`
`200`	`221`	`public static async Task UpdatePluginAndCheckRestartAsync(UserPlugin newPlugin, PluginMetadata oldPlugin)`
`201`	`222`	`{`
`202`	`223`	`if (API.ShowMsgBox(`
`@@ -256,15 +277,25 @@ await DownloadFileAsync(`
`256`	`277`	`}`
`257`	`278`	`}`
`258`	`279`
`259`		`- private static async Task DownloadFileAsync(string prgBoxTitle, string downloadUrl, string filePath, CancellationTokenSource cts, bool deleteFile = true, bool showProgress = true)`
	`280`	`+ /// <summary>`
	`281`	`+ /// Downloads a file from a URL to a local path, optionally showing a progress box and handling cancellation.`
	`282`	`+ /// </summary>`
	`283`	`+ /// <param name="progressBoxTitle">The title for the progress box.</param>`
	`284`	`+ /// <param name="downloadUrl">The URL to download from.</param>`
	`285`	`+ /// <param name="filePath">The local file path to save to.</param>`
	`286`	`+ /// <param name="cts">Cancellation token source for cancelling the download.</param>`
	`287`	`+ /// <param name="deleteFile">Whether to delete the file if it already exists.</param>`
	`288`	`+ /// <param name="showProgress">Whether to show a progress box during download.</param>`
	`289`	`+ /// <returns>A Task representing the asynchronous download operation.</returns>`
	`290`	`+ private static async Task DownloadFileAsync(string progressBoxTitle, string downloadUrl, string filePath, CancellationTokenSource cts, bool deleteFile = true, bool showProgress = true)`
`260`	`291`	`{`
`261`	`292`	`if (deleteFile && File.Exists(filePath))`
`262`	`293`	`File.Delete(filePath);`
`263`	`294`
`264`	`295`	`if (showProgress)`
`265`	`296`	`{`
`266`	`297`	`var exceptionHappened = false;`
`267`		`- await API.ShowProgressBoxAsync(prgBoxTitle,`
	`298`	`+ await API.ShowProgressBoxAsync(progressBoxTitle,`
`268`	`299`	`async (reportProgress) =>`
`269`	`300`	`{`
`270`	`301`	`if (reportProgress == null)`
`@@ -291,6 +322,11 @@ await API.ShowProgressBoxAsync(prgBoxTitle,`
`291`	`322`	`}`
`292`	`323`	`}`
`293`	`324`
	`325`	`+ /// <summary>`
	`326`	`+ /// Determines if the plugin install source is a known/approved source (e.g., GitHub and matches an existing plugin author).`
	`327`	`+ /// </summary>`
	`328`	`+ /// <param name="url">The URL to check.</param>`
	`329`	`+ /// <returns>True if the source is known, otherwise false.</returns>`
`294`	`330`	`private static bool InstallSourceKnown(string url)`
`295`	`331`	`{`
`296`	`332`	`if (string.IsNullOrEmpty(url))`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`namespace Flow.Launcher.Core.Plugin`
`19`	`19`	`{`
`20`	`20`	`/// <summary>`
`21`		`- /// The entry for managing Flow Launcher plugins`
	`21`	`+ /// Class for co-ordinating and managing all plugin lifecycle.`
`22`	`22`	`/// </summary>`
`23`	`23`	`public static class PluginManager`
`24`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,32 +19,32 @@ private ProgressBoxEx(Action cancelProgress)`
`19`	`19`
`20`	`20`	`public static async Task ShowAsync(string caption, Func<Action<double>, Task> reportProgressAsync, Action cancelProgress = null)`
`21`	`21`	`{`
`22`		`- ProgressBoxEx prgBox = null;`
	`22`	`+ ProgressBoxEx progressBox = null;`
`23`	`23`	`try`
`24`	`24`	`{`
`25`	`25`	`if (!Application.Current.Dispatcher.CheckAccess())`
`26`	`26`	`{`
`27`	`27`	`await Application.Current.Dispatcher.InvokeAsync(() =>`
`28`	`28`	`{`
`29`		`- prgBox = new ProgressBoxEx(cancelProgress)`
	`29`	`+ progressBox = new ProgressBoxEx(cancelProgress)`
`30`	`30`	`{`
`31`	`31`	`Title = caption`
`32`	`32`	`};`
`33`		`- prgBox.TitleTextBlock.Text = caption;`
`34`		`- prgBox.Show();`
	`33`	`+ progressBox.TitleTextBlock.Text = caption;`
	`34`	`+ progressBox.Show();`
`35`	`35`	`});`
`36`	`36`	`}`
`37`	`37`	`else`
`38`	`38`	`{`
`39`		`- prgBox = new ProgressBoxEx(cancelProgress)`
	`39`	`+ progressBox = new ProgressBoxEx(cancelProgress)`
`40`	`40`	`{`
`41`	`41`	`Title = caption`
`42`	`42`	`};`
`43`		`- prgBox.TitleTextBlock.Text = caption;`
`44`		`- prgBox.Show();`
	`43`	`+ progressBox.TitleTextBlock.Text = caption;`
	`44`	`+ progressBox.Show();`
`45`	`45`	`}`
`46`	`46`
`47`		`- await reportProgressAsync(prgBox.ReportProgress).ConfigureAwait(false);`
	`47`	`+ await reportProgressAsync(progressBox.ReportProgress).ConfigureAwait(false);`
`48`	`48`	`}`
`49`	`49`	`catch (Exception e)`
`50`	`50`	`{`
`@@ -58,12 +58,12 @@ await Application.Current.Dispatcher.InvokeAsync(() =>`
`58`	`58`	`{`
`59`	`59`	`await Application.Current.Dispatcher.InvokeAsync(() =>`
`60`	`60`	`{`
`61`		`- prgBox?.Close();`
	`61`	`+ progressBox?.Close();`
`62`	`62`	`});`
`63`	`63`	`}`
`64`	`64`	`else`
`65`	`65`	`{`
`66`		`- prgBox?.Close();`
	`66`	`+ progressBox?.Close();`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -205,15 +205,15 @@ await DownloadFileAsync(`
`205`	`205`	`}`
`206`	`206`	`}`
`207`	`207`
`208`		`- private async Task DownloadFileAsync(string prgBoxTitle, string downloadUrl, string filePath, CancellationTokenSource cts, bool deleteFile = true, bool showProgress = true)`
	`208`	`+ private async Task DownloadFileAsync(string progressBoxTitle, string downloadUrl, string filePath, CancellationTokenSource cts, bool deleteFile = true, bool showProgress = true)`
`209`	`209`	`{`
`210`	`210`	`if (deleteFile && File.Exists(filePath))`
`211`	`211`	`File.Delete(filePath);`
`212`	`212`
`213`	`213`	`if (showProgress)`
`214`	`214`	`{`
`215`	`215`	`var exceptionHappened = false;`
`216`		`- await Context.API.ShowProgressBoxAsync(prgBoxTitle,`
	`216`	`+ await Context.API.ShowProgressBoxAsync(progressBoxTitle,`
`217`	`217`	`async (reportProgress) =>`
`218`	`218`	`{`
`219`	`219`	`if (reportProgress == null)`