Publishing Packages to npm and Bower
Jason Garber, Former Senior Web Developer
I've posted a follow-up to this article where I correct a couple of things I wrote about relating to updating npm and Bower packages.
Developers have also shared packaged code en masse to public registries like npm and Bower. These registries and their associated command line tools give developers an easy way to add functionality to their projects. If you’re familiar with Ruby-based dependency management tools like Bundler, you can think of npm and Bower packages as being similar to Ruby gems.
In this post, I’ll run through the process by which you can publish code to the npm and Bower repositories. In publishing my own work to these repositories, I uncovered a couple of things to watch out for and I’ll note those along the way.
brew install node
Next up, Bower:
npm install -g bower
If everything installed properly, the
bower commands should be available in your shell. You can test this by running
npm -v and
git commit -am "Commit version 1.0.0 of my awesome project." git tag v1.0.0 git push git push --tags
The above commands will commit your code (if it’s not already), tag it as
v is optional), and push both the code and tag to your project’s remote Git repository. For more on Git tags and releases, give GitHub’s About Releases help page a read.
With the prerequisites out of the way, you’re all set to publish your code to npm and Bower.
Publishing to npm
To get started with the npm setup process, run
npm init from your project’s root directory. You’ll be prompted to answer a couple of questions about your project: your package’s name, version (using the aforementioned SemVer format), description, etc.
A quick caveat: For the purposes of publishing to npm and Bower, enter a lowercased package name, regardless of how you may stylize the name elsewhere (e.g.
And a quick note: When prompted to enter an “entry point,” enter the relative path to the primary file your package provides (e.g.
dist/routerrouter.js). The resulting
package.json file stores this in the
main key so I’m not sure why it’s referred to as an “entry point” during setup.
Once you’ve responded to all of the prompts, a
package.json file will be added to the root of your project complete with all of the values you provided during setup. The first step of publishing to npm is complete.
Step two requires an account on npm’s website:
To publish, you must have a user on the npm registry. If you don’t have one, create it with
npm adduser. If you created one on the site, use
npm loginto store the credentials on the client.
I signed up for an npm account via the website after which I ran
npm login and filled in the appropriate credentials. Run
npm config ls to make sure everything’s configured properly. You should see output similar to:
//registry.npmjs.org/:always-auth = false //registry.npmjs.org/:email = "email@example.com" //registry.npmjs.org/:username = "yourusername"
With your npm user set, all that’s left is to publish your package by running
npm publish. You should see some output confirming that your package was published if everything is in order. If you encounter an error, go through the output and correct any mistakes.
Publishing to Bower
Publishing packages to Bower is very similar to publishing to npm. Kick things off by running
bower init from the root of your project. You’ll be prompted to answer a series of familiar questions. If you’re unsure how to answer any of the questions, pressing
return will use the default answer. For instance, setup asks, “What types of modules does this package expose?” If you’re publishing a CSS package, this question is irrelevant; simply pressing
return will move you on to the next question.
Once you’ve answered all the prompts, the program will create a
bower.json file in the root of your project. If you take a look, you’ll see a lot of similarities between the contents of
bower.json and our previously-created
Finally, we submit our package to the Bower registry by issuing a command similar to:
bower register routerrouter git://github.com/jgarber623/RouterRouter.git
You’ll want to replace
routerrouter with your package’s name (as defined in
bower.json) and the Git URL with the URL for your package’s repository. Bower prefers Git URLs to use the
git:// protocol, so watch out for that.
Now that you’ve successfully published the first version of your package to npm and Bower, you can get down to the good work of maintaining and improving your code. Once you’re ready to release a new version, there are a couple of steps to walk through in order to publish the update.
First, commit, tag, and push your changes:
git commit -m "Fix some bugs." git tag v1.0.1 git push git push --tags
Your commit message and tag will vary depending on the nature of your changes according to the SemVer format. To notify npm that a new version of your package is available, run the following two commands, replacing
1.0.1 as appropriate:
npm version 1.0.1 npm publish
The new version of your package should now show up in npm’s registry!
Notifying Bower of the updates to your package is much easier. Remember earlier where you tagged your release with Git? This is where that properly-formatted tag comes in to play: Bower automatically detects new versions of your package based on Git tags. Super smart and makes publishing updated packages to Bower seamless.
While there’s a bit of initial overhead and configuration, publishing pieces of code to npm and Bower for reuse in projects greatly improves efficiency when starting up new projects. The sheer volume of code available on the repositories can be overwhelming, but they are relatively well-organized and reduce a ton of dependency-management friction.
If you have any questions or tips related to publishing code on npm or Bower, let me know! You can find me on npm at ~jgarber.