CmdPal: Fallback ranking and global results #43089
Draft
+652
−178
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaeljolley
added
Don't merge - Hold for release
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| private static readonly CompositeFormat PluginOpenURL = System.Text.CompositeFormat.Parse(Properties.Resources.plugin_open_url); | ||
| private static readonly CompositeFormat PluginOpenUrlInBrowser = System.Text.CompositeFormat.Parse(Properties.Resources.plugin_open_url_in_browser); | ||
|
|
||
| private const string _id = "com.microsoft.cmdpal.builtin.websearch.openurl.fallback"; |
Check failure
Code scanning / check-spelling
Unrecognized Spelling
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a draft for a reason
Warning
This is not fully baked. All features are there and work as expected but the way fallbacks are ranked or "checked" to be included in global results will change before final release.
Important
However, for extension developers, there is a breaking change for fallback items that you'll want to review and adjust your extensions accordingly. This release includes a new required
string Idproperty forFallbackCommandItem. While your existing extensions will continue to work, without thisIdbeing set, your fallbacks will not display and will not be rankable.Here are the relevant changes to
IFallbackCommandItemandFallbackCommandItem.Before this is released, you will want to prepare your extension fallbacks.
As an example, we are naming our built-in extensions as:
com.microsoft.cmdpal.builtin.calculatorcom.microsoft.cmdpal.builtin.calculator.fallbackWhile the content of the Id isn't important, what is important is that it is unique to your extension and fallback to avoid conflicting with other extensions.
Now the good stuff:
What the heck does it do!?
The backstory
In PowerToys 0.95, we released performance improvements to Command Palette. One of the many ways we improved its speed is by no longer ranking fallback commands with other "top level" commands. Instead, all fallbacks would surface at the bottom of the results and be listed in the order they were registered with Command Palette. But this was only a temporary solution until the work included in this pull request was ready.
In reality, not all fallbacks were treated equally. We marked the calculator and run fallbacks as "special." Special fallbacks were ranked like top-level commands and allowed to surface to the top of the results.
The new "hotness"
This PR brings the power of fallback management back to the people. In the Command Palette settings, you, dear user, can specify what order you want fallbacks to display in at the bottom of the results. This keeps those fallbacks unranked by Command Palette but displays them in an order that makes sense for you. But keep in mind, these will still live at the bottom of search results.
But alas, we have also heard your cries that you'd like some fallbacks to be ranked by Command Palette and surface to the top of the results. So, this PR allows you to mark any fallback as "special." Special fallbacks are treated like "top level" commands and appear in the search result based on their title & description.
Screenshots/video
I'll update this PR with a video once the settings UI has been solidified. Posting what it looks like today would be misleading.
GitHub issue maintenance details
Closes #38312
Closes #38288
Closes #42524
Closes #41024
Closes #40351
Closes #41696