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

[plug-in][doc] Breaking behavior change in Theia plug-ins #5743

Closed
kittaakos opened this issue Jul 18, 2019 · 5 comments · Fixed by #5745
Closed

[plug-in][doc] Breaking behavior change in Theia plug-ins #5743

kittaakos opened this issue Jul 18, 2019 · 5 comments · Fixed by #5745
Assignees
Labels
documentation issues related to documentation plug-in system issues related to the plug-in system

Comments

@kittaakos
Copy link
Contributor

After checking #5738 we realized that from now on, it is a must to add the following to the package.json of any Theia plug-ins:

"activationEvents": [
  "*"
]

Otherwise, it won't activate.

Instead of forcing clients to update their package.json content with the wildcard activationEvents, we could check if the theiaPlugin top level property exists in the package.json and if it has either the backend or the frontend props. If so, but the activationEvents is not defined, we can infer a wildcard. So the Theia plug-in can still start without any modifications. Thoughts?

CC: @benoitf

@kittaakos kittaakos added plug-in system issues related to the plug-in system proposal feature proposals (potential future features) labels Jul 18, 2019
@akosyakov
Copy link
Member

@benoitf @evidolob please let us know whether it would be enough to add a record to the CHANGELOG or we should fix it before next release

@benoitf
Copy link
Contributor

benoitf commented Jul 18, 2019

The entry should be enough (or failing with how to fix the plug-in)
Adding the default activationEvent with wildcard may be good but for example VS Code documentation says that it's never defaulted to * and has to be explicit. So maybe better to be in sync with VS Code.

Regarding che, all our plug-ins have already been updated for that change.

@akosyakov
Copy link
Member

The entry should be enough (or failing with how to fix the plug-in)

Ok, let's update the changelog then.

Adding the default activationEvent with wildcard may be good but for example VS Code documentation says that it's never defaulted to * and has to be explicit. So maybe better to be in sync with VS Code.

For VS Code extensions, we won't do it. It will be incorrect. I am asking only about Theia plugins.

@benoitf
Copy link
Contributor

benoitf commented Jul 18, 2019

For VS Code extensions, we won't do it. It will be incorrect. I am asking only about Theia plugins.

yes I understood, I was just saying that it's better to align behavior between theia plug-in and VSCode extension

@kittaakos kittaakos self-assigned this Jul 18, 2019
kittaakos pushed a commit that referenced this issue Jul 18, 2019
Fixes #5743

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
@kittaakos
Copy link
Contributor Author

Thank you all for the clarification.

@kittaakos kittaakos changed the title [plug-in][proposal] Breaking behavior change in Theia plug-ins [plug-in][doc] Breaking behavior change in Theia plug-ins Jul 18, 2019
@kittaakos kittaakos added documentation issues related to documentation and removed proposal feature proposals (potential future features) labels Jul 18, 2019
kittaakos pushed a commit that referenced this issue Jul 18, 2019
Fixes #5743

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to documentation plug-in system issues related to the plug-in system
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants