microsoft / microsoft/vscode-languageserver-node
Add support for `NotebookEdit` in `WorkspaceEdit`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.8k
- Forks
- 404
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 14
Description
Currently there is no way to provide diffs at the notebook level. We currently receive notebook changes in the form of notebook synchronization events.
The Notebook features that are available from TS APIs like WorkspaceEdit.set is currently not exposed to Language Servers. Having this will allow language servers to perform notebook level "formatting" (restructuring), refactoring, insert/delete/re-order cells.
Adding NotebookEdit support can generally allow updating notebooks via formatting, code action, or any request.
Notes:
- We will need to add
NotebookEdittoWorkspaceEdit, and also introduce aNotebookCellDatatype since theNotebookCelltype is not sufficient to create new cells. - Core
WorkspaceEditAPI supportsNotebookEdit: https://github.com/microsoft/vscode/blob/29e000b1e5c03e7c9a6fccf3e475f0b5a239e4d6/src/vscode-dts/vscode.d.ts#L3967 NotebookCellData: https://github.com/microsoft/vscode/blob/29e000b1e5c03e7c9a6fccf3e475f0b5a239e4d6/src/vscode-dts/vscode.d.ts#L14869-L14911
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the linked VS Code WorkspaceEdit and NotebookCellData API definitions, then trace the corresponding WorkspaceEdit types in this repository. Done means Language Servers can represent NotebookEdit changes and create new notebook cells through the exposed API, with behavior aligned to the referenced core API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100