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

Add missing property to CustomDocumentOpenContext #10784

Merged
merged 1 commit into from
Feb 23, 2022

Conversation

planger
Copy link
Contributor

@planger planger commented Feb 22, 2022

What it does

VSCode defines the optional property untitledDocumentData in CustomDocumentOpenContext. In theia.d.ts, this property is however missing. As it is optional and is not used from the plugin main implementation, this change is merely achieving source compatibility, but prepares its usage in the ext implementation of the plugin API.

Fixes #10005

Contributed on behalf of STMicroelectronics

How to test

As this change doesn't introduce new functionality per se, we just need to make sure existing functionality, especially with respect to custom editors contributed by VS Code extensions still work. Therefore, I tested with cat-customs.cat-customs and vscode.simple-browser, which both seem to be still working fine.

image

Review checklist

Reminder for reviewers

VSCode defines the optional property `untitledDocumentData` in
`CustomDocumentOpenContext`. In theia.d.ts, this property is however
missing. As it is optional and is not used from the main implementation,
this change is merely achieving source compatibility, but prepares its
usage in the ext implementation of the plugin API.

Contributed on behalf of STMicroelectronics

Signed-off-by: Philip Langer <planger@eclipsesource.com>

Fixes eclipse-theia#10005

Change-Id: I1b4d67b5b11fa2c94a8590aac6b8ad0f040cee94
@vince-fugnitto vince-fugnitto added the vscode issues related to VSCode compatibility label Feb 22, 2022
Copy link
Member

@msujew msujew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good. I can confirm that this change aligns the API to VSCode and introduces no regressions on existing custom document providers.

@msujew msujew merged commit 48cbd18 into eclipse-theia:master Feb 23, 2022
@planger planger deleted the planger/issues/10005 branch February 23, 2022 16:51
@vince-fugnitto vince-fugnitto added this to the 1.23.0 milestone Feb 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
vscode issues related to VSCode compatibility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement CustomDocumentOpenContext
3 participants