mir/PowerToys
2
0
Fork 0
mirror of https://github.com/microsoft/PowerToys synced 2025-08-22 18:17:19 +00:00
Code Issues Actions 13 Packages Projects Releases Wiki Activity
PowerToys/doc/devdocs/modules/launcher/plugins/overview.md
Josh Soref 74a1a6eca2
Some checks are pending
Spell checking / Check Spelling (push) Waiting to run
Details
Spell checking / Report (Push) (push) Blocked by required conditions
Details
Spell checking / Report (PR) (push) Blocked by required conditions
Details
Spell checking / Update PR (push) Waiting to run
Details
Upgrade to check-spelling v0.0.24 (#36235) 
This upgrades to [v0.0.24](https://github.com/check-spelling/check-spelling/releases/tag/v0.0.24).

A number of GitHub APIs are being turned off shortly, so you need to upgrade or various uncertain outcomes will occur.

There's a new accessibility forbidden pattern:

> Do not use `(click) here` links
> For more information, see:
> * https://www.w3.org/QA/Tips/noClickHere
> * https://webaim.org/techniques/hypertext/link_text
> * https://granicus.com/blog/why-click-here-links-are-bad/
> * https://heyoka.medium.com/dont-use-click-here-f32f445d1021
```pl
(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()
```

There are some minor bugs that I'm aware of and which I've fixed since this release, but I don't expect to make another release this month.

I've added a pair of patterns for includes and pragmas. My argument is that the **compiler** will _generally_ tell you if you've misspelled an include and the **linker** will _generally_ tell you if you misspell a lib.

- There's a caveat here: If your include case-insensitively matches the referenced file (but doesn't properly match it), then unless you either use a case-sensitive file system (as opposed to case-preserving) or beg clang to warn, you won't notice when you make this specific mistake -- this matters in that a couple of Windows headers (e.g. Unknwn.h) have particular case and repositories don't tend to consistently/properly write them.
2024-12-06 10:33:08 -06:00

2.4 KiB
Raw Blame History

Structural Overview

The following basic functions are common to each of the plugins. They perform some rudimentary operations such as initialization of the plugin, executing the query that has been entered, loading context menu icons, updating settings when configurations are altered in the settings UI, and updating the theme of the icons when the theme changed event is triggered.

IPlugin Interface

Each plugin implements the IPlugin interface which comprises of the Init() and Query() functions.

Init

  • The Init() function initializes the context, storage and settings of each plugin. This is equivalent to a constructor and is the first function to be called in the Main.cs file for each plugin.

Query

  • For every query that the user enters into PT Run, the PluginManager.cs executes the Query() function in the Main.cs file corresponding to each Plugin.

Context Menu Icons

  • The ContextMenus are loaded for each result based on the type of the result.
  • The various types of ContextMenu functionalities are:
    • Open containing folder
    • Run as Administrator
    • Open in console
    • Copy path

UpdateSettings

  • This function updates the settings of each plugin based on the changes made by the user in the settings UI.
  • Eg: To disable drive detection in the indexer plugin, when the user checks or unchecks the drive detection check box, the UpdateSettings() function dispatches the changes in the check box to the plugin.

ThemeChanged

  • This function is invoked when there is a change in the theme of PT Run.
  • It is used to update the IconPath for each plugin based on the theme.

Save

  • This function saves the configurations of each plugin so that they can be loaded the next time.

Score

  • The user query is executed against each of the plugins and the result list view is updated with results from each of the plugins.
  • The ordering of the results is based on the Score of each Result.
  • Each plugin assigns a score to a result based on its relevance. The results with higher scores are displayed higher in the list view and vice versa.

Plugin settings

Plugin settings that are editable from the settings are stored in PowerToys Run\settings.json. In the very first run, those settings are populated from plugin' plugin.json file. Unlike Wox we do not support multiple action keywords. Instead, we have ActionKeyword and IsGlobal options.