docs: add section on peerDependenciesMeta field #1822
Closed
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
This PR adds documentation for the
peerDependenciesMeta
field ofpackage.json
.Why
This field was announced in the Summer 2019 roadmap and landed in #224, but does not seem to have been documented. I actually needed this field and thought npm did not support it, because Yarn documents it and npm does not. However, checking the source made me realize it was definitely implemented, but not documented (#1247).
References
Fixes #1247