How can I 'require' CommonJS modules in the browser?
Javascriptnode.jsCommonjsJavascript Problem Overview
What is the best way to load CommonJS modules as client-side JavaScript code in the browser?
CommonJS modules put their functionality in the module.exports namespace and are usually included using require(pathToModule) in a server-side script. Loading them on the client cannot work the same way (require needs to be replaced, asynchronousness needs to be taken into account, etc.).
I have found module loaders and other solutions: Browserify, RequireJS, yabble, etc. or ways to simply alter the modules. What do you consider the best way and why?
Javascript Solutions
Solution 1 - Javascript
I have used RequireJS extensively in the past (implementation on BBC iPlayer in 2010) and it works well. It can handle CommonJS modules, but it needs an additional wrapper, which I find annoying.
If you want to use those modules in Node.js as well, you need to use RequireJS on the server side as well, which I don't like doing since it is not idiomatic Node.js JavaScript code.
I have used webmake and Browserify in the past year on a few projects. Initially, the compilation step put me off, but having used it extensively this year, I can say that this is not an issue.
Browserify has a watch function included, which works very well. Webmake can be hooked up to a watcher (such as watchr) or, you can use the webmake-middleware module, which can be used as part of an Express.js or connect application. This has the advantage that rather than compiling the JavaScript on each save, it is only compiled when you actually request it.
Connect makes it trivial to create a server (also static), so you could create a tiny static Node.js server to serve up your files if you want to develop your frontend without a backend.
Bonus: There isn't any need for a build script as you always deal with the built code.
Solution 2 - Javascript
Here is a comprehensive list of your current options ordered by their respective popularity (number of watchers) on GitHub:
> Options for use of require() in the browser (Wayback Machine archive)
Solution 3 - Javascript
Use Browserify.
Its description is: "Browser-side require() for your node modules and npm packages" which sounds what you need.
Solution 4 - Javascript
The CommonJS compiler.
Why? It works fine with Node.js (CommonJS) modules /treat module exactly as Node.js and, with UMD, brings minimum extra code to the compiled JavaScript, allows exporting global variables of third-party libraries without touching their code, source maps and a trick that other cannot do:
var str = require( "lorem-ipsum.txt" );
console.log( str );
Output:
Lorem ipsum dolor
sit amet, consectetur
adipiscing elit. Morbi...
Here are the slides: https://speakerdeck.com/dsheiko/modular-javascript-with-commonjs-compiler
Solution 5 - Javascript
Webmake is one of the options. I use it to pack an application that is build from over 200 modules of over 20 packages. It works.
If you want to see some example, check: SoundCloud Playlist Manager. It's strictly client-side and built with Webmake.
Solution 6 - Javascript
I can't say I've tried the others you've listed here, but I like RequireJS because:
- It works in a similar way to CommonJS
- It's easy to use
- It implements some of the upcoming new standards
- You can use it in Node.js so that you can use the same files in server and client
- It includes a minifier/packer for deploying to production
- It has plugins. The Text plugin, that lets you load HTML files, is very useful for large applications.