From 7e8459b963dce734044ce7606b20e3e28d79ab53 Mon Sep 17 00:00:00 2001 From: Henrik Lau Eriksson Date: Wed, 17 Jan 2024 16:57:56 +0100 Subject: [PATCH] [Docs]Clean up unneeded requirements from new PTRun plugin checklist (#30920) - change target framework - remove x64 - clean --- .../modules/launcher/new-plugin-checklist.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/devdocs/modules/launcher/new-plugin-checklist.md b/doc/devdocs/modules/launcher/new-plugin-checklist.md index df5834d5bd..1d76e85b75 100644 --- a/doc/devdocs/modules/launcher/new-plugin-checklist.md +++ b/doc/devdocs/modules/launcher/new-plugin-checklist.md @@ -1,12 +1,14 @@ # New plugin checklist + - [ ] The plugin is a project under `modules\launcher\Plugins` - [ ] Microsoft plugin project name pattern: `Microsoft.PowerToys.Run.Plugin.{PluginName}` - [ ] Community plugin project name pattern: `Community.PowerToys.Run.Plugin.{PluginName}` +- [ ] The plugin target framework should be `net8.0-windows` - [ ] The project file should import `Version.props` and specify `$(Version).0` - [ ] If the plugin uses any 3rd party dependencies the project file should import `DynamicPlugin.props` -- [ ] Make sure `*.csproj` specify only x64 platform target -- [ ] The plugin has to contain a `plugin.json` file of the following format in its root folder -``` +- [ ] The plugin has to contain a `plugin.json` file of the following format in its root folder: + +```json { "ID": string, // GUID string "ActionKeyword": string, // Direct activation phrase @@ -22,10 +24,13 @@ "DynamicLoading": bool // Sets whether the plugin should dynamically load any dependencies isolated from the core application. } ``` + - [ ] Make sure your `Main` class contains a public, static string property for the `PluginID`. The plugin id has to be the same as the one in the `plugin.json`file. + ```csharp public static string PluginID => "xxxxxxx"; // The part xxxxxxx stands for the plugin ID. ``` + - [ ] Do not use plugin name or PowerToys as prefixes for entities inside of the plugin project - [ ] The plugin has to have Unit tests. Use MSTest framework - [ ] Plugin's output code and assets have to be included in the installer [`Product.wxs`](/installer/PowerToysSetup/Product.wxs) @@ -36,6 +41,5 @@ public static string PluginID => "xxxxxxx"; // The part xxxxxxx stands for the p Some localization steps can only be done after the first pass by the localization team to provide the localized resources. In the PR that adds a new plugin, reference a new issue to track the work for fully enabling localization for the new plugin. - - [ ] Add the resource folder to https://github.com/microsoft/PowerToys/blob/21247c0bb09a1bee3d14d6efa53d0c247f7236af/installer/PowerToysSetup/Product.wxs#L825 - - [ ] Add the resource files under the section https://github.com/microsoft/PowerToys/blob/21247c0bb09a1bee3d14d6efa53d0c247f7236af/installer/PowerToysSetup/Product.wxs#L882 - +- [ ] Add the resource folder to https://github.com/microsoft/PowerToys/blob/21247c0bb09a1bee3d14d6efa53d0c247f7236af/installer/PowerToysSetup/Product.wxs#L825 +- [ ] Add the resource files under the section https://github.com/microsoft/PowerToys/blob/21247c0bb09a1bee3d14d6efa53d0c247f7236af/installer/PowerToysSetup/Product.wxs#L882