Should npm Really Be Used as a Built Tool?

Datetime:2016-08-23 02:45:51          Topic: Gulp  Grunt           Share

I’d like to talk about one of the web’s new “best practises” and my personal experiences with it. The intention behind this article isn’t to get as much developers as possible away from using npm as a build tool, but rather to contribute to a large, global thought process about whether or not it should be considered a “best practise”.

I’m saying this because I definitely think that I’ve got a pretty good view on this whole topic. However, there still might be some areas in which solutions for problems exist, but I simply haven’t found out about them yet.

So please don’t use this as an excuse for staying with Gulp, Grunt or Broccoli, but rather just add it to the information you’ve gathered from other places around the web and then make a decision!

Why npm?

Let’s start with the intention behind using npm as a build tool and why many of us came to the conclusion that it might be a better choice than using existing packages:

First of all, I think we both agree on the fact that good developers are always on the path of trying to find the simplest, easiest and fastest way to get a certain task done. And this exactly where things like Gulp and Grunt started to become a thorn in our sides:

While our builds became more and more complex (transpiling next-level JavaScript, compiling different syntax languages like SCSS or Coffeescript into their main language, preparing/transpiling tests and moving static files), our configuration files also started becoming much bigger and complex as well.

And then, suddenly, many of us found themselves writing multiple hundreds of lines of code just for the process of preparing all files for being delivered to the user/customer (here’s a really extreme example , which also isn’t just related to build tools, but rather to task managers at all).

So it didn’t take much time until some developers started looking for a simpler and cleaner way to handle all of this. And since our projects already had a “package.json” file inside them (which is necessary for defining a build tool’s dependencies), npm-scripts were one of the first things that seemed like a proper alternative.

The Remorse

Sadly, the joy didn’t last long. After people like me started converting their excitement of knowing how to simplify a certain task into a practical solution, it already started to get shitty again:

At first, I just had a single property in package.scripts and it was called “build”. And what it did was transpile my ES2015 code using Babel into ES5 code. “So far so good!”, I thought.

But then, as soon as I started digging into the other stuff I had to take care of (like compiling SCSS, starting a livereload server, bundling my ES2015 modules or implementing a file watcher), it started getting messy:

That’s how it looked before I switched back to Gulp. And remember, the upper example doesn’t even include tests. If you want to see how that looks, here’s another one .

  • A lot of things are being defined multiple times (like paths and subcommands), which makes maintenance very hard.
  • You’re required to ensure that the destination directory and all sub directories exist before running an actual build task (I’ve did that using “prebuild”). If you don’t do that, many compilers/transpilers will throw an error telling you that the destination path doesn’t exist.
  • I haven’t found a way to use a single watching process and pass the changed files over to the respective build task instead of using a CLI tool like parallelshell to run multiple of those watchers in parallel.
  • These watchers also won’t care if only a single SCSS file (for example) has been changed. Instead of that, they will simply trigger a rebuild of all stylesheets because nobody tells them which ones have changed!
  • Tools like Gulp and Broccoli already include a well thought-out caching mechanism which reduces the build time to a few milliseconds (using in-memory file caches like gulp-cached even allows you to reach a overall build time of just nanoseconds). When using things like node-sass or babel directly, you’ll get a much slower speed.

Not very compelling, right? That’s what I thought. So I’ve decided to switch back and go with ember-cli for my latest web application (at the core, it basically uses Broccoli to compile the code).

But the same applies to Gulp and Grunt: Everything is cached, I don’t need to define things like paths multiple times and all of the basic logic is done by the tool itself (like ensuring that all destination paths exist).

Possible fixes

Technically, just running watchers concurrently and rebuilding if necessary isn’t enough for a real web application. At the same time, we also have to make sure that we’re serving the static files and the API/server code. And all of this stuff should preferably happen in a single process (to avoid monitoring multiple terminal windows, for example).

To address the above problems, awesome people like Justin Searls started creating ways to outsource all of that shell scripting within “package.json” into separated, clean and carefully structured files.

A great example for this intention is scripty — a tool which allows you to put all of your task configurations into executables located in a single folder called “scripts” in your module’s root directory.

“Isn’t that great, we’ve just found a way to solve all of our problems!”, you might think now. But I’d like to ask you the following: Are you sure that we’ve really made progress on this topic by choosing npm instead of Gulp or Grunt as a built tool?

Because if you ask me, we clearly haven’t. Instead of that, we’re basically trying to reinvent a already fine working solution by fixing problems which we didn’t even have before.

What’s the next logical step after moving your tasks into separate files? Exactly: You’re going to find a way to share code between multiple tasks, implement some logic and finally create a package called “Gulp” which enforces a clean task configuration structure.

A compromise

You know what? I’m fine with looking at npm as a task manager . But what I definitely can’t recommend is using it as a build tool .

Those things might sound similar, but they’re still fundamentally different: While a task manager controls all of the tasks necessary to develop a web application, a build tool only covers the part of preparing your code for being delivered to the end user.

So all in all, my personal suggestion is to stay away from too much shell scripting related to package.scripts and rather start “build”-ing your code using Gulp or Broccoli . But at the same time, feel free to control those build tools through the “script” property within “package.json”.

While doing so, make sure to take a look at the gulpfile.js or brocfile.js of other awesome projects to understand what they’re doing to keep them as simple as possible and apply it to your own code!





About List