vscode
vscode copied to clipboard
Switch to the finalized notebookEditor API
The notebookEditor has been finalized with VS Code 1.68 🎉 (#149271). If your extension was using the proposal, you should now switch to the finalized version of this API.
In the majority of cases, this switch is as simple as:
- Switch your extension to target VS Code
1.68 - pulling in the new
vscode.d.ts - Remove
notebookEditorfrom your list of enabled API proposal.
However there are few small bumps to be aware of:
-
NotebookEditor.documenthas been renamedNotebookEditor.notebook. Please make sure to switch over to the new property name as part of this migration -
We did not finalize the version of
showNotebookDocumentthat takes a uri. Instead you can useopenNotebookDocument(uri).then(document => showNotebookDocument(document, options))
Here's a list of all current consumers of the old API proposal:
- [ ] ms-vsliveshare.vsliveshare — @alyssajotice @fubaduba
- [X] ms-toolsai.vscode-ai-remote — @sevillal https://github.com/microsoft/vscode-azureml/issues/245
- [x] Dot net interactive — @brettfo, @colombod https://github.com/dotnet/interactive/issues/2149
- [x] GitHub.codespaces — @jkeech @KartikM123 @osortega
- [x] ms-python.vscode-pylance — https://github.com/microsoft/pylance-release/issues/3054
If you own one of these extensions, please migrate to the finalized notebook editor API. Let me know once the new version of your extension is published and I will remove your extension from the list of api consumers
I am actually fine in ESLint. The dependency was because of notebook support in LSP and LSP already converted to the final version for the 8.x release of the LSP libs.
Thank you everyone who's checked off their extension so far! If you have, I plan to remove your extension from the list of notebookEditorAPI consumers in July. This will only start effecting the insiders builds of VS Code at first, but please let me know if you notice any issues
I'm working on the change for Codespaces and expect it to be in our next extension release (1.10.0) in a few days. I'll reply back once it's on the marketplace.
We just published GitHub Codespaces 1.10.0 with this change, so you should be able to remove our extension from the list of notebookEditor proposed API consumers.