Align usage of gatsby-sharp #38618
Open
Align usage of gatsby-sharp #38618
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
All `safe-sharp.js` is now identical, where all are calling `gatsby-sharp` in a try-catch with fallback to directly requiring sharp
As `sharp` is already a dependency of `gatsby-sharp`, it is not necessary to include `sharp` in dependencies. Instead, peerDependencies should include `gatsby-sharp` as per best pratices in dependency management.
gatsbot
bot
added
the
status: triage needed
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.
Description
This PR aligned all
safe-sharp.jsin official packages and movesharpfrom direct dependencies to peerDependencies.Documentation
Moving
sharpfrom direct dependency intogatsby-sharpin all packages would probably causesharpto not be installed when Gatsby is being used without installinggatsby-sharp.Yarn or other package managers would warn that a peerDependency is not fulfilled and/or installing them by default.
This might warrant a mention of installing
gatsby-sharpin documentation pages pertaining to Gatsby image processing.Tests
I did not run automated e2e tests that are in this repository. Instead I use the modified packages via
yarn link. No problem occurred for my site that usegatsby-plugin-sharp. As the changes are identical with other packages, I think this change will do identically.Related Issues
These commints carry forward #34339 and should be a way to move forward to allow for single
sharpinstance source for all Gatsby plugins.The "friction" mentioned in safe-sharp.js files can be mitigated with documentation, and developers familiar with dependency updates should not face any issues.