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

docs: add section on peerDependenciesMeta field #1822

Closed
wants to merge 2 commits into from

Conversation

foxxyz
Copy link
Contributor

@foxxyz foxxyz commented Sep 18, 2020

What

This PR adds documentation for the peerDependenciesMeta field of package.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

@foxxyz foxxyz requested a review from a team as a code owner September 18, 2020 03:57
@darcyclarke darcyclarke added Release 6.x work is associated with a specific npm 6 release Release 7.x work is associated with a specific npm 7 release semver:patch semver patch level for changes and removed Release 6.x work is associated with a specific npm 6 release labels Sep 18, 2020
@darcyclarke darcyclarke changed the base branch from latest to release/v7.0.0-beta September 18, 2020 18:25
@darcyclarke darcyclarke changed the base branch from release/v7.0.0-beta to latest September 18, 2020 18:25
@darcyclarke
Copy link
Contributor

@foxxyz hey! Thanks for this. We'll be pulling this into the v7 beta... no changes required.

@foxxyz
Copy link
Contributor Author

foxxyz commented Sep 18, 2020

Awesome, thanks for the review and let me know if there's anything you'd like me to add!

@darcyclarke darcyclarke added the Priority Backlog a "backlogged" item that will be tracked in a Project Board label Sep 22, 2020
@darcyclarke darcyclarke removed the Priority Backlog a "backlogged" item that will be tracked in a Project Board label Oct 1, 2020
@darcyclarke darcyclarke added the release: next These items should be addressed in the next release label Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release: next These items should be addressed in the next release Release 7.x work is associated with a specific npm 7 release semver:patch semver patch level for changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Document the peerDependenciesMeta in the package.json
4 participants