API proposal: save options
#245406
Open
API proposal: save options
#245406
+50
−15
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
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 PR resolves #245405 by proposing that the
savemethod onTextDocumentandNotebookDocumenttake an optional argument of typeSaveOptions, which is essentially just a public subset of the options in the privateISaveOptionsinterface. Specifically, the only one I've made public here isskipSaveParticipants; in keeping with the API guidelines, I've tried to be conservative while also making it easy to make otherISaveOptionsproperties public in the future, if desired.This PR has a couple issues currently, for which I need a maintainer's help:
The implementation is not gated behind
isProposedApiEnabled. I tried to do this, but I could not figure out how to get a reference to any specific extension from within thesrc/vs/workbench/api/common/extHostDocumentData.tsandsrc/vs/workbench/api/common/extHostNotebookDocument.tsfiles where the code changes needed to occur. Please let me know how I can gate these properly!No tests. I wanted to add a couple tests, but it looked like they would belong in
extensions/vscode-api-tests/src/singlefolder-tests/editor.test.tsandextensions/vscode-api-tests/src/singlefolder-tests/notebook.document.test.ts, and for the life of me I could not figure out how to run any of the tests underextensions/vscode-api-tests. Could information about that be added to the wiki? Once I know how to do it, I'd be happy to add those tests!I also have a question about the weekly API call: the wiki page says it's "open to everyone", but I'm having trouble finding information about when it takes place and how to join. When is the next API call and how can I attend it?