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

fix(package): Specify addon as peer dependency #200

Merged
merged 1 commit into from
Sep 23, 2016

Conversation

joefiorini
Copy link
Contributor

@joefiorini joefiorini commented Sep 7, 2016

Description

Fixes a bug where:

npm WARN saveError peer invalid: react@^15.3.1, required by react-addons-shallow-compare@15.3.1

happened when running npm install and

npm ERR! peer invalid: react@^15.3.1, required by react-addons-shallow-compare@15.3.1

happened when running npm shrinkwrap.

Checklist

  • All tests passing
  • Created tests which fail without the change (if possible)
  • Extended the README / documentation, if necessary
  • Commits and PR follow conventions

BREAKING CHANGE: react-addons-shallow-compare is now a peer dependency,
meaning users must install it separately from react-geosuggest.

The peer dependency for react allows one to use either react 0.14 or
0.15. However, the dependency for react-addons-shallow-compare only
allows 0.15 versions. For anyone using react 0.14 this causes warnings
from npm saying that the peer dependency for react 0.15 (specified by
react-addons-shallow-compare) is missing. This completely breaks
workflows depending on npm shrinkwrap.

BREAKING CHANGE: react-addons-shallow-compare is now a peer dependency,
meaning users must install it separately from react-geosuggest.

The peer dependency for react allows one to use either react 0.14 or
0.15. However, the dependency for react-addons-shallow-compare only
allows 0.15 versions. For anyone using react 0.14 this causes warnings
from npm saying that the peer dependency for react 0.15 (specified by
react-addons-shallow-compare) is missing. This completely breaks
workflows depending on `npm shrinkwrap`.
@joefiorini
Copy link
Contributor Author

@ro-ka Any thoughts on this?

@yfr yfr merged commit 4188acc into ubilabs:master Sep 23, 2016
@yfr
Copy link
Member

yfr commented Sep 23, 2016

@joefiorini Thanks for the PR. Just thought after clicking the merge button that we might need to update the README. So that the user might need to install the peer dependencies.

@shane935
Copy link

I found this issue on react-redux-form about using react's internal version of shallow-compare so it is not needed as a peer dependency.

davidkpiano/react-redux-form#215 (comment)

Happy to submit a pull request if you like the solution.

@ro-ka
Copy link
Contributor

ro-ka commented Oct 21, 2016

That sounds like a good solution! Cannot revert the v2 release but still it’s more convenient. Would love a PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants