By now there are probably more articles about the flaws of NPM and the NPM registry than articles about how Java will die soon, but I felt like there haven’t been many of them which suggest solutions or workarounds to these problems, so these are the aspects I want to try to focus on here.
Most of the articles I read in the past months regarding the NPM registry boil down to a handful of problems:
- Quantity over quality - there are a lot of packages, many of them abandoned or near-duplicates of each other (who needs over a hundred different packages for calculating Levenshtein distance?).
- Needlessly large dependency trees - a single, simple package often comes with a ton of transient dependencies.
- Handling of package ownership and removal - see the infamous “left-pad” and “event-stream” incidents.
- Lack of security (often caused by points 2 and 3). There have been several incidents of backdoors or other malicious code being inserted into NPM packages (see “event-stream” in the previous bullet point).
3 and 4 are problems only the NPM team can fix, and honestly, I don’t see any simple solution for them. So let’s focus on 1 and 2, which can be fixed by package authors and consumers.
How Authors Can Help Fix the Problems
What makes a ‘good’ package? I would argue: A library or tool should have a clear scope, be good at what it does and handle edge-cases appropriately, while also making sure to have as few dependencies as possible. Additionally, it should be actively maintained and for example, security issues should be fixed in time.
Here are some questions you could ask yourself before publishing a new package:
- Does the code of this package justify publishing it for re-use? If the content of your package is limited to a handful of lines, it probably won’t need to be its own package.
- Does something like this already exist? Is it worth it to publish this rather than making a pull request for an existing package? (I’ve been guilty of ignoring this too many times myself).
- Are all the dependencies of the package required? Are there any which have numerous dependencies themselves? Are they trustworthy?
- Are you willing to maintain this package? This one is a bit tricky; While I would argue that you should try to commit to maintaining your package, this one is not always possible. The GitHub user dominictarr also summed this up nicely in a response to the “event-stream” incident.
How Consumers of Packages Can Avoid Problems