feat(plugins): validate peerDependency version on plugin load#117
Merged
Conversation
Read mage-remote-run from peerDependencies in each plugin's package.json and warn if the running tool version does not satisfy the declared range. The plugin still loads — this is a non-blocking warning, matching npm's own peer dependency behaviour. - Add semver dependency for range-aware version comparison - Read plugin package.json unconditionally (was only read in else branch) - Add _checkPeerDependency() method to PluginLoader
Add two fixture plugins and corresponding test cases: - compatible-peer-plugin: peerDependency ^1.0.0 (satisfied) — no warning - incompatible-peer-plugin: peerDependency ^99.0.0 (unsatisfied) — warns
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
"mage-remote-run": "^1.5.0"in theirpeerDependenciesto signal a minimum compatible tool versionPluginLoadernow reads that field at runtime and emits aconsole.warnif the running version does not satisfy the declared rangesemverpackage for correct range-aware comparisons (^,~,>=, etc.)Changes
lib/plugin-loader.jssemver, read tool version once at startup, refactorpackage.jsonread to be unconditional, add_checkPeerDependency()package.json/package-lock.jsonsemverdependencytests/fixtures/compatible-peer-plugin/^1.0.0(satisfied by current version)tests/fixtures/incompatible-peer-plugin/^99.0.0(never satisfied)tests/plugin-loader.test.jsTest plan