jakeworrell/sandwich.js

Sticks a load of JS files together for you

sandwich.js

sandwich.js helps you deal with all of your .js files. It allows you to use multiple scripts during development and then will concatenate them ready for deployment. It doesn't do any minification itself, so you can choose the minification tool that best suits you.

client-side usage

Initially you need to include the sandwich.js file in your html via script tags. Then a second script should be included that pulls all your scripts in using sandwich's js function.

<!-- in index.html -->
<script src="sandwich.js" type="text/javascript"></script>
<script src="init.js" type="text/javascript"></script>

/* in init.js */
sandwich
  .js('js/this.js')
  .js('js/that.js');

server-side usage

Server-side you need node.js to execute the concatenation code. You use the same sandwich.js (it is able to detect whether it is being run via node or not). You simply use the -f option to tell it the path to your script that calls sandwich's js function and it will do the rest. In this case we have also used '-b' which sets the base path for the script files, this is sometimes necessary when sandwich.js and html files are not in the same directory.

node pub/js/sandwich.js -b pub/ -f pub/js/init.js

The output will be printed to screen. You can then either pipe to file or to a minifier like uglify as shown below

node pub/js/sandwich.js -b pub/ -f pub/js/init.js | uglifyjs > output.js

sandwich.js's Issues

CLI fails to guess the correct path sometimes

Sometimes if your file structure is not as expected the CLI throws a wobbly. Need to allow user to supply a base path on at the command line

Merge sandwich.lib with sandwich.js

there is probably no need for these to be separate, can detect whether running through node or not

Refactor .jsFiles .cssFiles into one array

Refactor .jsFiles .cssFiles into one multi-dimensional array.