Fix peerDependencies of chart.js version <3.0.0 #48
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
…ned in README.md Signed-off-by: Jackson Gross <jackson.gross@gmail.com>
tnir
suggested changes
May 1, 2022
| @@ -49,6 +49,6 @@ | |||
| "rollup-plugin-terser": "^7.0.2" | |||
| }, | |||
| "peerDependencies": { | |||
| "chart.js": "^3.0.0" | |||
| "chart.js": ">=2.8.0" | |||
There was a problem hiding this comment.
Why not exclude 4.x?
Suggested change
| "chart.js": ">=2.8.0" | |
| "chart.js": ">=2.8.0 < 4" |
There was a problem hiding this comment.
Why exclude? I think its a greater change this will work with 4.x than not. That translates directly to needing to do a new release of this adapter when 4.x is released.
There was a problem hiding this comment.
Just avoid unexpected breaking changes in chart.js 4.x. You can include 4.x in a next patch release 😁
There was a problem hiding this comment.
Yeah I agree with @kurkle, especially considering there isn't any version 4 released, and I haven't seen any plans to release a new major version as far as I know. I think it would be great to leave it as is to prevent the least amount of disruption 😄
| @@ -29,7 +30,7 @@ | |||
| "rollup-plugin-terser": "^7.0.2" | |||
| }, | |||
| "peerDependencies": { | |||
| "chart.js": "^3.0.0" | |||
| "chart.js": ">=2.8.0" | |||
There was a problem hiding this comment.
Suggested change
| "chart.js": ">=2.8.0" | |
| "chart.js": ">=2.8.0 <4" |
kurkle
approved these changes
May 1, 2022
etimberg
approved these changes
May 1, 2022
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?
peerDependenciesforchart.jsto>=2.8.0inpackage.jsonto match support mentioned in README.mdWhy?
There was a related issue that was closed which was actually a valid problem I ran into if a project is using npm 7+ and depends on
chart.js>=2.8.0 and <3.0.0. The code is definitely supported, but the package resolution is broken due to how peerDependencies are resolved since npm 7.This change ensures that users can still install this package using older supported versions of chart.js.