Create an IExtensionHost class, to enable logging (#137)

Allow extensions to send status messages to the host app. As an example, you can now: ```cs ExtensionHost.LogMessage(new LogMessage() { Message = "This is a test, from the HackerNews sample" }); ``` And have that appear in the host apps debug console. Closes #134 Closes #118 Should also make resolving #87 and #135 easier. We don't have the design of these status messages totally planned out yet. But this should at least make it possible. For those in the back, **this does not actually display these messages anywhere in the host UX currently**. ----- Other information that's currently included: * The host app's HWND. Way too many times does the Windows API need an HWND, which extensions won't have, but the host app does. * The `LanguageOverride`. This is in case we ever want to support `PrimaryLanguageOverride` in the host app.
zadjii-msft · Nov 5, 2024 · c319a74 · c319a74
1 parent 6ee3ad6
commit c319a74
Show file tree

Hide file tree

Showing 30 changed files with 430 additions and 226 deletions.
diff --git a/src/modules/cmdpal/Exts/EverythingExtension/EverythingExtensionCommandsProvider.cs b/src/modules/cmdpal/Exts/EverythingExtension/EverythingExtensionCommandsProvider.cs
@@ -12,11 +12,12 @@
 
 namespace EverythingExtension;
 
-public partial class EverythingExtensionActionsProvider : ICommandProvider
+public partial class EverythingExtensionActionsProvider : CommandProvider
 {
-    public string DisplayName => $"Everything extension for cmdpal";
-
-    public IconDataType Icon => new(string.Empty);
+    public EverythingExtensionActionsProvider()
+    {
+        DisplayName = "Everything extension for cmdpal";
+    }
 
     private readonly IListItem[] _commands = [
         new ListItem(new EverythingExtensionPage())
@@ -26,11 +27,7 @@ public partial class EverythingExtensionActionsProvider : ICommandProvider
         },
     ];
 
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return _commands;
     }

diff --git a/src/modules/cmdpal/Exts/EverythingExtension/Pages/EverythingExtensionPage.cs b/src/modules/cmdpal/Exts/EverythingExtension/Pages/EverythingExtensionPage.cs
@@ -30,7 +30,7 @@ public EverythingExtensionPage()
         Everything_SetMax(20);
     }
 
-    public override ISection[] GetItems(string query)
+    public override IListItem[] GetItems(string query)
     {
         Everything_SetSearchW(query);
 
@@ -60,19 +60,11 @@ public override ISection[] GetItems(string query)
                 items.Add(new ListItem(new NoOpCommand() { Name = "(Are you sure Everything is running?)" }));
             }
 
-            return [
-                new ListSection()
-                {
-                    Items = items.ToArray(),
-                }
-            ];
+            return items.ToArray();
         }
 
         var resultCount = Everything_GetNumResults();
 
-        // Create a new ListSections
-        var section = new ListSection();
-
         // Create a List to store ListItems
         var itemList = new List<ListItem>();
 
@@ -101,9 +93,6 @@ public override ISection[] GetItems(string query)
         }
 
         // Convert the List to an array and assign it to the Items property
-        section.Items = itemList.ToArray();
-
-        // Return the ListSection with the items
-        return [section];
+        return itemList.ToArray();
     }
 }
diff --git a/src/modules/cmdpal/Exts/HackerNewsExtension/HackerNewsCommandsProvider.cs b/src/modules/cmdpal/Exts/HackerNewsExtension/HackerNewsCommandsProvider.cs
@@ -8,21 +8,18 @@
 
 namespace HackerNewsExtension;
 
-public partial class HackerNewsCommandsProvider : ICommandProvider
+public partial class HackerNewsCommandsProvider : CommandProvider
 {
-    public string DisplayName => $"Hacker News Commands";
-
-    public IconDataType Icon => new(string.Empty);
+    public HackerNewsCommandsProvider()
+    {
+        DisplayName = "Hacker News Commands";
+    }
 
     private readonly IListItem[] _actions = [
         new ListItem(new HackerNewsPage()),
     ];
 
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return _actions;
     }

diff --git a/src/modules/cmdpal/Exts/HackerNewsExtension/Properties/launchSettings.json b/src/modules/cmdpal/Exts/HackerNewsExtension/Properties/launchSettings.json
@@ -1,10 +1,11 @@
 {
   "profiles": {
     "HackerNewsExtension (Package)": {
-      "commandName": "MsixPackage"
+      "commandName": "MsixPackage",
+      "doNotLaunchApp": true
     },
     "HackerNewsExtension (Unpackaged)": {
       "commandName": "Project"
     }
   }
-}
+}
diff --git a/src/modules/cmdpal/Exts/MastodonExtension/MastodonExtensionPage.cs b/src/modules/cmdpal/Exts/MastodonExtension/MastodonExtensionPage.cs
@@ -91,21 +91,18 @@ public async Task<List<MastodonStatus>> FetchExplorePage()
 }
 
 [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "This is sample code")]
-public partial class MastodonExtensionActionsProvider : ICommandProvider
+public partial class MastodonExtensionActionsProvider : CommandProvider
 {
-    public string DisplayName => $"Mastodon extension for cmdpal Commands";
-
-    public IconDataType Icon => new(string.Empty);
+    public MastodonExtensionActionsProvider()
+    {
+        DisplayName = "Mastodon extension for cmdpal Commands";
+    }
 
     private readonly IListItem[] _actions = [
         new ListItem(new MastodonExtensionPage()) { Subtitle = "Explore top posts on mastodon.social" },
     ];
 
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return _actions;
     }

diff --git a/src/modules/cmdpal/Exts/MediaControlsExtension/MediaActionsProvider.cs b/src/modules/cmdpal/Exts/MediaControlsExtension/MediaActionsProvider.cs
@@ -4,24 +4,22 @@
 
 using System;
 using Microsoft.CmdPal.Extensions;
+using Microsoft.CmdPal.Extensions.Helpers;
 
 namespace MediaControlsExtension;
 
-public partial class MediaActionsProvider : ICommandProvider
+public partial class MediaActionsProvider : CommandProvider
 {
-    public string DisplayName => $"Media controls actions";
-
-    public IconDataType Icon => new(string.Empty);
+    public MediaActionsProvider()
+    {
+        DisplayName = "Media controls actions";
+    }
 
     private readonly IListItem[] _actions = [
         new MediaListItem()
     ];
 
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return _actions;
     }

diff --git a/src/modules/cmdpal/Exts/Microsoft.CmdPal.Ext.Bookmark/BookmarksCommandProvider.cs b/src/modules/cmdpal/Exts/Microsoft.CmdPal.Ext.Bookmark/BookmarksCommandProvider.cs
@@ -11,17 +11,15 @@
 
 namespace Microsoft.CmdPal.Ext.Bookmarks;
 
-public partial class BookmarksCommandProvider : ICommandProvider
+public partial class BookmarksCommandProvider : CommandProvider
 {
-    public string DisplayName => $"Bookmarks";
-
-    public IconDataType Icon => new(string.Empty);
-
     private readonly List<ICommand> _commands = [];
     private readonly AddBookmarkPage _addNewCommand = new();
 
     public BookmarksCommandProvider()
     {
+        DisplayName = "Bookmarks";
+
         _addNewCommand.AddedAction += AddNewCommand_AddedAction;
     }
 
@@ -31,10 +29,6 @@ private void AddNewCommand_AddedAction(object sender, object? args)
         _commands.Clear();
     }
 
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
     private void LoadCommands()
     {
         List<ICommand> collected = [];
@@ -84,7 +78,7 @@ private void LoadCommands()
         _commands.AddRange(collected);
     }
 
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         if (_commands.Count == 0)
         {

diff --git a/src/modules/cmdpal/Exts/Microsoft.CmdPal.Ext.Calc/CalculatorCommandProvider.cs b/src/modules/cmdpal/Exts/Microsoft.CmdPal.Ext.Calc/CalculatorCommandProvider.cs
@@ -4,26 +4,20 @@
 
 using System;
 using Microsoft.CmdPal.Extensions;
+using Microsoft.CmdPal.Extensions.Helpers;
 
 namespace Microsoft.CmdPal.Ext.Calc;
 
-public partial class CalculatorCommandProvider : ICommandProvider
+public partial class CalculatorCommandProvider : CommandProvider
 {
-    public string DisplayName => $"Calculator";
-
     private readonly CalculatorTopLevelListItem calculatorCommand = new();
 
     public CalculatorCommandProvider()
     {
+        DisplayName = "Calculator";
     }
 
-    public IconDataType Icon => new(string.Empty);
-
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return [calculatorCommand];
     }

diff --git a/src/modules/cmdpal/Exts/Microsoft.CmdPal.Ext.CmdPalSettings/SettingsCommandProvider.cs b/src/modules/cmdpal/Exts/Microsoft.CmdPal.Ext.CmdPalSettings/SettingsCommandProvider.cs
@@ -8,23 +8,16 @@
 
 namespace Microsoft.CmdPal.Ext.Settings;
 
-public partial class SettingsCommandProvider : ICommandProvider
+public partial class SettingsCommandProvider : CommandProvider
 {
-    public string DisplayName => $"Settings";
-
     private readonly SettingsPage settingsPage = new();
 
     public SettingsCommandProvider()
     {
+        DisplayName = $"Settings";
     }
 
-    public IconDataType Icon => new(string.Empty);
-
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return [new ListItem(settingsPage) { Subtitle = "CmdPal settings" }];
     }

diff --git a/src/modules/cmdpal/Exts/Microsoft.CmdPal.Ext.Registry/RegistryCommandsProvider.cs b/src/modules/cmdpal/Exts/Microsoft.CmdPal.Ext.Registry/RegistryCommandsProvider.cs
@@ -8,21 +8,14 @@
 
 namespace Microsoft.CmdPal.Ext.Registry;
 
-public partial class RegistryCommandsProvider : ICommandProvider
+public partial class RegistryCommandsProvider : CommandProvider
 {
-    public string DisplayName => $"Windows Services";
-
     public RegistryCommandsProvider()
     {
+        DisplayName = $"Windows Registry";
     }
 
-    public IconDataType Icon => new(string.Empty);
-
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return [
             new ListItem(new RegistryListPage())

diff --git a/...dules/cmdpal/Exts/Microsoft.CmdPal.Ext.WindowsServices/WindowsServicesCommandsProvider.cs b/...dules/cmdpal/Exts/Microsoft.CmdPal.Ext.WindowsServices/WindowsServicesCommandsProvider.cs
@@ -8,21 +8,14 @@
 
 namespace Microsoft.CmdPal.Ext.WindowsServices;
 
-public partial class WindowsServicesCommandsProvider : ICommandProvider
+public partial class WindowsServicesCommandsProvider : CommandProvider
 {
-    public string DisplayName => $"Windows Services";
-
     public WindowsServicesCommandsProvider()
     {
+        DisplayName = $"Windows Services";
     }
 
-    public IconDataType Icon => new(string.Empty);
-
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return [
             new ListItem(new ServicesListPage())

diff --git a/...dules/cmdpal/Exts/Microsoft.CmdPal.Ext.WindowsSettings/WindowsSettingsCommandsProvider.cs b/...dules/cmdpal/Exts/Microsoft.CmdPal.Ext.WindowsSettings/WindowsSettingsCommandsProvider.cs
@@ -10,10 +10,8 @@
 
 namespace Microsoft.CmdPal.Ext.WindowsSettings;
 
-public partial class WindowsSettingsCommandsProvider : ICommandProvider
+public partial class WindowsSettingsCommandsProvider : CommandProvider
 {
-    public string DisplayName => $"Windows Services";
-
     private readonly ListItem _searchSettingsListItem;
 
 #pragma warning disable CS8632 // The annotation for nullable reference types should only be used in code within a '#nullable' annotations context.
@@ -22,6 +20,8 @@ public partial class WindowsSettingsCommandsProvider : ICommandProvider
 
     public WindowsSettingsCommandsProvider()
     {
+        DisplayName = $"Windows Services";
+
         _windowsSettings = JsonSettingsListHelper.ReadAllPossibleSettings();
         _searchSettingsListItem = new ListItem(new WindowsSettingsListPage(_windowsSettings))
         {
@@ -35,13 +35,7 @@ public WindowsSettingsCommandsProvider()
         WindowsSettingsPathHelper.GenerateSettingsPathValues(_windowsSettings);
     }
 
-    public IconDataType Icon => new(string.Empty);
-
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return [
             _searchSettingsListItem

diff --git a/...dules/cmdpal/Exts/Microsoft.CmdPal.Ext.WindowsTerminal/WindowsTerminalCommandsProvider.cs b/...dules/cmdpal/Exts/Microsoft.CmdPal.Ext.WindowsTerminal/WindowsTerminalCommandsProvider.cs
@@ -4,26 +4,20 @@
 
 using System;
 using Microsoft.CmdPal.Extensions;
+using Microsoft.CmdPal.Extensions.Helpers;
 
 namespace Microsoft.CmdPal.Ext.WindowsTerminal;
 
-public partial class WindowsTerminalCommandsProvider : ICommandProvider
+public partial class WindowsTerminalCommandsProvider : CommandProvider
 {
-    public string DisplayName => $"Windows Terminal";
-
     private readonly TerminalTopLevelListItem terminalCommand = new();
 
     public WindowsTerminalCommandsProvider()
     {
+        DisplayName = $"Windows Terminal";
     }
 
-    public IconDataType Icon => new(string.Empty);
-
-#pragma warning disable CA1816 // Dispose methods should call SuppressFinalize
-    public void Dispose() => throw new NotImplementedException();
-#pragma warning restore CA1816 // Dispose methods should call SuppressFinalize
-
-    public IListItem[] TopLevelCommands()
+    public override IListItem[] TopLevelCommands()
     {
         return [terminalCommand];
     }