gruntjs / gruntjs/grunt

npm@3 and peerDependencies

Open
#1,355 8 comments 1 reaction 0 assignees View on GitHub
Status: Ready
Dominant language
JavaScript
Stars
12.2k
Forks
1.5k
PR merge metrics
No merged PRs in 30d

Description

You may already be aware, but npm@3 introduces breaking changes to how peerDependencies are handled. Specifically, it no longer installs them for users. INSTEAD, it reports warnings if they're missing or invalid, but otherwise leaves it to the end user to solve.

I gather that grunt plugins regularly peerDep on grunt itself, which makes sense. This is the use case that peerDependencies were originally designed for. Where your users may run into issues is if they were using peerDependencies to do cross-plugin dependencies. In these cases I would recommend making them ordinary dependencies.

In checking a random handful of grunt plugins I didn't see any that ran afoul of the problem above, but still, I wanted to make sure you all were aware of the change.

Contributor guide

Open the contributing guide

Research direction

The issue discusses npm@3 peerDependencies but names no file, test, or entry point. First confirm whether Grunt documentation or plugin guidance needs updating; done would require a maintainer-defined scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
tooling
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.