Simple build tool that combines your JS and outputs a source map, with JSON configuration.
I expect this to be most useful for simple, front-end focused projects, particularly those that are already working with a traditional list of
<script> tags in
index.html (and where you may not want to rock the boat). There are more sophisticated versions of this out there, but
adhesive has some advantages:
adhesive doesn't bother with css. I usually have compass watching my scss files and combining them already.
You need to install Node if you haven't already. Then:
npm install adhesive -g
Or you can clone this repository,
cd into into it, and run
npm link. That's a good option if you want to try modifying adhesive.
adhesive <config_path> [--debug | --dont-minify | --help]
Your config file must have a .json extension. You may omit the extension when invoking adhesive. For example, if your configuration file is named
build.json, the following are equivalent:
I recommend using nodemon with adhesive to recombine your code each time you make a change. Thanks to source maps, this allows you to have a nice workflow that is pretty much identical to using
npm install nodemon -g
nodemon adhesive build --debug
The configuration file is a JSON document. It requires that you specify an array of source files and an output path, like so:
It probably goes without saying that the sources are concatenated in the order listed, so if your site currently has a list of script tags, you'll want to maintain that same order in here.
You can set a
sourceRoot path that will be prepended to the filenames in the
###Source Map Options
The source map will automatically be saved alongside the built file. In the previous example if you called
adhesive build.json --debug, you would get two files saved to your
You can customize this by adding a
sourceMap object. It has two parameters:
root. The source map will be saved at
root specifies where the source map will look for files. This gets a little confusing, because it's relative to the source map's path at runtime. If you set the source map path to
maps/main_sourcemap.map and the
root isn't set to anything, the source map will look for files in
maps/js/, which is not what you want. When in doubt, don't set
root. It will automatically be pointed to the current folder, which is usually the right choice.
Here's an example configuration with everything in it:
Copyright (c) 2013, John Starr DewarAll rights reserved.Redistribution and use in source and binary forms, with or withoutmodification, are permitted provided that the following conditions are met:1. Redistributions of source code must retain the above copyright notice, thislist of conditions and the following disclaimer.2. Redistributions in binary form must reproduce the above copyright notice,this list of conditions and the following disclaimer in the documentationand/or other materials provided with the distribution.THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" ANDANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AREDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FORANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED ANDON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THISSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.The views and conclusions contained in the software and documentation are thoseof the authors and should not be interpreted as representing official policies,either expressed or implied, of the FreeBSD Project.