mirror/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2024-12-04 11:59:07 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

[Docs]Clean up unneeded requirements from new PTRun plugin checklist (#30920)

Browse Source 
- change target framework
- remove x64
- clean
This commit is contained in:
Henrik Lau Eriksson 2024-01-17 16:57:56 +01:00 committed by GitHub
parent 1ebde89d1a
commit 7e8459b963
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/devdocs/modules/launcher/new-plugin-checklist.md
View File

@ -1,12 +1,14 @@
# New plugin checklist # New plugin checklist
- [ ] The plugin is a project under `modules\launcher\Plugins` - [ ] The plugin is a project under `modules\launcher\Plugins`
- [ ] Microsoft plugin project name pattern: `Microsoft.PowerToys.Run.Plugin.{PluginName}` - [ ] Microsoft plugin project name pattern: `Microsoft.PowerToys.Run.Plugin.{PluginName}`
- [ ] Community plugin project name pattern: `Community.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>$(Version).0</Version>` - [ ] The project file should import `Version.props` and specify `<Version>$(Version).0</Version>`
- [ ] If the plugin uses any 3rd party dependencies the project file should import `DynamicPlugin.props` - [ ] 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 "ID": string, // GUID string
"ActionKeyword": string, // Direct activation phrase "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. "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. - [ ] 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 ```csharp
public static string PluginID => "xxxxxxx"; // The part xxxxxxx stands for the plugin ID. 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 - [ ] 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 - [ ] 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) - [ ] 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. 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. 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 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 files under the section https://github.com/microsoft/PowerToys/blob/21247c0bb09a1bee3d14d6efa53d0c247f7236af/installer/PowerToysSetup/Product.wxs#L882