A Swiss Army knife for developers.
C# blazorcross-platformcsharpdesktopdesktop-appdesktop-applicationdeveloper-toolsextensiblefluentfluent-designlinuxmacosmicasyntax-highlightingtypescriptwindowswindows-10windows-11winui
Support for third party extension (#1081)
Etienne Baudoux3d659ed0e00d
diff --git a/src/app/dev/DevToys.Api/DevToys.Api.csproj b/src/app/dev/DevToys.Api/DevToys.Api.csprojindex 1f0b7fb95..a07194013 100644--- a/src/app/dev/DevToys.Api/DevToys.Api.csproj+++ b/src/app/dev/DevToys.Api/DevToys.Api.csproj@@ -1,4 +1,4 @@-<Project Sdk="Microsoft.NET.Sdk">+<Project Sdk="Microsoft.NET.Sdk"><PropertyGroup><TargetFrameworks>$(NetCore)</TargetFrameworks><GenerateDocumentationFile>true</GenerateDocumentationFile>@@ -11,9 +11,12 @@<Authors>veler,btiteux</Authors><Description>SDK for developing extensions for DevToys 2.0 and higher</Description><PackageProjectUrl>https://devtoys.app</PackageProjectUrl>- <RepositoryUrl>https://github.com/veler/DevToys</RepositoryUrl>- <PackageTags>devtoys</PackageTags>+ <RepositoryUrl>https://github.com/DevToys-app/DevToys</RepositoryUrl>+ <PackageTags>devtoys-app</PackageTags><PackageLicenseFile>LICENSE.md</PackageLicenseFile>+ <PackageReadmeFile>README.md</PackageReadmeFile>+ <DevelopmentDependency>true</DevelopmentDependency>+ <PackageIcon>Icon-Windows-Linux.png</PackageIcon></PropertyGroup><ItemGroup>@@ -23,15 +26,14 @@<PackageReference Include="OneOf" /><PackageReference Include="System.ComponentModel.Composition" /><PackageReference Include="System.Threading.Tasks.Extensions" />- <PackageReference Include="SixLabors.ImageSharp"/>+ <PackageReference Include="SixLabors.ImageSharp" /></ItemGroup><ItemGroup><None Include="$(AssemblyName).props" Pack="true" PackagePath="build" />- <None Include="$(RepoRoot)LICENSE.md" Link="LICENSE.md">- <Pack>True</Pack>- <PackagePath>\</PackagePath>- </None>+ <None Include="README.md" Pack="true" PackagePath="\" />+ <None Include="$(RepoRoot)LICENSE.md" Link="LICENSE.md" Pack="true" PackagePath="\" />+ <None Include="$(RepoRoot)assets\logo\Icon-Windows-Linux.png" Link="Icon-Windows-Linux.png" Pack="true" PackagePath="" /></ItemGroup><ItemGroup>diff --git a/src/app/dev/DevToys.Api/DevToys.Api.props b/src/app/dev/DevToys.Api/DevToys.Api.propsindex 93b5a4955..4dbd99e69 100644--- a/src/app/dev/DevToys.Api/DevToys.Api.props+++ b/src/app/dev/DevToys.Api/DevToys.Api.props@@ -1,4 +1,9 @@<Project>+ <PropertyGroup><!-- See https://learn.microsoft.com/en-us/dotnet/core/project-sdk/msbuild-props#enabledynamicloading --><EnableDynamicLoading>true</EnableDynamicLoading>++ <!-- Make any NuGet using DevToys.API to have the tag "devtoys-app" so we can find every published extensions on Nuget.org through this tag. -->+ <PackageTags>devtoys-app $(PackageTags)</PackageTags>+ </PropertyGroup></Project>\ No newline at end of filediff --git a/src/app/dev/DevToys.Api/README.md b/src/app/dev/DevToys.Api/README.mdnew file mode 100644index 000000000..882b51d55--- /dev/null+++ b/src/app/dev/DevToys.Api/README.md@@ -0,0 +1 @@+Build an extension for [DevToys](https://devtoys.app).\ No newline at end of filediff --git a/src/app/dev/DevToys.Blazor/Pages/Index.razor b/src/app/dev/DevToys.Blazor/Pages/Index.razorindex 22e565292..92762b000 100644--- a/src/app/dev/DevToys.Blazor/Pages/Index.razor+++ b/src/app/dev/DevToys.Blazor/Pages/Index.razor@@ -118,7 +118,7 @@<FontIcon FontFamily="@item.ToolInstance.IconFontName" Glyph="@item.ToolInstance.IconGlyph" /></div><div class="sidebar-searchbar-result-item-text">- <TextBlock NoWrap="true" Text="@item.ToolInstance.LongDisplayTitle" HighlightedSpans="@item.MatchedSpans" />+ <TextBlock NoWrap="true" Text="@item.ToolInstance.LongOrShortDisplayTitle" HighlightedSpans="@item.MatchedSpans" /></div></div></SearchResultItemTemplate>diff --git a/src/app/dev/DevToys.Blazor/Pages/SubPages/ToolPage.razor b/src/app/dev/DevToys.Blazor/Pages/SubPages/ToolPage.razorindex 45a592534..0983566d1 100644--- a/src/app/dev/DevToys.Blazor/Pages/SubPages/ToolPage.razor+++ b/src/app/dev/DevToys.Blazor/Pages/SubPages/ToolPage.razor@@ -4,7 +4,7 @@<ScrollViewer @ref=_scrollViewerClass="entrance-theme-transition tool-page-content"- IsScrollable="@(!IsInFullScreenMode && ViewModel.ToolView.IsScrollable)">+ IsScrollable="@(!IsInFullScreenMode && ViewModel.ToolView is not null && ViewModel.ToolView.IsScrollable)">@RenderToolWithHeader(true)</ScrollViewer>@@ -15,7 +15,7 @@{UIDialogService.DialogContent = (__builder) =>{- @if (ViewModel.ToolView.CurrentOpenedDialog is not null)+ @if (ViewModel.ToolView?.CurrentOpenedDialog is not null){<UIElementPresenter UIElement="@ViewModel.ToolView.CurrentOpenedDialog.DialogContent" />}@@ -23,7 +23,7 @@UIDialogService.FooterContent = (__builder) =>{- @if (ViewModel.ToolView.CurrentOpenedDialog is not null)+ @if (ViewModel.ToolView?.CurrentOpenedDialog is not null){<UIElementPresenter UIElement="@ViewModel.ToolView.CurrentOpenedDialog.FooterContent" />}@@ -62,6 +62,12 @@<TextBlock Text="@ViewModel.GetFavoriteButtonText(ViewModel.IsSelectedMenuItemAFavoriteTool)" /></StackPanel></Button>+ <Button IsVisible="@Debugger.IsAttached"+ Appearance="ButtonAppearance.Stealth"+ ToolTip="Hot reload"+ @onclick="@OnHotReloadButtonClick">+ <FontIcon Glyph="@('\uEF68')" Style="color: red;" />+ </Button></StackPanel></GridCell>diff --git a/src/app/dev/DevToys.Blazor/Pages/SubPages/ToolPage.razor.cs b/src/app/dev/DevToys.Blazor/Pages/SubPages/ToolPage.razor.csindex 986171af1..0a9927bfe 100644--- a/src/app/dev/DevToys.Blazor/Pages/SubPages/ToolPage.razor.cs+++ b/src/app/dev/DevToys.Blazor/Pages/SubPages/ToolPage.razor.cs@@ -90,6 +90,7 @@ public partial class ToolPage : MefComponentBase, IFocusableprivate void ToolView_CurrentOpenedDialogChanged(object? sender, EventArgs e){+ Guard.IsNotNull(ViewModel.ToolView);if (ViewModel.ToolView.CurrentOpenedDialog is null){UIDialogService.CloseDialog();@@ -103,6 +104,7 @@ public partial class ToolPage : MefComponentBase, IFocusableprivate void DialogService_CloseDialogRequested(object? sender, EventArgs e){+ Guard.IsNotNull(ViewModel.ToolView);if (ViewModel.ToolView.CurrentOpenedDialog is not null){ViewModel.ToolView.CurrentOpenedDialog.IsOpenedChanged -= DialogService_CloseDialogRequested;@@ -128,4 +130,9 @@ public partial class ToolPage : MefComponentBase, IFocusable{ViewModel.RebuildViewCommand.Execute(null);}++ private void OnHotReloadButtonClick()+ {+ ViewModel.RebuildViewCommand.Execute(null);+ }}diff --git a/src/app/dev/DevToys.Business/Services/CommandLineLauncherService.cs b/src/app/dev/DevToys.Business/Services/CommandLineLauncherService.csindex 3f6f1ab77..b6cedab8a 100644--- a/src/app/dev/DevToys.Business/Services/CommandLineLauncherService.cs+++ b/src/app/dev/DevToys.Business/Services/CommandLineLauncherService.cs@@ -11,7 +11,7 @@ namespace DevToys.Business.Services;[Export]internal sealed class CommandLineLauncherService : ObservableRecipient{- internal const string ToolArgument = "--tool:";+ internal const string ToolArgument = "tool";private readonly GuiToolProvider _guiToolProvider;private readonly IMefProvider _mefProvider;@@ -25,9 +25,9 @@ internal sealed class CommandLineLauncherService : ObservableRecipientinternal void HandleCommandLineArguments(){- if (Environment.CommandLine.Contains(ToolArgument))+ string toolName = AppHelper.GetCommandLineArgument(ToolArgument);+ if (!string.IsNullOrEmpty(toolName)){- string toolName = Environment.CommandLine.Substring(Environment.CommandLine.IndexOf(ToolArgument) + ToolArgument.Length);GuiToolInstance? tool = _guiToolProvider.GetToolFromInternalName(toolName);if (tool is not null){@@ -44,7 +44,7 @@ internal sealed class CommandLineLauncherService : ObservableRecipientif (tool is not null){string appStartExe = Process.GetCurrentProcess().MainModule!.FileName;- OSHelper.OpenFileInShell(appStartExe, $"{ToolArgument}{toolInternalName}");+ OSHelper.OpenFileInShell(appStartExe, $"--{ToolArgument}:\"{toolInternalName}\"");}}}diff --git a/src/app/dev/DevToys.Business/ViewModels/ToolPageViewModel.cs b/src/app/dev/DevToys.Business/ViewModels/ToolPageViewModel.csindex 67ea03849..a43267bae 100644--- a/src/app/dev/DevToys.Business/ViewModels/ToolPageViewModel.cs+++ b/src/app/dev/DevToys.Business/ViewModels/ToolPageViewModel.cs@@ -34,7 +34,7 @@ internal sealed partial class ToolPageViewModel : ObservableRecipient/// <summary>/// Gets the UI of the tool./// </summary>- internal UIToolView ToolView+ internal UIToolView? ToolView{get{diff --git a/src/app/dev/DevToys.Core/AppHelper.cs b/src/app/dev/DevToys.Core/AppHelper.csindex 428adc1e6..bdac5663d 100644--- a/src/app/dev/DevToys.Core/AppHelper.cs+++ b/src/app/dev/DevToys.Core/AppHelper.cs@@ -16,4 +16,57 @@ public static class AppHelper.GetCustomAttribute(typeof(AssemblyInformationalVersionAttribute))!;return assemblyInformationalVersion.InformationalVersion.Contains("pre", StringComparison.CurrentCultureIgnoreCase);});++ /// <summary>+ /// Gets the value of the specified command line argument.+ /// </summary>+ /// <param name="argumentName">The name of the argument. The name will be interpreted as "--name:". The string should not contains "--" and ":".</param>+ /// <returns>The argument value or <see cref="string.Empty"/> if not found.</returns>+ /// <remarks>+ /// This method will search for the argument in the command line arguments. The search is case-insensitive.+ /// Arguments must be like `--name:value` or `--name: value` or `--name: "value with space"`.+ /// </remarks>+ public static string GetCommandLineArgument(string argumentName)+ {+ return GetCommandLineArgument(Environment.GetCommandLineArgs(), argumentName);+ }++ /// <summary>+ /// Gets the value of the specified command line argument.+ /// </summary>+ /// <param name="arguments">The list of command line arguments</param>+ /// <param name="argumentName">The name of the argument. The name will be interpreted as "--name:". The string should not contains "--" and ":".</param>+ /// <returns>The argument value or <see cref="string.Empty"/> if not found.</returns>+ /// <remarks>+ /// This method will search for the argument in the command line arguments. The search is case-insensitive.+ /// Arguments must be like `--name:value` or `--name: value` or `--name: "value with space"`.+ /// </remarks>+ public static string GetCommandLineArgument(string[] arguments, string argumentName)+ {+ Guard.IsNotNull(arguments);+ Guard.IsNotNullOrWhiteSpace(argumentName);++ argumentName = $"--{argumentName}:";+ for (int i = 0; i < arguments.Length; i++)+ {+ string argument = arguments[i];+ if (argument.StartsWith(argumentName, StringComparison.OrdinalIgnoreCase))+ {+ if (argument.Length == argumentName.Length)+ {+ if (i + 1 < arguments.Length)+ {+ return arguments[i + 1].Trim('\"');+ }++ return string.Empty;+ }+ else+ {+ return argument.Substring(argumentName.Length).Trim('\"');+ }+ }+ }+ return string.Empty;+ }}diff --git a/src/app/dev/DevToys.Core/Mef/MefComposer.cs b/src/app/dev/DevToys.Core/Mef/MefComposer.csindex 206999639..b6e24bfe4 100644--- a/src/app/dev/DevToys.Core/Mef/MefComposer.cs+++ b/src/app/dev/DevToys.Core/Mef/MefComposer.cs@@ -9,9 +9,12 @@ namespace DevToys.Core.Mef;/// </summary>public sealed partial class MefComposer : IDisposable{+ private const string ExtraPluginArgument = "extraplugin";+private readonly ILogger _logger;private readonly Assembly[] _assemblies;private readonly string[]? _pluginFolders;+ private readonly string _extraPlugin;private readonly object[] _customExports;private bool _isExportProviderDisposed = true;@@ -21,13 +24,10 @@ public sealed partial class MefComposer : IDisposablepublic MefComposer(Assembly[]? assemblies = null, string[]? pluginFolders = null, params object[] customExports){- if (Provider is not null)- {- throw new InvalidOperationException("Mef composer already initialized.");- }-_logger = this.Log();+ _extraPlugin = AppHelper.GetCommandLineArgument(ExtraPluginArgument);+_assemblies = assemblies ?? Array.Empty<Assembly>();_pluginFolders = pluginFolders;_customExports = customExports ?? Array.Empty<object>();@@ -127,6 +127,11 @@ public sealed partial class MefComposer : IDisposablepluginFolders = new[] { Path.Combine(appFolder!, "Plugins") };}+ if (!string.IsNullOrWhiteSpace(_extraPlugin) && Directory.Exists(_extraPlugin))+ {+ yield return _extraPlugin;+ }+for (int i = 0; i < pluginFolders.Length; i++){string pluginFolder = pluginFolders[i];diff --git a/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs b/src/app/dev/DevToys.Core/Tools/GuiToolInstance.csindex 25c02b379..05ee6989f 100644--- a/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs+++ b/src/app/dev/DevToys.Core/Tools/GuiToolInstance.cs@@ -9,7 +9,7 @@ namespace DevToys.Core.Tools;[DebuggerDisplay($"InternalComponentName = {{{nameof(InternalComponentName)}}}")]public sealed partial class GuiToolInstance : ObservableObject, IDisposable{- private Lazy<UIToolView> _view;+ private Lazy<UIToolView?> _view;private readonly ILogger _logger;private readonly Lazy<IGuiTool, GuiToolMetadata> _guiToolDefinition;private readonly Lazy<IGuiTool> _instance;@@ -79,7 +79,7 @@ public sealed partial class GuiToolInstance : ObservableObject, IDisposable/// Gets the view of the tool./// Calling this property is expensive the first time as it will create the instance of the tool and the instance of the view./// </summary>- public UIToolView View => _view.Value;+ public UIToolView? View => _view.Value;public void Dispose(){@@ -124,7 +124,7 @@ public sealed partial class GuiToolInstance : ObservableObject, IDisposable{if (_view is not null && _view.IsValueCreated){- _view.Value.CurrentOpenedDialog?.Dispose();+ _view.Value?.CurrentOpenedDialog?.Dispose();}_view@@ -133,7 +133,7 @@ public sealed partial class GuiToolInstance : ObservableObject, IDisposableException? exception = null;try{- return _instance.Value.View;+ return _instance.Value?.View;}catch (NotImplementedException) { }catch (Exception ex)diff --git a/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs b/src/app/dev/DevToys.Core/Tools/GuiToolProvider.csindex 56e3ba9a9..1b7fd83e0 100644--- a/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs+++ b/src/app/dev/DevToys.Core/Tools/GuiToolProvider.cs@@ -339,8 +339,7 @@ public sealed partial class GuiToolProvider{GuiToolInstance tool = AllTools[i];- if (!tool.NotSearchable // do not search tools marked as non-searchable- && !string.IsNullOrWhiteSpace(tool.LongDisplayTitle)) // do not search tools without long display name.+ if (!tool.NotSearchable) // do not search tools marked as non-searchable{SearchTool(searchQueries, tool, out TextSpan[] matchedSpans, out double weight);@@ -659,7 +658,7 @@ public sealed partial class GuiToolProviderweight = 0;foreach (string? query in searchQueries){- WeightMatch(query, tool.LongDisplayTitle, out double titleWeight, out IReadOnlyList<TextSpan> spans);+ WeightMatch(query, tool.LongOrShortDisplayTitle, out double titleWeight, out IReadOnlyList<TextSpan> spans);WeightMatch(query, tool.SearchKeywords, out double searchKeywordsWeight, out _);WeightMatch(query, tool.Description, out double descriptionWeight, out _);diff --git a/src/app/dev/platforms/desktop/DevToys.MacOS/DevToys.MacOS.csproj b/src/app/dev/platforms/desktop/DevToys.MacOS/DevToys.MacOS.csprojindex 4437daa38..20fbe7909 100644--- a/src/app/dev/platforms/desktop/DevToys.MacOS/DevToys.MacOS.csproj+++ b/src/app/dev/platforms/desktop/DevToys.MacOS/DevToys.MacOS.csproj@@ -8,16 +8,8 @@<EnableDefaultCssItems>false</EnableDefaultCssItems><DefineConstants>$(DefineConstants);__MACOS__</DefineConstants>- <!-- The default runtime is osx-x64, except in Release config, in which case the default is osx-x64;osx-arm64.- When specifying both architectures, use the plural <RuntimeIdentifiers> instead of the singular <RuntimeIdentifer>.- The App Store will NOT accept apps with ONLY osx-arm64 indicated;- either BOTH runtimes must be indicated or ONLY osx-x64. -->- <!-- ex. <RuntimeIdentifiers>osx-x64;osx-arm64</RuntimeIdentifiers> -->-- <!-- The following 3 properties disable trimming and AOT. This allow us to load plugins at runtime. -->- <!-- <UseInterpreter>true</UseInterpreter>- <MtouchLink>None</MtouchLink>- <MtouchInterpreter>all</MtouchInterpreter> -->+ <!-- The following property disable trimming and AOT. This allow us to load plugins at runtime. -->+ <LinkMode>None</LinkMode><ApplicationId>com.devtoys</ApplicationId></PropertyGroup>diff --git a/src/app/dev/platforms/desktop/DevToys.Windows/Core/TaskbarJumpListService.cs b/src/app/dev/platforms/desktop/DevToys.Windows/Core/TaskbarJumpListService.csindex 4d8af14c1..f346065e8 100644--- a/src/app/dev/platforms/desktop/DevToys.Windows/Core/TaskbarJumpListService.cs+++ b/src/app/dev/platforms/desktop/DevToys.Windows/Core/TaskbarJumpListService.cs@@ -69,7 +69,7 @@ internal class TaskbarJumpListService : ObservableRecipientTitle = tool.LongOrShortDisplayTitle,Description = tool.Description,CustomCategory = category,- Arguments = $"{CommandLineLauncherService.ToolArgument}{tool.InternalComponentName}"+ Arguments = $"--{CommandLineLauncherService.ToolArgument}:\"{tool.InternalComponentName}\""};jumpList.JumpItems.Add(jumpTask);diff --git a/src/app/tests/DevToys.UnitTests/Core/AppHelperTests.cs b/src/app/tests/DevToys.UnitTests/Core/AppHelperTests.csnew file mode 100644index 000000000..eb89017ab--- /dev/null+++ b/src/app/tests/DevToys.UnitTests/Core/AppHelperTests.cs@@ -0,0 +1,18 @@+using DevToys.Core;++namespace DevToys.UnitTests.Core;++public class AppHelperTests+{+ [Theory]+ [InlineData(new[] { "" }, "tool", "")]+ [InlineData(new[] { "tool" }, "tool", "")]+ [InlineData(new[] { "--tool:" }, "tool", "")]+ [InlineData(new[] { "--tool:value" }, "tool", "value")]+ [InlineData(new[] { "--tool:", "value" }, "tool", "value")]+ [InlineData(new[] { "--tool:", "\"value with space\"" }, "tool", "value with space")]+ public void GetCommandLineArgument(string[] arguments, string searchedArgumentName, string expectedResult)+ {+ AppHelper.GetCommandLineArgument(arguments, searchedArgumentName).Should().Be(expectedResult);+ }+}diff --git a/src/build/Build.cs b/src/build/Build.csindex 225ae2d4a..ec2b61c86 100644--- a/src/build/Build.cs+++ b/src/build/Build.cs@@ -241,12 +241,14 @@ class Build : NukeBuildDotNetBuild(s => s.SetProjectFile(dotnetParameters.ProjectOrSolutionPath).SetConfiguration(Configuration)- .SetSelfContained(true)- .SetPublishSingleFile(false) // Not supported by MacCatalyst as it would require UseAppHost to be true, which isn't supported on Mac+ .SetFramework(dotnetParameters.TargetFramework)+ .SetRuntime(dotnetParameters.RuntimeIdentifier)+ .SetPlatform(dotnetParameters.Platform)+ .SetSelfContained(dotnetParameters.Portable)+ .SetPublishSingleFile(false).SetPublishReadyToRun(false)- .SetPublishTrimmed(true) // Should be true, even though the CSPROJ disable AOT and Trimming.+ .SetPublishTrimmed(true) // HACK: Required for MacOS. However, <LinkMode>None</LinkMode> in the CSPROJ disables trimming..SetVerbosity(DotNetVerbosity.quiet)- .SetNoRestore(true) /* workaround for https://github.com/xamarin/xamarin-macios/issues/15664#issuecomment-1233123515 */.SetProcessArgumentConfigurator(_ => _.Add("/p:RuntimeIdentifierOverride=" + dotnetParameters.RuntimeIdentifier).Add("/p:CreatePackage=True") /* Will create an installable .pkg */@@ -403,11 +405,11 @@ class Build : NukeBuildif (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)){- project = MacSolution!.GetProject(publishProject);+ project = MacSolution!.GetAllProjects(publishProject).Single();foreach (string targetFramework in project.GetTargetFrameworks()){- yield return new DotnetParameters(project.Path, "maccatalyst-arm64", targetFramework, portable: true);- yield return new DotnetParameters(project.Path, "maccatalyst-x64", targetFramework, portable: true);+ yield return new DotnetParameters(project.Path, "osx-arm64", targetFramework, portable: true);+ yield return new DotnetParameters(project.Path, "osx-x64", targetFramework, portable: true);}}else