crcn/sardines

combine node / browser apps into a single script.

Sardines is no longer maintained. Use Webpack, or browserify instead.

What is it?

Combine all node.js scripts into one file. Run it as a single executable, or online.

Features

• Combine all scripts into one (shrinkwrap method)
• Asynchronously load all scripts (browserify method)
• express middleware

JS Example

var sardines = require("sardines"),
fs = require("fs");

sardines.shrinkwrap({
	entry: __filename
}, function(err, content) {
	fs.writeFile(__dirname + "/shrinkwrapped.js", content);
});

Express example

var server = require("express").createServer();
server.use(require("sardines").middleware({
	directory: __dirname + "/public"
}));
server.listen(8080);

In your browser, load a script and append one of the following query arguments: shrinkwrap, browserify, or wrap.

Like so:

http://localhost:8080/js/app.js?browserify # asynchronously loads ALL scripts vs loading into one
http://localhost:8080/js/app.js?shrinkwrap # loads all scripts into one
http://localhost:8080/js/app.js?wrap # wraps the script in a function so it doesn't pollute the global namespace

Terminal Usage

Usage: sardines [include] -e [entry] -o [output] -p [port] -d -s

Options:
  -s, --server     run the http server             
  -d, --directory  public directory for http server  [default: cwd]
  -p, --port                                         [default: 8080]
  -m  --method                                       [default: "shrinkwrap"]

Terminal Examples

sardines -e app.js -o app.shrinkwrap.js -m shrinkwrap # shrinkwrap the app
sardines -s # start the server

sardines's Issues

global vars in modules need to be renamed

while perfectly legal in node.js, it breaks online.

look for platform "main" scripts

for example, in package.json:

"webMain" : "./lib/web/index.js"

then provide a flag, such as: sardines -i script -o script -p web

make combines JS safe for google closure

wrap all reserved keywords in ['']. E.g:

static -> ['static']

ability to watch scripts & compile automatically

require.define("package")

console.log UTF-8 characters

I'm running Linux (Ubuntu 15.04) and nexe version 0.4.1.
When compiling and running this piece of code the utf8 characters are not printed to the terminal.

console.log('Some utf8 chars █ ◾ ▌');

Output:

Some utf8 char   

script.part.js

doesn't include all the dependencies for sardines - removes redundancy (see bean.js)

utf8 characters are converted during writing

It seems if your code contains unicodes , sardines will convert them due to writing them as a UTF-8 stream . for example:

'a': '\u2592', will be replaced by 'a': '▒'

This causes a problem with nexe as the node compilation process will complain about non-ansi characters in the *.js files and won't build.

windows doesn't work

ability to define custom arguments for searching file to require

ability to specify rules within package.json

such as which files to include, any particular special files, grammar rules, etc.

ability to specify custom files to include

does not keep track of variable scope

issue in this case:

var middleware = require('./middleware');

function()
{
var middleware = 'test';
console.log(middleware);// replaced with another variable
}