Fix vscode.commands.executeCommand() documentation #80758
Closed
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
As noted in #80338, when executing a command that is contributed by an extension that is not yet loaded results in serializing all arguments. Only the types allowed to be passed to editor commands and JSON-serializable objects are guaranteed to survive being passed to another extension.
jrieken
requested changes
Sep 12, 2019
src/vs/vscode.d.ts
Outdated
| * * *Note 2:* When executing commands that have been contributed by other | ||
| * extensions, any JSON-serializable objects are additionally allowed. | ||
| * * *Note 3:* There are no restrictions when executing commands that have | ||
| * been contributed by the extension that is executing them. |
There was a problem hiding this comment.
Your comment here #80758 (comment) is much better because that's how it is. Generally, there are no restrictions when calling a command that's contributed by another extension unless that command is used to activate the extension.
There was a problem hiding this comment.
You could also hint towards Extension#isActive and Extension#activate here
There was a problem hiding this comment.
Thanks. Updated with something that I hope succinctly describes the rules.
Reworded the documentation to explicitly say that there are no restrictions if the extension is active and some restrictions if it isn't.
|
The working is now better I think overall the problem shouldn't be there to begin with. I have pushed a change for #80338 that makes this doc change not needed. Still, thanks for drilling into this. |
|
Great! I like that solution much better. |
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.
As noted in #80338, when executing a command that is contributed by an extension
that is not yet loaded results in serializing all arguments. Only the types
allowed to be passed to editor commands and JSON-serializable objects are
guaranteed to survive being passed to another extension.