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

doc: Add page on authoring VS Code extensions #318

Merged
merged 1 commit into from
Sep 6, 2022

Conversation

planger
Copy link
Contributor

@planger planger commented Aug 30, 2022

Fixes #316

Contributed on behalf of STMicroelectronics.

Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

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

@planger overall the changes look really good, I only have minor suggestions if interested 👍


# Authoring VS Code Extensions

Alongside [Theia extensions](https://theia-ide.org/docs/extensions#theia-extensions), also VS Code extensions can be used to enhance Theia applications with additional functionality, such as language support, status bar items, or tree views.
Copy link
Member

Choose a reason for hiding this comment

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

minor:

Suggested change
Alongside [Theia extensions](https://theia-ide.org/docs/extensions#theia-extensions), also VS Code extensions can be used to enhance Theia applications with additional functionality, such as language support, status bar items, or tree views.
Alongside [Theia extensions](https://theia-ide.org/docs/extensions#theia-extensions), VS Code extensions can also be used to enhance Theia applications with additional functionality, such as language support, status bar items, or tree views.

For the three examples we list, we might want to choose the most common, for example language support, commands, tree-views, but I don't have a strong opinion.

Comment on lines 8 to 9
VS Code extensions contribute functionality through a dedicated extension API, originally defined for VS Code.
Theia, however, supports the extension API of VS Code, making extensions that have been developed for VS Code compatible to Theia, and vice versa.
Copy link
Member

Choose a reason for hiding this comment

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

minor: only a suggestion:

Suggested change
VS Code extensions contribute functionality through a dedicated extension API, originally defined for VS Code.
Theia, however, supports the extension API of VS Code, making extensions that have been developed for VS Code compatible to Theia, and vice versa.
VS Code extensions contribute functionality through the dedicated VS Cide API, which the Theia framework also supports. This means that extensions that have been developed for VS Code are also compatible with Theia, and vice versa.

Comment on lines 91 to 92
1. Pre-installing the VS Code extension in your Theia application
2. Enabling your users to install your VS Code extensions at runtime
Copy link
Member

Choose a reason for hiding this comment

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

minor: I believe the bullet points should be tabbed so they render correctly:

Screen Shot 2022-09-01 at 9 01 59 AM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately tabbing wasn't sufficient, but I added a CSS rule for ol corresponding to the existing rule for ul.

Fixes eclipse-theia#316

Contributed on behalf of STMicroelectronics.
@planger
Copy link
Contributor Author

planger commented Sep 1, 2022

Thanks @vince-fugnitto for your feedback and suggestions! in 38fc4f8 I've applied all of them.

Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@JonasHelming JonasHelming merged commit 844d132 into eclipse-theia:master Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add page about authoring VS Code extensions
3 participants