Add notebookWorkspaceEdit api proposal #149128
Merged
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
Splits a new `notebookWorkspaceEdit` out of the existing `notebookEditorEdit` proposal. The notebookWorkspaceEdit reflects the api that we believe should be finalized instead of `notebookEditorEdit`. It lets extensions use workspaceedits to change cells in a notebook or replace the metadata for a notebook document As part of this change, I've also marked all of the `notebookEditorEdit` apis as deprecated (except for `replaceNotebookMetadata` which exists in the new proposal too)
mjbvz
commented
May 9, 2022
| @@ -741,7 +778,7 @@ export class WorkspaceEdit implements vscode.WorkspaceEdit { | |||
| return this._edits.some(edit => edit._type === FileEditType.Text && edit.uri.toString() === uri.toString()); | |||
| } | |||
|
|
|||
| set(uri: URI, edits: TextEdit[]): void { | |||
| set(uri: URI, edits: TextEdit[] | unknown): void { | |||
There was a problem hiding this comment.
Needed for make TS happy with new proposal
| * @param uri A resource identifier. | ||
| * @param edits An array of text or notebook edits. | ||
| */ | ||
| set(uri: Uri, edits: TextEdit[] | NotebookEdit[]): void; |
There was a problem hiding this comment.
We should also likely update WorkspaceEdit.get and WorkspaceEdit.entries to return Array<TextEdit | NotebookEdit>
This would be a breaking change since existing callers will not know how to deal with a NotebookEdit. Alternatively we can keep get and entries returning TextEdit and add new apis that expose all edits
jrieken
approved these changes
May 11, 2022
4 tasks
Mingpan
pushed a commit
to Mingpan/vscode
that referenced
this pull request
May 23, 2022
* Add notebookWorkspaceEdit api proposal Splits a new `notebookWorkspaceEdit` out of the existing `notebookEditorEdit` proposal. The notebookWorkspaceEdit reflects the api that we believe should be finalized instead of `notebookEditorEdit`. It lets extensions use workspaceedits to change cells in a notebook or replace the metadata for a notebook document As part of this change, I've also marked all of the `notebookEditorEdit` apis as deprecated (except for `replaceNotebookMetadata` which exists in the new proposal too) * Export type from extHost
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.
Splits a new
notebookWorkspaceEditout of the existingnotebookEditorEditproposal.The
notebookWorkspaceEditproposal captures the api that we believe should be finalized instead of the existingnotebookEditorEditproposal. This new proposal extensions use workspaceedits to change cells in a notebook or replace the metadata for a notebook documentAs part of this change, I've also marked all of the
notebookEditorEditapis as deprecated (except forreplaceNotebookMetadatawhich exists in the new proposal too)