Publishing npm packages is only a
npm publish away. Assuming the package name is still available and everything goes fine, you should have something out there! After this, you can install your package through
npm install or
Most of the community follows a specific versioning convention which you should understand. It comes with its downsides but given that the majority use and understand it, it’s worth covering.
Most popular packages out there follow SemVer. Roughly, SemVer states that you should not break backward compatibility, given certain rules are met:
The rules are different for
0.x versions. There the rule is
0.<MAJOR>.<MINOR>. For packages considered stable and suitable for public usage (
1.0.0 and above), the rule is
<MAJOR>.<MINOR>.<PATCH>. For example, if the current version of a package is
0.1.4 and a breaking change is performed, it should bump to
Given SemVer can be tricky to manage, ComVer exists as a backwards compatible alternative. ComVer can be described as a binary decision
You can understand SemVer much better by studying the online tool and how it behaves.
Not all version number systems are created equal. Sometimes people prefer to use their own and go against the mainstream. Sentimental versioning by Dominic Tarr discusses this phenomenon.
To increase the version of your packages, you need to invoke one of these commands:
npm version <x.y.z>- Define version yourself.
npm version <major|minor|patch>- Let npm bump the version for you using SemVer.
npm version <premajor|preminor|prepatch|prerelease>- Same as previous expect this time it generates
-<prerelease number>suffix. Example:
Invoking any of these updates package.json and creates a version commit to git automatically. If you execute
npm publish after doing this, you should have a new version out there.
Sometimes, you want to publish something preliminary to test. Tag your release as below:
The initial alpha release allows the users to try out the upcoming functionality and provide feedback. The beta releases can be considered more stable.
The release candidates (RC) are close to an actual release and don’t introduce any new functionality. They are all about refining the release till it’s suitable for general consumption.
The workflow has two steps:
npm version 0.5.0-alpha1- Update package.json as discussed earlier.
npm publish --tag alpha- Publish the package under alpha tag.
To consume the test version, your users have to use
npm install <your package name>@alpha.
npm link allows you to link a package as a globally available symbolic link. Node resolves to the linked version unless local
npm unlink <package>to remove the link.
It’s possible that your package reaches the end of its life. Another package could replace it, or it can become obsolete. For this purpose, npm provides npm deprecate command. You can state
npm deprecate [email protected]"< 0.4.0" "Use bar package instead".
You can deprecate a range or a whole package by skipping the range. Given mistakes happen, you can undeprecate a package by providing an empty message.
Deprecation can be handy if you have to rename a package. You can publish the package under a new name and let the users know of the new name in your deprecation message.
There is a heavier duty option in the form of npm unpublish. Using
npm unpublish you can pull a package out of the registry. Given this can be potentially dangerous and break the code for a lot of people, it has been restricted to versions that are less than 24 hours old. Most likely you don’t need the feature at all, but it’s nice to know it exists.
As packages evolve, you likely want to start developing with others. You could become the new maintainer of a project, or pass the torch to someone else. These things happen as packages evolve.
npm provides certain commands for these purposes. It’s all behind npm owner namespace. More specifically, there are
npm owner ls <package name>,
npm owner add <user> <package name> and
npm owner rm <user> <package name>. That’s about it.
When publishing npm packages, you should take care to follow SemVer carefully. Consider ComVer as it’s a simpler backwards compatible alternative. Use tooling to your advantage to avoid regressions and to keep your user base happy.
You’ll learn how to build npm packages in the next chapter.
This book is available through Leanpub. By purchasing the book you support the development of further content.