When you use a npm package in your project, you need to keep in mind that you’re using other persons’ piece of code, and you expect that it would not break your code, nor steal your information. So, if you want to publish a package on npm, you need to follow the same.
npm has some policies to prevent “bad packages”.
Also, you expect that the code does what it says it does - not less, not more; either if you’re using a simple routing package or a complete framework. And, how to guarantee it? With tests, obviously!
So, within the 3 paragraphs above we encountereed a lot of “rules” we need to follow if we want to publish a package on npm. I mean “rules” and not rules because they’re conventions - you can publish an empty package without tests too, but, how does it will help people?
While working for Bcredi, I noticed that we were using the same piece of code in 3 or 4 different projects. The same piece of code with the same piece of tests - it was clearly an example of “how not to DRY”.
If the validation changed, we must change it on all projects, redo the tests… A great headache at all.
To solve it, and as an opportunity to study about publishing packages - before that, I haven’t published any packages - I decided to create packages for those repeated pieces. This way, we centralize the code and the tests - if we need to change anything, we do it in only one place and update the versions.
The 2 packages are:
But, before accomplishing the publication, I had to learn some stuff.
How to publish a package?
If you create a new project by running
npm init -y, create a new
index.js file and then run
npm publish, you can say that you’ve published a package. Even if the package does nothing, it’ll be a published package.
But, the goal here is to help people, and an empty package like this won’t help anybody.
So, as a beginner on the subject, I started to research about publishing packages. And I found 2 glorious resources that helped me through this process:
- “How to publish packages to npm (the way the industry does things)”, by Zell Liew
Going straight to the core, after viewing these two nice resources I’ve learned some nice tips on how to publish a package on npm. And, basically, all of those tips can be compiled into 4 topics:
- Create the project
- Set up some tests
- Create a CI track
- Semantic Versioning
1. Create the project
It’s quite obvious, but we need to create a new project. You create a repository on your favorite VSC platform (GitHub, Bitbucket, GitLab…), and commit every change on it.
It’d be nice if you use a pattern for your commits, so this way the release process will be much easier. There are a lot of nice tools to help you standartize your commits, like commitizen or conventional-changelog.
A great point here is to tell npm to ignore some files, using a
.npmignore file. It’s useful to avoid some files to be published within your package, like test cases, examples and documentations. When you run
npm install <some_package> on your terminal, all the files that are in the npm registry will be downloaded on your machine - and we don’t want to waste band and memory on unused files.
You can always take a look on the npm developer guide!
2. Set up some tests
After the work is done, you must ensure your code will be able to be used, and also that it’s working perfectly. You can use a lot of stuff to create your tests. I use jest a lot because it’s easy and simple to use.
Also, you can set up a coverage status - it’ll tell how much of your code is covered by the tests, and will ensure that your code is reliable. There are a lot of coverage tools as well, and I like to use codecov on my projects. codecov will read the coverage reports from your test framework and will generate reports about that coverage, showing where the code was tested and were it wasn’t.
3. Create a CI track
As a developer, I hate to do repeatable jobs. And I’m sure you hate it too.
Leave all the repeatable work for the machines.
Creating a CI track will help you to test and publish your package. There are a lot of good CI tools, like Travis, CircleCI and the newest GitHub Actions. Basically, the
CI (or Continuous Integration) is a machine that will execute some of your project’s scripts to test and deploy the code. If anything goes wrong, it’ll tell you where are the errors and stop the process - it won’t deploy buggy code.
4. Semantic Versioning
Semantic versioning, or semver is a convention defined for establishing new versions of your code. Those versions will based on the changes you’ve made. The changes can be divided on three categories, by definition:
- Major: a change that will break the code (
- Minor: a change that add a new feature, with backwards compatibility (
- Patch: a change that fixes some bugs, with backwards compatibility (
You can learn more about semver here.
np you can choose the version by yourself; with
semantic-release, the version will be chosen by the changes you’ve made (with the help of
By doing those 4 steps, we guarantee the code quality and we’re secured to be publishing a nice package.