Add support to peerDependenciesMeta

[abdonrd]

This PR contains:

• bugfix
• feature
• refactor
• tests
• documentation
• metadata

Breaking Changes?

• yes
• no

If yes, please describe the breakage.

Please Describe Your Changes

Fix #10

[shellscape]

Please provide a link to NPM documentation or an NPM specification that details the peerDependenciesMeta property. Please note that it must be for NPM proper, and not a third party package manager.

[abdonrd]

@shellscape I found it here at the npm blog:

https://blog.npmjs.org/post/186983646370/npm-cli-roadmap-summer-2019

New features likely to land on the 6.x branch:

Add support for the peerDependenciesMeta field. (#224)

Also here in the changelog:

https://github.com/npm/cli/releases/tag/v6.11.0

Also the release announcement:

https://npm.community/t/release-6-11-0/9572

But I can't find it in the docs.

[abdonrd]

I just created an issue to request docs: npm/cli#1247

[shellscape]

👍 Let's wait to see what they say about updating the docs.

[abdonrd]

Ok! But isn't the blog and changelog enough to support it? I say this because seeing the issues they have, it seems that they take a long time to respond...

Thanks in advance and thank for the plugin!

[shellscape]

I'll see what I can do to get eyes on that through back channels. NPM supports a ton of properties so things don't break, but the list of properties that are first-class official NPM properties that are the baseline for an NPM package is pretty short.

It's a bit of a rabbit hole to support all possible properties in this plugin, so a baseline is needed, which is why I go from the docs or accepted spec from NPM itself.

[abdonrd]

Got it, thanks again!

[abdonrd]

In case this information helps you, we have just started using that property to avoid the warnings that the official NPM CLI gives when you do not install all the peer dependencies.

If we do not use this property, it is the official NPM CLI that shows us the warning.

[abdonrd]

More info, also the package-lock.json changes with this:

You can see how the requires object is different now.

[abdonrd]

@shellscape official documentation is coming! npm/cli#1822

[shellscape]

that's great. since it's got acknowledgement from NPM, we can add support here. Please do update the README and we should be good.

[abdonrd]

@shellscape done!