[Docs] Specify which version of npm this is for
orvn opened this issue · comments
Note
This is a docs/readme suggestion to help understand this package better when used in a project
Description of suggestion
Enhancement to the docs suggested, because it would be good to know if check-peer-dependencies
is build from the standpoint of npm < 7
or npm 7, 8+
. Since npm 7.0
had a major change in the way peer dependencies are treated (they are installed along with subdependencies, whereas in npm 6
and below, one had to add peers in their own project's dependencies).
I'm not sure whether --findSolutions
is finding solutions for the npm 6
or npm 7+
lockfile model.
I wrote this tooling for yarn 1.x, but threw in npm (6 and earlier) support just for fun. I haven't personally used npm 7 yet. I think this tool should work fine with npm 7, but can't confirm with any confidence. What has been your experience using it on a npm 7 project? Shouldn't all the peer deps already be satisfied if npm auto-installs them?