Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to the finalized notebookEditor API #151661

Closed
5 tasks done
mjbvz opened this issue Jun 9, 2022 · 4 comments · Fixed by #164504
Closed
5 tasks done

Switch to the finalized notebookEditor API #151661

mjbvz opened this issue Jun 9, 2022 · 4 comments · Fixed by #164504
Assignees
Labels
debt Code quality issues insiders-released Patch has been released in VS Code Insiders notebook-api
Milestone

Comments

@mjbvz
Copy link
Collaborator

mjbvz commented Jun 9, 2022

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:

  1. Switch your extension to target VS Code 1.68
  2. pulling in the new vscode.d.ts
  3. Remove notebookEditor from your list of enabled API proposal.

However there are few small bumps to be aware of:

  • NotebookEditor.document has been renamed NotebookEditor.notebook. Please make sure to switch over to the new property name as part of this migration

  • We did not finalize the version of showNotebookDocument that takes a uri. Instead you can use openNotebookDocument(uri).then(document => showNotebookDocument(document, options))


Here's a list of all current consumers of the old API proposal:

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

@mjbvz mjbvz self-assigned this Jun 9, 2022
@mjbvz mjbvz added this to the June 2022 milestone Jun 9, 2022
@mjbvz mjbvz added the debt Code quality issues label Jun 9, 2022
@tanhakabir tanhakabir removed their assignment Jun 10, 2022
@joyceerhl joyceerhl removed their assignment Jun 23, 2022
@dbaeumer
Copy link
Member

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.

@mjbvz
Copy link
Collaborator Author

mjbvz commented Jun 30, 2022

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

@jkeech
Copy link
Member

jkeech commented Jul 26, 2022

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.

@mjbvz mjbvz modified the milestones: July 2022, August 2022 Jul 27, 2022
@jkeech
Copy link
Member

jkeech commented Jul 28, 2022

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.

@mjbvz mjbvz modified the milestones: August 2022, September 2022 Aug 17, 2022
@mjbvz mjbvz modified the milestones: September 2022, October 2022 Sep 21, 2022
mjbvz added a commit to mjbvz/vscode that referenced this issue Oct 24, 2022
mjbvz added a commit to mjbvz/vscode that referenced this issue Oct 24, 2022
All consumers should now be on the finalized api

Fixes microsoft#151661
mjbvz added a commit that referenced this issue Oct 24, 2022
All consumers should now be on the finalized api

Fixes #151661
@vscodenpa vscodenpa added unreleased Patch has not yet been released in VS Code Insiders insiders-released Patch has been released in VS Code Insiders and removed unreleased Patch has not yet been released in VS Code Insiders labels Oct 24, 2022
formigoni pushed a commit to formigoni/vscode that referenced this issue Oct 27, 2022
All consumers should now be on the finalized api

Fixes microsoft#151661
@github-actions github-actions bot locked and limited conversation to collaborators Dec 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
debt Code quality issues insiders-released Patch has been released in VS Code Insiders notebook-api
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants