fix: loosen peerDependencies to document the oldest compatible package #506
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.
tl:dr
it has been an error on my part to sync the
peerDependencies
manually with thedevDependencies
that lerna bumps automatically. we should be advertising the lowest compatible version, not the most recent.@jPurush shared a thread with me the other day that made me realize:
peerDependencies
for each packagepeerDependency
to exclude a previously compatible version, its likely that a breaking change is being introduced.for example, we should have tagged
v2.0.0
when we landed #400 because we introduced a dependency on a newcleanUrl()
method inside the request package in existing functions in other packages.folks even reported uncaught errors to me when
cleanUrl()
wasn't found in their own projects that were resolved by upgradingrequest
. i knew enough about what was going on to recommend the fix to people but not enough to realize that we'd broken our contract.getting in here and trying to figure out exactly what the minimum requirements were for our packages actually made the relationships more clear to me.
besides that, going forward we'll benefit from the lack of rote manual version bumping.
reference:
lerna publish
lerna/lerna#1018AFFECTS PACKAGES:
@esri/arcgis-rest-auth
@esri/arcgis-rest-feature-service-admin
@esri/arcgis-rest-feature-service
@esri/arcgis-rest-geocoder
@esri/arcgis-rest-groups
@esri/arcgis-rest-items
@esri/arcgis-rest-routing
@esri/arcgis-rest-sharing
@esri/arcgis-rest-users