cli: Add check:theia-extensions command
#12596
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
sgraband
force-pushed
the
12572-checkTheiaExtensions
branch
from
a113bd5
to
f11b154
Compare
|
@tsmaeder Would you have time to review this sometime this week or next week? Or should we find someone else to review this? |
|
Sorry, this fell off the wagon. I'll make some time tomorrow. That said, could you resolve the conflicts? |
This allows to check for duplicate versions of theia extensions only. Added the option `only-theia-extensions` to `theia check:dependencies`. Theia extensions are identified via their `theiaExtensions` field in the `package.json`. The check is running recursively as long as it finds Theia extensions. The advantage of this approach is that a shorter, but more important, list is returned. Contributed on behalf of STMicroelectronics
sgraband
force-pushed
the
12572-checkTheiaExtensions
branch
from
f11b154
to
0be13d0
Compare
tsmaeder
approved these changes
Jul 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What it does
The goal of this PR is to improve the existing
theia check:dependenciesscript introduced in this PR. The existing script returns a list of all mismatching version numbers for all dependencies. While introducing two versions of the same dependency can always possibly introduce issues, this will be much more common for Theia extensions, than for other dependencies likeloadashorrimraf. Thats why:This allows to check for duplicate versions of theia extensions only.
Added the option
only-theia-extensionstotheia check:dependencies.Theia extensions are identified via their
theiaExtensionsfield in thepackage.json.The check is running recursively as long as it finds Theia extensions.
The recursion was added to also display cases where more than 2 versions of a dependency might extist.
The advantage of this approach is that a shorter, but more important, list is returned.
Fixes #12572.
Contributed on behalf of STMicroelectronics
How to test
yarndev-packages/cliand runyarn linkyarn link "@theia/cli"in its rootyarnto see the output (this will runtheia check:theia-extensionson postinstall)The provided example has a few issues built-in:
test-extensionrequires a@theia/coreversion of1.37.2while the application depends on1.38.0test-extension>test-extension-3>@eclipse-emfcloud/modelserver-theia:0.8.0-theia-cr03test-extension2>test-extension-4>@eclipse-emfcloud/modelserver-theia:0.8.0-theia-cr01@eclipse-emfcloud/modelserver-theia:0.8.0-theia-cr01depends on version1.37.2of@theia/(core|filesystem|process|variable-resolver|workpace)So the result of
theia check:theia-extensionsshould find the following issues:@theia/(filesystem|process|variable-resolver|workpace)from the application and@eclipse-emfcloud/modelserver-theia@theia/corefrom the application,@eclipse-emfcloud/modelserver-theiaandtest-extension@eclipse-emfcloud/modelserver-theiafromtest-extension-3andtest-extension-4Note that one of the versions will always be hoisted to the root
node_modulesversionReview checklist
Reminder for reviewers