Introduce a concept of Command Descriptions for TF-IDF indexing #193937
Conversation
This file contains 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
TylerLeonhardt
changed the title
jrieken
requested changes
Sep 25, 2023
There was a problem hiding this comment.
Looking good, left some nit about the shape of MenuItemAction which should be addressed.
I understand the preference for ILocalizedString but I also have to say its ergnomics aren't great. The duplication of strings is annyoing and it's basically only because our NLS tool has short comings.
This does a few things in a few strategic commits: ### Commit 1 The first commit contains the actual functional changes. * In our TF-IDF implementation in the Command Palette we now consume command's description if available. This will help provide more hits in the similar commands category section of the Command Palette. To do this we now include the description in the MenuItem which is needed by the Command Palette. * It allows Allows `description` to be an `ILocalizedString` so that we can include both the translated & original strings in the TF-IDF calculation
TylerLeonhardt
force-pushed
the
tyler/icy-walrus
branch
from
bd4635f to
f0101f1
Compare
TylerLeonhardt
added a commit
that referenced
this pull request
Oct 4, 2023
This depends on #193937 and would allow Editor Commands' descriptions to be picked up in the TF-IDF indexing of commands. The problem I currently struggle with is what to do with this introduction of `ICommandMetadata`... do we want to add it to monaco? Do we want to add maybe a subset of it (just the description property)? Additionally, I noticed that the concept of a LocalizedString isn't a thing in the monaco API... so that would be _another_ thing to introduce. Should we add these types? Or should we have `description` be a `string` and then use that instead?
jrieken
approved these changes
Oct 5, 2023
Alex0007
pushed a commit
to Alex0007/vscode
that referenced
this pull request
Oct 26, 2023
…osoft#193937) * Introduce a concept of Command Descriptions for TF-IDF indexing This does a few things in a few strategic commits: ### Commit 1 The first commit contains the actual functional changes. * In our TF-IDF implementation in the Command Palette we now consume command's description if available. This will help provide more hits in the similar commands category section of the Command Palette. To do this we now include the description in the MenuItem which is needed by the Command Palette. * It allows Allows `description` to be an `ILocalizedString` so that we can include both the translated & original strings in the TF-IDF calculation * Rename any `description: ICommandHandlerDescription` to `metadata: ICommandMetadata` * move to localize2 * Joh's feedback * Add a description for auto save
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
COMPETING PR OF #193626 AND #193631
I recommend reviewing each commit at a time since a lot of this PR is renaming.
Commit 1
The first commit contains the actual functional changes.
descriptionto be anILocalizedStringso that we can include both the translated & original strings in the TF-IDF calculationIf a description is contributed, then that will be included in the TF-IDF chunk calculation. This allows us to include additional relevant information that will help the Command Palette find the command you're looking for.
Additionally, these descriptions are diplayed in the keybindings.json editing experience:
Commit 2
Rename any
description: ICommandHandlerDescriptiontometadata: ICommandMetadataCommit 3
moves to using
localize2Commit 4
addresses some feedback
Commit 5
Fixes #194108
Next steps
After this goes in, I'll work on lighting up the same for Editor Commands.