Deprecating buggy npm packages, dealing with deprecations
By: +David Herron; Date: 2016-08-25 10:20
$ npm install firstname.lastname@example.org npm WARN deprecated email@example.com: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue npm WARN deprecated firstname.lastname@example.org: lodash@<3.0.0 is no longer maintained. Upgrade to lodash@^4.0.0 email@example.com node_modules/hostr ├── firstname.lastname@example.org ├── email@example.com ├── firstname.lastname@example.org (email@example.com) ├── firstname.lastname@example.org (email@example.com, firstname.lastname@example.org, email@example.com, firstname.lastname@example.org, email@example.com, firstname.lastname@example.org) └── email@example.com (firstname.lastname@example.org)
Note this is fixed in the
hostr package, but I wanted to demonstrate the problem.
Deprecating old versions of your package
One thing that's going on is that somehow the
lodash project maintainers got
npm to print these messages. This is done with the
npm deprecate command. The USAGE is:
npm deprecate <name>[@<version>] <message>
So to get these messages the respective authors ran these commands:
npm deprecate "minimatch@<3.0.2" "Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue" npm deprecate 'lodash@<3.0.0' 'lodash@<3.0.0 is no longer maintained. Upgrade to lodash@^4.0.0'
What to do about deprecated dependencies
You could ignore the message. Your code is working, so what's the big deal? Uh... are you sure you're a software engineer and have that attitude? Clearly if the package maintainer went to the trouble of deprecating their package that indicates something should be changed.
The first stage is to determine whether the dependency is yours. Did your package directly make this stale dependency? Simply consult the
dependencies section of your
package.json to see. If so, update the version as directed.
Sometimes the dependency is indirect - that one of your dependencies depends on the stale package version. In such a case you have to contact the upstream package maintainer to get them to update their dependencies.
This can be determined with the
npm ls command
$ npm ls lodash /Users/david/bin └─┬ email@example.com ├─┬ firstname.lastname@example.org │ └── email@example.com └── firstname.lastname@example.org
In this case the
argr package has a dependency on the up-to-date package, while the
hostr package has the stale dependency.
In this case I contacted the
hostr author, and he thanked me for noting the problems, and fixed them. This works with no warnings or errors:
$ npm install email@example.com
What if the upstream package author is not so responsive? "It Depends" is the only answer. Suppose it's an outright dangerous problem, and if the upstream author doesn't want to fix it then you might have to refactor your application to avoid this dependency. There are plenty of packages available and maybe another will serve your need just as well (or better).