Hassle-free third-party dependencies

Posted

How do you manage your third-party assets? With my simple setup, all I have to do is run one command and reload the page.

Lets take a look at managing our third-party dependencies with Bower and preprocessing them with Gulp & main-bower-files. This post is intended for existing Bower users as well as anyone who hasn’t even heard of it.


Bower

Bower is an unopinionated package manager for the web. John Lindquist (from egghead.io) was nice enough to record a quick overview;

That’s it! As is often said:

> Bower is just a package manager.

Installation

Bower depends on Node.js and npm (which comes bundled with Node.js).

To install Bower globally, run:

Make sure that git is installed as some Bower packages require it to be fetched and installed. Side note: another great thing about Bower is that you can install anything from GitHub (or even Gist), even if it doesn’t support Bower (i.e. does not have a bower.json); anything with a public git URL can be installed.

A naive project

Let’s dig into an example. Here’s how a basic project using Bower might be structured:

Let’s assume we already have these files and have ran bower init to generate a bower.json.

Adding Bootstrap

So, if we were to run bower install bootstrap --save, Bootstrap would be installed under bower_components/bootstrap. The --save argument saves Bootstrap to our bower.json (see the dependencies property).

The project would now look like this:

Notice that jquery is installed here as well because it is a dependency of bootstrap itself (as set in its own bower.json).

Note: if you’re used to npm, notice here that Bower uses a flat dependency tree.

bower.json

app/index.html

Example 

 

Here we link to the files we need. How do we know which are needed? Well, a package’s bower.json (typically) has a main property which lists them.

Note: if you’re used to npm, notice here that a package can have a main file which isn’t JavaScript and can have more than one main file.


Problems

  • We need to figure out which files we need to link to (including those of our dependencies’ dependencies).
  • There is an unnecessary amount of HTTP requests; one per main file.
  • The explicit ../bower_components in the asset URLs feels dirty.
  • Unnecessary tight coupling between app/index.html and our dependencies.

What if we want to add / remove a dependency? What if we update a dependency and the new version has different main files? Or the updated package’s own dependencies have changed? Answer: we’ll have to figure it all out again and update index.html. The main property supports wildcards, which only makes it more awkward.
* We have no opportunity to preprocess the dependencies.
* Too easy to forget to to use --save when installing a dependency. What happens then is that your bower.json (which is typically checked into version control) won’t be updated but your bower_components directory (typically ignored from version control) will be. Lets say you then updated your HTML to point to the new dependency in bower_components, but the next time a teammate updates the codebase, bower.json will be out of sync with the app code. So when they run bower install then the new dependency won’t be installed and likely cause errors in your app.

The explicit ../bower_components

This one is easy. Bower supports additional configuration via an optional .bowerrc JSON file. We’ll add that, with the following content to tell Bower where to install our dependencies:

The other problems

Now, how will Bower solve the rest of our problems? Well, actually, it won’t.

> Bower is just a package manager.


Gulp

That’s where Gulp comes in; a Node.js-based streaming build system. It’s simple, intuitive and really fast. I won’t go into too much detail on how Gulp works here as it’s not needed, but if you’re interested, see Building With Gulp.

Set up

If you’re unfamiliar with npm, know that it is Node.js’ package manager which Bower took some inspiration from;

Description Bower Node.js
The JSON manifest file bower.json package.json
Where dependencies go bower_components node_modules
An example command bower init npm init

To get set up, we need to run the following:

This will generate a package.json for us, install Gulp globally and locally, along with a couple of handy Gulp plugins and main-bower-files, a “Gulp-friendly” Node.js module

Note: --save-dev is just like --save except the dependency is saved under the devDependencies property, instead of the dependencies. This is supported by both npm & Bower.


Preprocessing the dependencies

We need a new gulpfile.js file at the root which will generate two single files, third-party.js and third-party.css;

 

You’re probably ahead of me, but what’s happening here is:

  1. main-bower-files reads our bower.json.
  2. Gets the list of dependencies.
  3. Reads our .bowerrc to see where our Bower dependencies are installed to (app/third-party/).
  4. Reads each dependencies’ own bower.json and their own dependencies’ bower.json.
  5. Gets the list of main files.
  6. Filters this set of files down to just the JavaScript files.
  7. Concatenates all of these into a third-party.js file.
  8. Stores it in the app/ directory.
  9. Restores the list of files to the original list (i.e. undoing the filtering).
  10. Filters the files down to just the CSS main files.
  11. Concatenates them into a third-party.css file.
  12. Stores it in the app/ directory.

So now our app/index.html would look like this:

Example <!– Example to prove Bootstrap exists –> <div class="alert alert-info alert-dismissible"><button class="close" type="button" data-dismiss="alert">×<span class="sr-only">Close</span></button> <strong>Heads up!</strong> If this alert is blue, Bootstrap's CSS was loaded. If you can dismiss this alert, then jQuery & Bootstrap's JavaScript has been loaded.</div> <script src="third-party.js"></script> <script src="main.js"></script>

And our final project structure looks like this:


Benefits

If you’re not thinking this is an ideal setup yet, keep reading. We’ve solved all of our problems from earlier:

  • The hassle of figuring out what to include in our page is gone (thanks to main-bower-files).
  • Only two files are requested now. If you wanted, you could concatenate your own JavaScript and CSS with these files so you’d wouldn’t need any additional HTTP requests for your dependencies.
  • No more ../bower_components in the asset URLs.
  • Our workflow is streamlined because app/index.html and our dependencies are no longer tightly coupled.

We could quickly change our dependencies and simply reload without having to touch our HTML. For example:
* bower install d3
* bower install moment\#2.7.0
* bower uninstall d3
* bower update moment
* We have no opportunity tocan preprocess the dependencies.

If we wanted, we could do whatever we’d like to any main file or any of the resultant third-party JavaScript or CSS files. All we’d have to do is add a new .pipe(...) to our gulpfile.js. If you’d like an idea of some of the things you could do, see the list of Gulp plugins.
* You’ll never forget to --save. Since main-bower-files reads your bower.json when compiling third-party.css and third-party.js, you have to --save to be able to use the dependency in your app.

Plus:

  • Dependency order is maintained.

The order in which our dependencies are listed in your bower.json is the order in which their main files are concatenated together.


Caveats

Overrides

What if you wanted to explicitly set the main file(s) for a dependency? See the main-bower-files readme on overriding the main property.

Why might you need to do this?

  • If you’d prefer a certain package’s main file pointed to a different file. E.g. knockout.debug.js instead of knockout.js.
  • When a package you installed has no main file or a bower.json at all (as I said was possible earlier). This is an unlikely case and main-bower-files will warn you when it happens. Typically the project maintainer would be open to adding the bower.json or main property once notified of the problem.

Scope

With this setup, all our dependencies will be created as globals. I’ve deliberately avoided talking about AMD, CommonJS and shimming to keep this as simple as possible.

Source maps

Since our dependencies are combined into one file, it’s harder to debug. It would be even worse if we had minified them. Source maps were created for this reason. If we generated source maps, then our browser could parse the source map automatically and make it appear as though you’re running unminified and uncombined files, without impacting performance. See the gulp-concat readme on how to generate source maps.


Conclusion

Now thanks to Bower, Gulp and main-bower-files, we have a hassle-free dependency setup. All we have to do is to run gulp and reload the page after installing a new dependency. Have a look at the example project on GitHub for you to play around with.

It could be simplified even more, for example:

  • Add a Gulp task to watch the bower.json for changes, then recompile the third-party files and reload the page.
  • Combine our own style.css and main.js with third-party.css and third-party.js so we’d only have to load one CSS and one JavaScript file.
  • Add source maps.

But I’ll leave that up to you 🙂

Head of a secret new product at Teamwork.com. Author of ‘Developing an Electron Edge’ http://bit.ly/electron-edge. Creator of Ked http://adamlynch.com/ked/. Find me on Twitter as @lynchy010